SimApi Timer

From SIMboxWiki
Jump to navigation Jump to search

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