ScriptTickObject¶
A ScriptObject that responds to tick and frame events.
- Inherit:
- ScriptObject
Description¶
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.
Methods¶
-
bool
ScriptTickObject::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.
Returns: True if object wants tick notifications
-
void
ScriptTickObject::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.
-
void
ScriptTickObject::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.
-
void
ScriptTickObject::onProcessTick()¶ Called once every 32ms if this object is set to process ticks.
-
void
ScriptTickObject::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.