Difference between revisions of "Timing"

Latest revision as of 10:57, 22 February 2014

Timing is a family of functions using which you can schedule other functions to be called asynchronously at a interval. Only SetTimer exists in UT2004. Like in JavaScript, despite asynchronous nature of SetTimer, UnrealScript is still single-threaded. It means that you don't have to worry about thread-safety. Race conditions are still possible though.

Functions[edit]

SetTimer[edit]

// UT2004 and earlier:
native final function SetTimer(
    float inRate, 
    bool inbLoop,
);
 
// UT3 and later:
native final function SetTimer(
    float inRate, 
    optional bool inbLoop, 
    optional Name inTimerFunc='Timer', 
    optional Object inObj
);

Sets a timer to call the given function at a set interval. Defaults to calling the 'Timer' event if no function is specified. If inRate is set to 0.f it will effectively disable the previous timer.

• inRate - time interval, in gameplay seconds. If inRate <= 0.0, it'll reset the timer.
• inbLoop - if true, timer will be executed repeatedly every inRate seconds. If false, which is default, the timer will be executed only once.
• inTimerFunc - function name.
• inObj - object whose function will called. Defaults to self. Note that timer is still stored in the timer array of self object. E.g. destroying self object will remove all the timers, including the ones that are set to call function on some other object.

Note that it's very significant that timers use gameplay seconds (WorldInfo.TimeSeconds). They are stopped when the game is paused (unless bAlwaysTick is set), and are affected by time dilation (see below). If you need to set up a timer that uses real time, and does not depend on gameplay speed or game being paused, you have to emulate timer using bAlwaysTick=true, event Tick and WorldInfo.RealTimeSeconds variable.

ClearTimer[edit]

// available only in UT3 and later
native final function ClearTimer(
    optional Name inTimerFunc='Timer', 
    optional Object inObj 
);

Clears a previously set timer.

• inTimerFunc - function name.
• inObj - object whose timers will be cleared (i.e. whose function would be called at timeout - as in SetTimer()).

It's equivalent to calling SetTimer(0.0f, false, inTimerFunc, inObj).

ClearAllTimers[edit]

// available in UT3 and later
native final function ClearAllTimers(
    optional Object inObj
);

Clears all timers for the given object.

• inObj - object whose timers will be cleared.

PauseTimer[edit]

// available in UDK and later
native final function PauseTimer(
    bool bPause, 
    optional Name inTimerFunc='Timer', 
    optional Object inObj
);

• param
• inTimerFunc - function name.
• inObj - object whose timer will be paused.

IsTimerActive[edit]

// available in UT3 and later
native final function bool IsTimerActive(
    optional Name inTimerFunc='Timer', 
    optional Object inObj
);

Checks is specified timer is active.

• inTimerFunc - function name.
• inObj - object whose function will be called.

GetTimerCount[edit]

// available in UT3 and later
native final function float GetTimerCount(
    optional Name inTimerFunc='Timer',
    optional Object inObj
);

Gets the current count for the specified timer, defaults to 'Timer' if no function is specified. Returns -1.f if the timer is not currently active. See GetTimerRate below for explanation.

• inTimerFunc - function name.
• inObj - object whose function will be called.

GetTimerRate[edit]

// available in UT3 and later
native final function float GetTimerRate(
    optional name TimerFuncName = 'Timer', 
    optional Object inObj
);

Gets the current rate for the specified timer. GetTimerRate('SomeTimer') - GetTimerCount('SomeTimer') is the time remaining before 'SomeTimer' is called. In other words, "count" starts at 0, increases, and when it reaches "rate", timer is fired.

• inTimerFunc - function name.
• inObj - object whose function will be called.

ModifyTimerTimeDilation[edit]

// available in UDK and later
native final function ModifyTimerTimeDilation(
   const name TimerName, 
   const float InTimerTimeDilation,
   optional Object inObj
);

This will search the Timers on this actor and set the passed in TimerTimeDilation

• inTimerFunc - function name.
• InTimerTimeDilation - new time dilation for this timer function.
• inObj - object whose function will be called.

ResetTimerTimeDilation[edit]

// available in UDK and later
native final function ResetTimerTimeDilation(
    const name TimerName,
    optional Object inObj
);

This will search the Timers on this actor and reset the TimerTimeDilation to 1.0f

• inTimerFunc - function name.
• inObj - object for accessing function name.

Variables[edit]

• WorldInfo.TimeSeconds - time since level began play, affected by pause and time dilation
• WorldInfo.RealTimeSeconds - time since level began play, is not affected by pause and time dilation
• WorldInfo.AudioTimeSeconds - time since level began play, affected by pause only

Note that in online play, these variables are not synchronized over network. That is, TimeSeconds on the client signifies time since it has joined the game.

Moreover, seamsless travel (introduced in UT3), carries over TimeSeconds from previous level.

Time Dilation[edit]

WorldInfo object includes a TimeDilation property. The correct way to access it from UnrealScript is to use SetGameSpeed function defined in GameInfo. This property can also be manipulated with slomo cheat command.

The more dilation is, the faster game is. For instance, if TimeDilation was 2.0, the game would be twice as fast. It means that each real world second would correspond to two in-game ones. A timer with rate 1.0 would be called each gameplay second. But a timer with rate WorldInfo.TimeDilation would be called once per real second.

In PC version of UT3 there's additional multiplier equal to 1.1. That is, WorldInfo.SetGameSpeed(x) will set time dilation to x * 1.1.

See also[edit]

• SetTimer in UT3
• SetTimer in UDK