| Package | flash.events |
| Class | public final class GameInputEvent |
| Inheritance | GameInputEvent  Event Object |
| Language version: | ActionScript 3.0 |
| Runtime version: | AIR 3.7 |
GameInputEvent class represents an event that is
dispatched when a game input device has either been added or removed
from the application platform. A game input device also dispatches events
when it is turned on or off.
See also
| Property | Defined by | ||
|---|---|---|---|
 | bubbles : Boolean
Indicates whether an event is a bubbling event.
| Event | |
| cancelable : Boolean
Indicates whether the behavior associated with the event can be prevented.
| Event | |
| constructor : Object
A reference to the class object or constructor function for a given object instance.
| Object | |
| currentTarget : Object
The object that is actively processing the Event object with an event listener.
| Event | |
| device : GameInputDevice
[read-only]
Returns a reference to the device that was added or removed.
| GameInputEvent | ||
| eventPhase : uint
The current phase in the event flow.
| Event | |
| prototype : Object
[static]
A reference to the prototype object of a class or function object.
| Object | |
| target : Object
The event target.
| Event | |
| type : String
The type of event.
| Event | |
| Method | Defined by | ||
|---|---|---|---|
|
GameInputEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, device:GameInputDevice = null)
| GameInputEvent | ||
|
Duplicates an instance of an Event subclass.
| Event | |
|
A utility function for implementing the
toString() method in custom
ActionScript 3.0 Event classes. | Event | |
|
Indicates whether an object has a specified property defined.
| Object | |
|
Checks whether the
preventDefault() method has been called on the event. | Event | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter.
| Object | |
|
Cancels an event's default behavior if that behavior can be canceled.
| Event | |
|
Indicates whether the specified property exists and is enumerable.
| Object | |
|
Sets the availability of a dynamic property for loop operations.
| Object | |
|
Prevents processing of any event listeners in the current node and any subsequent nodes in
the event flow.
| Event | |
|
Prevents processing of any event listeners in nodes subsequent to the current node in the
event flow.
| Event | |
|
Returns the string representation of this object, formatted according to locale-specific conventions.
| Object | |
|
Returns a string containing all the properties of the Event object.
| Event | |
|
Returns the primitive value of the specified object.
| Object | |
| Constant | Defined by | ||
|---|---|---|---|
| ACTIVATE : String = "activate" [static]
The
ACTIVATE constant defines the value of the type property of an activate event object. | Event | |
| ADDED : String = "added" [static]
The
Event.ADDED constant defines the value of the type property of
an added event object. | Event | |
| ADDED_TO_STAGE : String = "addedToStage" [static]
The
Event.ADDED_TO_STAGE constant defines the value of the type
property of an addedToStage event object. | Event | |
| BROWSER_ZOOM_CHANGE : String = "browserZoomChange" [static]
The
Event.BROWSER_ZOOM_CHANGE constant defines the value of the type
property of an browserZoomChange event object. | Event | |
| CANCEL : String = "cancel" [static]
The
Event.CANCEL constant defines the value of the type property of a cancel event object. | Event | |
| CHANGE : String = "change" [static]
The
Event.CHANGE constant defines the value of the type property of a change event object. | Event | |
| CHANNEL_MESSAGE : String = "channelMessage" [static]
The
Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object. | Event | |
| CHANNEL_STATE : String = "channelState" [static]
The
Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object. | Event | |
| CLEAR : String = "clear" [static]
The
Event.CLEAR constant defines the value of the type property
of a clear event object. | Event | |
| CLOSE : String = "close" [static]
The
Event.CLOSE constant defines the value of the type property of a close event object. | Event | |
| CLOSING : String = "closing" [static]
The
Event.CLOSING constant defines the value of the
type property of a closing event object. | Event | |
| COMPLETE : String = "complete" [static]
The
Event.COMPLETE constant defines the value of the type property of a complete event object. | Event | |
| CONNECT : String = "connect" [static]
The
Event.CONNECT constant defines the value of the type property of a connect event object. | Event | |
| CONTEXT3D_CREATE : String = "context3DCreate" [static]
The
Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object. | Event | |
| COPY : String = "copy" [static]
Defines the value of the
type property of a copy event object. | Event | |
| CUT : String = "cut" [static]
Defines the value of the
type property of a cut event object. | Event | |
| DEACTIVATE : String = "deactivate" [static]
The
Event.DEACTIVATE constant defines the value of the type property of a deactivate event object. | Event | |
| DEVICE_ADDED : String = "deviceAdded" [static]
Indicates that a compatible device has been connected or turned on.
| GameInputEvent | ||
| DEVICE_REMOVED : String = "deviceRemoved" [static]
Indicates that one of the enumerated devices has been disconnected or
turned off.
| GameInputEvent | ||
| DEVICE_UNUSABLE : String = "deviceUnusable" [static]
Dispatched when a game input device is connected but is not usable.
| GameInputEvent | ||
| DISPLAYING : String = "displaying" [static]
The
Event.DISPLAYING constant defines the value of the type property of a displaying event object. | Event | |
| ENTER_FRAME : String = "enterFrame" [static]
The
Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object. | Event | |
| EXIT_FRAME : String = "exitFrame" [static]
The
Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object. | Event | |
| EXITING : String = "exiting" [static]
The
Event.EXITING constant defines the value of the type property of an exiting event object. | Event | |
| FRAME_CONSTRUCTED : String = "frameConstructed" [static]
The
Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object. | Event | |
| FRAME_LABEL : String = "frameLabel" [static]
The
Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object. | Event | |
| FULLSCREEN : String = "fullScreen" [static]
The
Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object. | Event | |
| HTML_BOUNDS_CHANGE : String = "htmlBoundsChange" [static]
The
Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object. | Event | |
| HTML_DOM_INITIALIZE : String = "htmlDOMInitialize" [static]
The
Event.HTML_DOM_INITIALIZE constant defines the value of the type property
of an htmlDOMInitialize event object. | Event | |
| HTML_RENDER : String = "htmlRender" [static]
The
Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object. | Event | |
| ID3 : String = "id3" [static]
The
Event.ID3 constant defines the value of the type property of an id3 event object. | Event | |
| INIT : String = "init" [static]
The
Event.INIT constant defines the value of the type property of an init event object. | Event | |
| LOCATION_CHANGE : String = "locationChange" [static]
The
Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object. | Event | |
| MOUSE_LEAVE : String = "mouseLeave" [static]
The
Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object. | Event | |
| NETWORK_CHANGE : String = "networkChange" [static]
The
Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object. | Event | |
| OPEN : String = "open" [static]
The
Event.OPEN constant defines the value of the type property of an open event object. | Event | |
| PASTE : String = "paste" [static]
The
Event.PASTE constant defines the value of the type property of a paste event object. | Event | |
| PREPARING : String = "preparing" [static]
The
Event.PREPARING constant defines the value of the type property of a preparing event object. | Event | |
| REMOVED : String = "removed" [static]
The
Event.REMOVED constant defines the value of the type property of
a removed event object. | Event | |
| REMOVED_FROM_STAGE : String = "removedFromStage" [static]
The
Event.REMOVED_FROM_STAGE constant defines the value of the type
property of a removedFromStage event object. | Event | |
| RENDER : String = "render" [static]
The
Event.RENDER constant defines the value of the type property of a render event object. | Event | |
| RESIZE : String = "resize" [static]
The
Event.RESIZE constant defines the value of the type property of a resize event object. | Event | |
| SCROLL : String = "scroll" [static]
The
Event.SCROLL constant defines the value of the type property of a scroll event object. | Event | |
| SELECT : String = "select" [static]
The
Event.SELECT constant defines the value of the type property of a select event object. | Event | |
| SELECT_ALL : String = "selectAll" [static]
The
Event.SELECT_ALL constant defines the value of the type property of a selectAll event object. | Event | |
| SOUND_COMPLETE : String = "soundComplete" [static]
The
Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object. | Event | |
| STANDARD_ERROR_CLOSE : String = "standardErrorClose" [static]
The
Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object. | Event | |
| STANDARD_INPUT_CLOSE : String = "standardInputClose" [static]
The
Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object. | Event | |
| STANDARD_OUTPUT_CLOSE : String = "standardOutputClose" [static]
The
Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object. | Event | |
| SUSPEND : String = "suspend" [static]
The
Event.SUSPEND constant defines the value of the type property of an suspend event object. | Event | |
| TAB_CHILDREN_CHANGE : String = "tabChildrenChange" [static]
The
Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object. | Event | |
| TAB_ENABLED_CHANGE : String = "tabEnabledChange" [static]
The
Event.TAB_ENABLED_CHANGE constant defines the value of the type
property of a tabEnabledChange event object. | Event | |
| TAB_INDEX_CHANGE : String = "tabIndexChange" [static]
The
Event.TAB_INDEX_CHANGE constant defines the value of the
type property of a tabIndexChange event object. | Event | |
| TEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange" [static]
The
Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object. | Event | |
| TEXTURE_READY : String = "textureReady" [static]
The
Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object. | Event | |
| UNLOAD : String = "unload" [static]
The
Event.UNLOAD constant defines the value of the type property of an unload event object. | Event | |
| USER_IDLE : String = "userIdle" [static]
The
Event.USER_IDLE constant defines the value of the type property of a userIdle event object. | Event | |
| USER_PRESENT : String = "userPresent" [static]
The
Event.USER_PRESENT constant defines the value of the type property of a userPresent event object. | Event | |
| VIDEO_FRAME : String = "videoFrame" [static]
The
Event.VIDEO_FRAME constant defines the value of the
type property of a videoFrame event object. | Event | |
| WORKER_STATE : String = "workerState" [static]
The
Event.WORKER_STATE constant defines the value of the type property of a workerState event object. | Event | |
| device | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesdevice:GameInputDevice [read-only]
| Language version: | ActionScript 3.0 |
| Runtime version: | AIR 3.7 |
Returns a reference to the device that was added or removed. When a device is added, use this property to get a reference to the new device, instead of enumerating all of the devices to find the new one.
Implementation public function get device():GameInputDevice
| GameInputEvent | () | constructor |
public function GameInputEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, device:GameInputDevice = null)
| Language version: | ActionScript 3.0 |
| Runtime version: | AIR 3.7 |
Parameters
type:String |
|
bubbles:Boolean (default = false) |
|
cancelable:Boolean (default = false) |
|
device:GameInputDevice (default = null) |
| DEVICE_ADDED | constant |
public static const DEVICE_ADDED:String = "deviceAdded"
| Language version: | ActionScript 3.0 |
| Runtime version: | AIR 3.7 |
Indicates that a compatible device has been connected or turned on.
If a device was connected before startup and is not immediately available,
a DEVICE_ADDED event will be dispatched when the device
becomes available for use.
| DEVICE_REMOVED | constant |
public static const DEVICE_REMOVED:String = "deviceRemoved"
| Language version: | ActionScript 3.0 |
| Runtime version: | AIR 3.7 |
Indicates that one of the enumerated devices has been disconnected or turned off.
| DEVICE_UNUSABLE | constant |
public static const DEVICE_UNUSABLE:String = "deviceUnusable"
| Language version: | ActionScript 3.0 |
| Runtime version: | AIR 3.8 |
Dispatched when a game input device is connected but is not usable. For example, this happens in a Windows sandboxed browser when another DirectInput based application is already using the device.
