ClassInput & Controls@public

FlxVirtualStick

Texture-free HUD analog stick derived from authoritative fixed-step pointer state.

export declare class FlxVirtualStick extends FlxSprite implements FlxVirtualStickState

Constructors

constructor(id: string, x: number, y: number, options?: FlxVirtualStickOptions)

Constructs a new instance of the FlxVirtualStick class

Parameter	Type	Description
id	string	-
x	number	-
y	number	-
options	FlxVirtualStickOptions	-

Properties

Property	Modifiers	Type	Description
baseColor	-	number	-
deadZone	readonly	number	-
knobColor	-	number	-
knobRadius	readonly	number	-
outlineColor	-	number	-
pressed	readonly	boolean	-
pressedKnobColor	-	number	-
radius	readonly	number	-
rawX	readonly	number	Clamped pre-dead-zone horizontal displacement used by the renderer.
rawY	readonly	number	Clamped pre-dead-zone vertical displacement used by the renderer.
virtualInputId	readonly	string	-
xAxis	readonly	number	Dead-zone-adjusted horizontal value in [-1, 1].
yAxis	readonly	number	Dead-zone-adjusted vertical value in [-1, 1].

Methods

bindAxes()

bindAxes(actions: FlxActions, map: FlxVirtualStickAxisMap): this

Add both available axes to an existing keyboard/gamepad action map.

Parameters:

Parameter	Type	Description
actions	FlxActions	-
map	FlxVirtualStickAxisMap	-

Returns: this

createRenderHandle()

createRenderHandle(): FlxVirtualStickRenderHandle

Returns: FlxVirtualStickRenderHandle

destroy()

destroy(): void

Returns: void

source()

source(axis: 'x' | 'y'): FlxActionVirtualStickAxisSource

Create a serializable scalar action source for one axis.

Parameters:

Parameter	Type	Description
axis	'x' | 'y'	-

Returns: FlxActionVirtualStickAxisSource

update()

update(): void

Returns: void