flash.events

# GameInputEvent - AS3

Package | flash.events
Class | public final class GameInputEvent
Inheritance | GameInputEvent Event Object

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 3.7

The `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.

Related API Elements

flash.ui.GameInput
flash.ui.GameInputDevice
flash.ui.GameInputControl

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | bubbles : Boolean [read-only] Indicates whether an event is a bubbling event. | Event
|  | cancelable : Boolean [read-only] 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 [read-only] 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 [read-only] The current phase in the event flow. | Event
|  | target : Object [read-only] The event target. | Event
|  | type : String [read-only] The type of event. | Event

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | GameInputEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, device:GameInputDevice = null) | GameInputEvent
|  | clone():Event Duplicates an instance of an Event subclass. | Event
|  | formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes. | Event
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event. | Event
|  | isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter. | Object
|  | preventDefault():void Cancels an event's default behavior if that behavior can be canceled. | Event
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow. | Event
|  | stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. | Event
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String Returns a string containing all the properties of the Event object. | Event
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | 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

Property Detail

### device

property

`device:GameInputDevice` [read-only]

Language Version: | ActionScript 3.0

Runtime Versions: | 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`
Constructor Detail

### GameInputEvent

()
Constructor

`public function GameInputEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, device:GameInputDevice = null)`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 3.7

Parameters

| `type:String`
| `bubbles:Boolean` (default = `false`)``
| `cancelable:Boolean` (default = `false`)``
| `device:GameInputDevice` (default = `null`)``

Constant Detail

### DEVICE_ADDED

Constant

`public static const DEVICE_ADDED:String = "deviceAdded"`

Language Version: | ActionScript 3.0

Runtime Versions: | 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 Versions: | 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 Versions: | 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.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00