SimApi Timer

Class SimApi_Timer

Include api.timer.h
Description Provides access to the simulation timer.
Remark - This class provides a set of capablities to retrieve, set and control the simulation time.
Related Links -

Recommended: Simulation Time Overview

Public Class Members

Name	Description
seekToTime	Overloaded. Additional information is available.
time	Gets the simulation time in seconds (number of seconds since mission start)
deltaTime	Gets the delta time in seconds from the last frame
timeInMilliSec	Gets the simulation time in milliseconds (number of milliseconds since mission start)
timeOfDay	Gets the simulation time of day in seconds (number of seconds since midnight)
timeOfDayMs	Get time of day in milliseconds (number of milliseconds since midnight)
startMissionTimeOfDay	Gets the mission start time of day.
setTimeOfDay	Sets current simulation time of day in seconds
setTimerMode	Sets the timer mode. Possible values: TIMER_SIMULATION=0 or TIMER_SLAVE=1
getTimerMode	Gets the current timer mode
setTime	Sets a new simulation time in seconds from mission start
setStartSystemTime	Sets the start time of the session using standard SYSTEMTIME structure of Win32 API
getStartSystemTime	Gets the start time of the session in standard SYSTEMTIME structure of Win32 API
setEndSystemTime	Sets the end time of the session using standard SYSTEMTIME structure of Win32 API
getEndSystemTime	Gets the end time of the session in standard SYSTEMTIME structure of Win32 API
seekToTimeByPosition	Seeks to time by percentage of the total session time
getCurrentSystemTime	Gets the current session time in standard SYSTEMTIME structure of Win32 API
getSystemTime	Gets a session time on specified percentage of the total session time
getCurrentPosition	Gets the current session position in percentage of total session duration
getPosition	Gets the percentage value from the total session duration for a specified time value.
setStepSizeInSeconds	Sets the step size in seconds for the simulation timer
getStepSizeInSeconds	Gets the current step size in seconds
stepForward	Performs one timer's step forward. I.e. sets the current time to current time plus step size
stepBackward	Performs one timer's step forward. I.e. sets the current time to current time minus step size
adminPauseTime	Gets the admin pause time in seconds.
attachTODToClock	Sets the "attach time of the day to clock" flag. If attached - 3D engine will update its time of day on time change
isTODAttachedToClock	Gets the current "attach time of the day to clock" flag state.