diff options
Diffstat (limited to 'lib/Grav2ty/Control.hs')
-rw-r--r-- | lib/Grav2ty/Control.hs | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/lib/Grav2ty/Control.hs b/lib/Grav2ty/Control.hs index c497d9d..3139687 100644 --- a/lib/Grav2ty/Control.hs +++ b/lib/Grav2ty/Control.hs @@ -66,6 +66,11 @@ processObject old rels hook id obj = setObject (Just id) newObj hook newObj +-- | If called advances the simulation by one 'Tick' relying on the 'Grav2tyState'. +-- +-- It also calls the provided hook-Action once for every remaining 'Object'. This +-- action can be used to update the '_graphics' state @g@ or modify the behaviour +-- of @processTick@ altogether. processTick :: (Monad m, RealFloat a) => (Object a -> Grav2ty a g m ()) -> Grav2ty a g m () |