Module necro.cycles.Turn

Functions

getActiveTurnID ()
getCurrentTurnID ()
getRawTimestamp (turnID) Returns the raw time corresponding to the given turn (real-life time, ignores tempo changes)
getSimulationTargetTurnID () Returns the turn up to which the game state should be simulated
getTargetTurnID () Returns the turn at which new actions should be inserted
getTurnIDForTime (seconds)
getTurnTimestamp (turnID) Returns the scaled time corresponding to the given turnID (accounts for tempo changes)
isLatestTurnReached ()
process (target, limit) Processes up to the specified number of turns, or any number of turns (if 'limit' is nil), up to the specified target turn (or the game's current target turn if 'target' is nil).


Functions

getActiveTurnID ()
getCurrentTurnID ()
getRawTimestamp (turnID)
Returns the raw time corresponding to the given turn (real-life time, ignores tempo changes)

Parameters:

  • turnID
getSimulationTargetTurnID ()
Returns the turn up to which the game state should be simulated
getTargetTurnID ()
Returns the turn at which new actions should be inserted
getTurnIDForTime (seconds)

Parameters:

  • seconds
getTurnTimestamp (turnID)
Returns the scaled time corresponding to the given turnID (accounts for tempo changes)

Parameters:

  • turnID
isLatestTurnReached ()
process (target, limit)
Processes up to the specified number of turns, or any number of turns (if 'limit' is nil), up to the specified target turn (or the game's current target turn if 'target' is nil).

Parameters:

  • target
  • limit
generated by LDoc 1.4.6