Skip to main content

SceneEvent

Class

The base class for scenewide events.

  • 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.

The base class for scenewide events. SceneEvents can be created using ScriptComponent's ScriptComponent#createEvent method.

Index

Example

You can bind to events in JavaScript:

// Bind a function to the MouthOpened event
function onMouthOpen(eventData)
{
print("mouth was opened");
}
var event = script.createEvent("MouthOpenedEvent");
event.bind(onMouthOpen);
// Print text 1 second later
function delayedResponse(eventData)
{
print("Printed 1 second later.");
}
var event = script.createEvent("DelayedCallbackEvent");
event.bind(delayedResponse);
event.reset(1);

You can also bind to events in TypeScript:

// Print current elapsed Lens time every frame update.
@component
export class NewScript extends BaseScriptComponent {
onAwake() {
let event = this.createEvent('UpdateEvent');
// Bind the function printTime to the event UpdateEvent
event.bind(this.printTime.bind(this));
}

printTime(eventData: UpdateEvent) {
// Print the elapsed Lens time
print(getTime().toString());
}
}

Extends

Extended by

Properties

enabled

enabled: boolean

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

Default Value

true

Methods

bind()

bind(evCallback): void

Binds a callback function to this event.

Parameters

ParameterType
evCallback(arg1) => void

Returns

void


getTypeName()

static getTypeName(): TypeName<SceneEvent>

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<SceneEvent>

Overrides

IEventParameters.getTypeName


getTypeName()

getTypeName(): string

Returns the typename of the SceneEvent.

Returns

string

Overrides

IEventParameters.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

IEventParameters.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

IEventParameters.isSame

See also

Script Events guide.