Safe Haskell	None
Language	GHC2024

Mischief.ECS.Time

Synopsis

class ToTime t where
- toTime :: t -> Time
data Time = Time {
- delta :: TimeSpec
- elapsed :: TimeSpec
}
data VirtualTime = VirtualTime {
- virtualDelta :: TimeSpec
- virtualElapsed :: TimeSpec
}
data TimeTypePref
data TimeTag where
- TimeTag :: forall t. (Component t, ToTime t) => Proxy t -> TimeTag
time :: (HasCallStack, MonadSystem w m) => m Time
timeMaybe :: MonadSystem w m => m (Maybe Time)
qtime :: forall w (m :: Type -> Type). MonadSystem w m => Query m Time
delta :: (HasCallStack, MonadSystem w m) => m Float
qdelta :: forall w (m :: Type -> Type). MonadSystem w m => Query m Float
elapsed :: (HasCallStack, MonadSystem w m) => m Float
qelapsed :: forall w (m :: Type -> Type). MonadSystem w m => Query m Float
specToSecs :: TimeSpec -> Float
secsToSpec :: Float -> TimeSpec
data TimePlugin
updateTime :: System ()

Documentation

class ToTime t where Source #

Methods

toTime :: t -> Time Source #

Instances

Instances details

ToTime FixedTime Source #
Instance details Defined in Mischief.ECS.Fixed Methods toTime :: FixedTime -> Time Source #
ToTime VirtualTime Source #
Instance details Defined in Mischief.ECS.Time Methods toTime :: VirtualTime -> Time Source #

data Time Source #

Constructors

Time
Fields delta :: TimeSpec elapsed :: TimeSpec

data VirtualTime Source #

Constructors

VirtualTime
Fields virtualDelta :: TimeSpec virtualElapsed :: TimeSpec

Instances

Instances details

Show VirtualTime Source #

Instance details

Defined in Mischief.ECS.Time

Methods

showsPrec :: Int -> VirtualTime -> ShowS #

show :: VirtualTime -> String #

showList :: [VirtualTime] -> ShowS #

Component VirtualTime Source #

Instance details

Defined in Mischief.ECS.Time

Associated Types

type IsExclusiveRel VirtualTime
Instance details Defined in Mischief.ECS.Time type IsExclusiveRel VirtualTime = 'False

Methods

required :: Set DefaultComponentType Source #

onAdd :: [Hook VirtualTime] Source #

onSet :: [Hook VirtualTime] Source #

onRemove :: [Hook VirtualTime] Source #

onAddRel :: [HookRel VirtualTime] Source #

onSetRel :: [HookRel VirtualTime] Source #

onRemoveRel :: [HookRel VirtualTime] Source #

ToTime VirtualTime Source #

Instance details

Defined in Mischief.ECS.Time

Methods

toTime :: VirtualTime -> Time Source #

type IsExclusiveRel VirtualTime Source #

Instance details

Defined in Mischief.ECS.Time

type IsExclusiveRel VirtualTime = 'False

data TimeTypePref Source #

Instances

Instances details

PrefType TimeTypePref TimeTag Source #
Instance details Defined in Mischief.ECS.Time

data TimeTag where Source #

Constructors

TimeTag :: forall t. (Component t, ToTime t) => Proxy t -> TimeTag

Instances

Instances details

PrefType TimeTypePref TimeTag Source #
Instance details Defined in Mischief.ECS.Time

time :: (HasCallStack, MonadSystem w m) => m Time Source #

timeMaybe :: MonadSystem w m => m (Maybe Time) Source #

qtime :: forall w (m :: Type -> Type). MonadSystem w m => Query m Time Source #

delta :: (HasCallStack, MonadSystem w m) => m Float Source #

qdelta :: forall w (m :: Type -> Type). MonadSystem w m => Query m Float Source #

elapsed :: (HasCallStack, MonadSystem w m) => m Float Source #

qelapsed :: forall w (m :: Type -> Type). MonadSystem w m => Query m Float Source #

specToSecs :: TimeSpec -> Float Source #

secsToSpec :: Float -> TimeSpec Source #

data TimePlugin Source #

Plugin that keeps track of time. Enables calling delta, elapsed, and so on.

Note that these methods are context-dependent. For instance, if used in a Fixed schedule, delta will always return the time as inferred from the fixed frequency.

Instances

Instances details

Plugin TimePlugin Source #
Instance details Defined in Mischief.ECS.Time Methods deps :: [Dependency] Source # init :: System () Source #

updateTime :: System () Source #