Skip to main content

TriggerPrimaryEventArgs

Class

Arguments used with the InteractionComponent.onTriggerPrimary event.

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

Index

Example

//@input Component.InteractionComponent interactionComponent

// Subscribe to the onTriggerPrimary event
var onTriggerPrimaryEvent = script.interactionComponent.onTriggerPrimary.add(function(triggerPrimaryEventArgs){
print("Trigger Primary!");
});

// Unsubscribe from the onTriggerPrimary event
script.interactionComponent.onTriggerPrimary.remove(onTriggerPrimaryEvent);

Extends

Methods

getTypeName()

static getTypeName(): TypeName<TriggerPrimaryEventArgs>

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

Overrides

ScriptObject.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

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

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

ScriptObject.isSame