KeyPressEvent
ClassThis event is triggered when the user presses a key.
- Available on all platforms
Index
Properties
Methods
Example
function onKeyPress(eventData)
{
var key = eventData.key;
}
var event = script.createEvent("KeyPressEvent");
event.bind(onKeyPress);
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
key
readonlykey:Keys
Returns the key code of the pressed key.
modifiers
readonlymodifiers:KeyModifiers[]
Returns the modifier keys active when the key was pressed as a set of enums.
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
getTypeName()
staticgetTypeName():TypeName<KeyPressEvent>
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<KeyPressEvent>
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