Class TriggerPrimaryEvent

Gets called when the user triggers the primary input on their device. For example touch on touch screens.

Hierarchy (View Summary, Expand)

SceneObjectEvent
- TriggerPrimaryEvent

Index

Constructors

Properties

enabled position

Methods

bind getSceneObject getTypeName isOfType isSame

Constructors

`Protected`constructor

new TriggerPrimaryEvent(): TriggerPrimaryEvent
Returns TriggerPrimaryEvent
Overrides SceneObjectEvent.constructor

Properties

enabled

enabled: boolean

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

`Readonly`position

position: vec2

Methods

bind

bind(evCallback: (arg1: this) => void): void
Binds a callback function to this event.
Parameters
- evCallback: (arg1: this) => void
Returns void
Inherited from SceneObjectEvent.bind

getSceneObject

getSceneObject(): SceneObject
Returns the SceneObject this Event is associated with.

Returns SceneObject
Inherited from SceneObjectEvent.getSceneObject

getTypeName

getTypeName(): string
Returns the typename of the SceneEvent.

Returns string
Inherited from SceneObjectEvent.getTypeName

isOfType

isOfType(type: string): boolean
Returns true if the object matches or derives from the passed in type.
Parameters
- type: string
Returns boolean
Inherited from SceneObjectEvent.isOfType

isSame

isSame(other: ScriptObject): boolean
Returns true if this object is the same as other. Useful for checking if two references point to the same thing.
Parameters
- other: ScriptObject
Returns boolean
Inherited from SceneObjectEvent.isSame