View source

class KeyToState<T>

package feathers.utils

@:directlyUsed

Changes a target's state based on keyboard events, like a button.

Available since

1.0.0

.

See also:

Constructor

@:value({ callback : null, target : null })new(?target:InteractiveObject, ?callback:T ‑> Void, upState:T, downState:T)

Creates a new KeyToState object with the given arguments.

Available since

1.0.0

.

Variables

read onlycurrentState:T

The current state of the utility. May be different than the state of the target.

Available since

1.0.0

.

downState:T

The value for the "down" state.

Available since

1.0.0

.

enabled:Bool

May be set to false to disable the state changes temporarily until set back to true.

Available since

1.0.0

.

target:InteractiveObject

The target component that should change state based on pointer (mouse or touch) events.

Available since

1.0.0

.

upState:T

The value for the "up" state.

Available since

1.0.0

.

callback:T ‑> Void

The function to call when the state is changed.

The callback is expected to have the following signature:

String -> Void
Available since

1.0.0

.