Skip to main content

LateUpdateEvent

Class

Event that runs during each frame, only if a Component and its SceneObject is enabled.

  • Available on all platforms
Platform details: Snapchat, SPECS, Camera Kit Web, Camera Kit Mobile fully supported.

Platform details

  • Snapchat — Fully supported.

  • SPECS — Fully supported.

  • Camera Kit Web — Fully supported.

  • Camera Kit Mobile — Fully supported.

Event that runs during each frame, only if a Component and its SceneObject is enabled. LateUpdate runs later in the frame, after all UpdateEvents have run, and after systems like animation, physics, and tracking but before the start of rendering. A Component will not get a LateUpdateEvent that frame if it constructed after UpdateEvents have started to be processed. Relative ordering between LateUpdateEvents is not guaranteed.

Index

Example

// Move this SceneObject every frame to match the position of a target SceneObject
//@input SceneObject target

var transform = script.getTransform();
var targetTransform = script.target.getTransform();

var event = script.createEvent("LateUpdateEvent");
event.bind(function (eventData)
{
var targetPos = targetTransform.getWorldPosition();
transform.setWorldPosition(targetPos);
});

Extends

Properties

enabled

enabled: boolean

If true, the event is able to trigger. If false, the event will not trigger.

Default Value

true

Inherited from

SceneEvent.enabled

Methods

bind()

bind(evCallback): void

Binds a callback function to this event.

Parameters

ParameterType
evCallback(arg1) => void

Returns

void

Inherited from

SceneEvent.bind


getDeltaTime()

getDeltaTime(): number

Returns the time elapsed (in seconds) between the current frame and previous frame.

Returns

number


getTypeName()

static getTypeName(): TypeName<LateUpdateEvent>

Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().

Returns

TypeName<LateUpdateEvent>

Overrides

SceneEvent.getTypeName


getTypeName()

getTypeName(): string

Returns the typename of the SceneEvent.

Returns

string

Inherited from

SceneEvent.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object matches or derives from the passed in type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

SceneEvent.isOfType


isSame()

isSame(other): boolean

Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

Parameters

ParameterType
otherScriptObject

Returns

boolean

Inherited from

SceneEvent.isSame