Control.Timer.Tick

Timers and timed resources (animations, etc.) utilities for tick-based programs.

Simple timers

creaTimer :: Integer -> Timer

Creates a Timer expiring in x ticks.

Example:

main = count (creaTimer 4)
    where
          count t | isExpired t = putStrLn "Over!"
                  | otherwise   = do putStrLn "Ticking."
                                     count (tick t)

   -- λ> main
   -- Ticking.
   -- Ticking.
   -- Ticking.
   -- Ticking.
   -- Over!

type Timer = TimedRes ()

Timed Resources

data TimedRes a

A timed resource is a timer which, at any given moment, points to a specific item (like an animation).

Example:

run = creaTimedRes (Times 1) [(2, "a "), (1, "b "), (2, "c ")]
main = count run
    where
          count t | isExpired t = putStrLn "nOver!"
                  | otherwise   = do putStr (fetch t)
                                     count (tick t)
   -- λ> main
   -- a a b c c
   -- Over!

Instances

Eq a => Eq (TimedRes a)

Methods

(==) :: TimedRes a -> TimedRes a -> Bool

(/=) :: TimedRes a -> TimedRes a -> Bool

Show a => Show (TimedRes a)

Methods

showsPrec :: Int -> TimedRes a -> ShowS

show :: TimedRes a -> String

showList :: [TimedRes a] -> ShowS

creaTimedRes :: Loop -> [(Integer, a)] -> TimedRes a

Creates a time-based resource, like an animation.

data Loop

Number of times to repeat the animation.

Constructors

Times Integer

AlwaysLoop

Instances

Eq Loop

Methods

(==) :: Loop -> Loop -> Bool

(/=) :: Loop -> Loop -> Bool

Show Loop

Methods

showsPrec :: Int -> Loop -> ShowS

show :: Loop -> String

showList :: [Loop] -> ShowS

Use

tick :: TimedRes a -> TimedRes a

Ticks the timer (one step).

ticks :: Integer -> TimedRes a -> TimedRes a

Ticks the timer (multiple steps).

reset :: TimedRes a -> TimedRes a

Resets the timer to its original state.

Query

isLive :: TimedRes a -> Bool

Equal to not isExpired.

isExpired :: TimedRes a -> Bool

Checks wheter the timer is expired (an expired timer will not respond to tick).

fetch :: TimedRes a -> a

Fetches the current resource of the timer.