TimeSystem

Documents the TimeSystem class and its functions.

NOT DOCUMENTED We currently don't have information on how these functions work. They are being documented here for visibility.

Invoking TimeSystem

To invoke the time system, use the following Global function:

times = Game.GetTimeSystem()

Sub-functions

GetGameTime

GetGameTime

GetGameTime() : GameTime;

Info & Usage

GetGameTimeStamp

GetGameTimeStamp

GetGameTimeStamp() : Float;

Info & Usage

GetSimTime

GetSimTime

GetSimTime() : EngineTime;

Info & Usage

IsPausedState

IsPausedState

IsPausedState() : Bool;

Info & Usage

IsTimeDilationActive

IsTimeDilationActive

IsTimeDilationActive(optional reason : CName) : Bool;

Info & Usage

RealTimeSecondsToGameTime

RealTimeSecondsToGameTime

RealTimeSecondsToGameTime(seconds : Float) : GameTime;

Info & Usage

RegisterDelayedListener

RegisterDelayedListener

RegisterDelayedListener(entity : wref:Entity, eventToDelay : ref:Event, delay : GameTime, repeat : Int32, optional sendOldNoifications : Bool) : Uint32;

Info & Usage

RegisterIntervalListener

RegisterIntervalListener

RegisterIntervalListener(entity : wref:Entity, eventToDelay : ref:Event, expectedHour : GameTime, timeout : GameTime, optional repeat : Int32) : Uint32;

Info & Usage

RegisterListener

RegisterListener

RegisterListener(entity : wref:Entity, eventToDelay : ref:Event, expectedTime : GameTime, repeat : Int32, optional sendOldNoifications : Bool) : Uint32;

Info & Usage

RegisterScriptableSystemIntervalListener

RegisterScriptableSystemIntervalListener

RegisterScriptableSystemIntervalListener(systemName : CName, requestToDelay : ref:ScriptableSystemRequest, expectedHour : GameTime, timeout : GameTime, optional repeat : Int32) : Uint32;

Info & Usage

SetGameTimeByHMS

SetGameTimeByHMS

SetGameTimeByHMS(hours : Int32, minutes : Int32, seconds : Int32);

Info & Usage

SetGameTimeBySeconds

SetGameTimeBySeconds

SetGameTimeBySeconds(seconds : Int32);

Info & Usage

SetIgnoreTimeDilationOnLocalPlayerZero

SetIgnoreTimeDilationOnLocalPlayerZero

SetIgnoreTimeDilationOnLocalPlayerZero(ignore : Bool);

Info & Usage

SetPausedState

SetPausedState

SetPausedState(paused : Bool, source : CName);

Info & Usage

SetTimeDilation

SetTimeDilation

SetTimeDilation(reason : CName, dilation : Float, optional duration : Float, optional easeInCurve : CName, optional easeOutCurve : CName, optional listener : ref:TimeDilationListener);

Info & Usage

SetTimeDilationOnLocalPlayerZero

SetTimeDilationOnLocalPlayerZero

SetTimeDilationOnLocalPlayerZero(reason : CName, dilation : Float, optional duration : Float, optional easeInCurve : CName, optional easeOutCurve : CName, optional ignore : Bool);

Info & Usage

UnregisterListener

UnregisterListener

UnregisterListener(listenerID : Uint32);

Info & Usage

UnsetTimeDilation

UnsetTimeDilation

UnsetTimeDilation(reason : CName, optional easeOutCurve : CName);

Info & Usage

UnsetTimeDilationOnLocalPlayerZero

UnsetTimeDilationOnLocalPlayerZero

UnsetTimeDilationOnLocalPlayerZero(optional easeOutCurve : CName);

Info & Usage