ScriptTickObject
A ScriptObject that responds to tick and frame events.
Callbacks
void
onInterpolateTick(float delta)
This is called every frame, but only if the object is set to process ticks.
void
Called once every 32ms if this object is set to process ticks.
void
onAdvanceTime(float timeDelta)
This is called every frame regardless if the object is set to process ticks, but only if the callOnAdvanceTime property is set to true.
Public Attributes
bool
Call the onAdvaceTime() callback.
Public Functions
bool
Is this object wanting to receive tick notifications.
void
setProcessTicks(bool tick)
Sets this object as either tick processing or not.
Detailed Description
A ScriptObject that responds to tick and frame events.
ScriptTickObject is a ScriptObject that adds callbacks for tick and frame events. Use setProcessTicks() to enable or disable the onInterpolateTick() and onProcessTick() callbacks. The callOnAdvanceTime property determines if the onAdvanceTime() callback is called.
Callbacks
onInterpolateTick(float delta)
This is called every frame, but only if the object is set to process ticks.
Parameters:
| delta | The time delta for this frame. |
onProcessTick()
Called once every 32ms if this object is set to process ticks.
onAdvanceTime(float timeDelta)
This is called every frame regardless if the object is set to process ticks, but only if the callOnAdvanceTime property is set to true.
Parameters:
| timeDelta | The time delta for this frame. |
Public Attributes
bool callOnAdvanceTime
Call the onAdvaceTime() callback.
Public Functions
isProcessingTicks()
Is this object wanting to receive tick notifications.
If this object is set to receive tick notifications then its onInterpolateTick() and onProcessTick() callbacks are called.
True if object wants tick notifications
setProcessTicks(bool tick)
Sets this object as either tick processing or not.
Parameters:
| tick | This object's onInterpolateTick() and onProcessTick() callbacks are called if set to true. |