TouchStartEvent
ClassTriggered when a touch event starts.
- Available on all platforms
Index
Example
// Prints the touch position when a screen touch has started
var event = script.createEvent("TouchStartEvent");
event.bind(function(eventData)
{
var touchedPos = eventData.getTouchPosition();
print("touch started at " + touchedPos.x + " " + touchedPos.y);
});
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
Methods
bind()
bind(
evCallback):void
Binds a callback function to this event.
Parameters
| Parameter | Type |
|---|---|
evCallback | (arg1) => void |
Returns
void
Inherited from
getSceneObject()
getSceneObject():
SceneObject
Returns the SceneObject this Event is associated with.
Returns
Inherited from
SceneObjectEvent.getSceneObject
getTouchId()
getTouchId():
number
Returns the ID of this specific touch. Useful for distinguishing between touches when multiple are occurring simultaneously.
Returns
number
getTouchPosition()
getTouchPosition():
vec2
Returns the normalized 2D screen position of the user’s touch. The normalized coordinates range from ([0-1], [0-1]), (0,0) being top-left and (1,1) being bottom-right.
Returns
getTypeName()
staticgetTypeName():TypeName<TouchStartEvent>
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<TouchStartEvent>
Overrides
getTypeName()
getTypeName():
string
Returns the typename of the SceneEvent.
Returns
string
Inherited from
isOfType()
isOfType(
type):boolean
Returns true if the object matches or derives from the passed in type.
Parameters
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
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
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean