Package | flash.ui |
Class | public dynamic class GameInputControl |
Inheritance | GameInputControl EventDispatcher Object |
Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 3.7 |
Getting Control Values:
The value
property returns the current value of a
control. This method does not return the latest value directly from the
control. Instead it returns the value that was cached the last time the
control was sampled.
There are three ways to get control values from an individual control:
-
Polling: Call
value
whenever you want to get the last known value for a control. -
Change Events: Register a change event for a controller. The
Event.CHANGE
event is dispatched whenever the value of a control changes. Upon receiving the event, callvalue
to get the value for the control that fired the event. -
Caching Sample Values: Caching is done at the device level. See
the
GameInputDevice
class documentation for details on caching and retrieving sampled control values.
Attempting to read control values from a disabled device causes
value
to throw an IOError
. However, you can
access properties describing a control ( id
, minValue
and
maxValue
) even if the device is not enabled.
This feature makes it possible to determine if a device fits the
needs of your application, without having to first enable the device.
For more information, see the Adobe Air Developer Center article: Game controllers on Adobe AIR.
For Android, this feature supports a minimum Android OS version of 4.1 and requires the minimum SWF version 20 and namespace 3.7. For iOS, this feature supports a minimum iOS version of 9.0 and requires the minimum SWF version 34 and namespace 23.0.
Related API Elements
Property | Defined By | ||
---|---|---|---|
constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | ||
device : GameInputDevice [read-only]
Returns the GameInputDevice object that contains this control. | GameInputControl | ||
id : String [read-only]
Returns the id of this control. | GameInputControl | ||
maxValue : Number [read-only]
Returns the maximum value for this control. | GameInputControl | ||
minValue : Number [read-only]
Returns the minimum value for this control. | GameInputControl | ||
value : Number [read-only]
Returns the value for this control. | GameInputControl |
Event | Summary | Defined By | ||
---|---|---|---|---|
[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher | |||
Dispatched when a control value changes. | GameInputControl | |||
[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher |
device | property |
device:GameInputDevice
[read-only] Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 3.7 |
Returns the GameInputDevice object that contains this control.
Implementation
public function get device():GameInputDevice
id | property |
maxValue | property |
minValue | property |
value | property |
change | Event |
Thu Dec 6 2018, 01:12 PM -08:00