AIRControl - Adobe AIR Game Controller Native Extension - API Documentation | All Packages | All Classes | Index | Frames No Frames |
AIRControlControllerEvent

Package | com.alexomara.ane.AIRControl.events
Class | public class AIRControlControllerEvent
Inheritance | AIRControlControllerEvent flash.events.Event

The event class for all events dispatched by the AIRControlController class and decendents of the AIRControlControllerElement class.

Public Properties

| Property | Defined By
--- | --- | ---
|  | controller : AIRControlController [read-only] The controller with the element that dispatched the event. | AIRControlControllerEvent
|  | element : AIRControlControllerElement [read-only] The element that dispatched the event. | AIRControlControllerEvent
|  | elementIndex : uint [read-only] The index of the element that dispatched the event. | AIRControlControllerEvent

Public Methods

| Method | Defined By
--- | --- | ---
|  | AIRControlControllerEvent(type:String, controller:AIRControlController, element:AIRControlControllerElement, elementIndex:uint) Creates a new AIRControlControllerEvent object. | AIRControlControllerEvent
|  | clone():Event [override] Creates a new AIRControlControllerEvent object with all the original properties. | AIRControlControllerEvent

Public Constants

| Constant | Defined By
--- | --- | ---
|  | AXIS_CHANGE : String = AIRControlControllerEvent.axisChange [static] Dispatched on axis state change. | AIRControlControllerEvent
|  | BUTTON_CHANGE : String = AIRControlControllerEvent.buttonChange [static] Dispatched on button state change. | AIRControlControllerEvent
|  | POV_CHANGE : String = AIRControlControllerEvent.povChange [static] Dispatched on POV hat switch state change. | AIRControlControllerEvent

Property Detail

controller | property

`controller:AIRControlController` [read-only]

The controller with the element that dispatched the event.

Implementation
`public function get controller():AIRControlController`

element | property |

`element:AIRControlControllerElement` [read-only]

The element that dispatched the event.

Implementation
`public function get element():AIRControlControllerElement`

elementIndex | property |

`elementIndex:uint` [read-only]

The index of the element that dispatched the event.

Implementation
`public function get elementIndex():uint`
Constructor Detail

AIRControlControllerEvent | () | Constructor

`public function AIRControlControllerEvent(type:String, controller:AIRControlController, element:AIRControlControllerElement, elementIndex:uint)`

Creates a new AIRControlControllerEvent object.

Parameters

| `type:String` — The type of event being dispatched.
| `controller:AIRControlController` — The controller with the element that dispatched the event.
| `element:AIRControlControllerElement` — The element that dispatched the event.
| `elementIndex:uint` — The index of the element that dispatched the event.

Method Detail

clone | () | method

`override public function clone():Event`

Creates a new AIRControlControllerEvent object with all the original properties.

Returns

| `Event` — An exact duplicate of the current event.

Constant Detail

AXIS_CHANGE | Constant

`public static const AXIS_CHANGE:String = AIRControlControllerEvent.axisChange`

Dispatched on axis state change.

BUTTON_CHANGE | Constant |

`public static const BUTTON_CHANGE:String = AIRControlControllerEvent.buttonChange`

Dispatched on button state change.

POV_CHANGE | Constant |

`public static const POV_CHANGE:String = AIRControlControllerEvent.povChange`

Dispatched on POV hat switch state change.

Mon Jul 22 2013, 09:56 PM -04:00