Class VirtualJoystick
Hierarchy
- VirtualJoystick
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Creates a new virtual joystick
Parameters
Optional leftJoystick: boolean
defines that the joystick is for left hand (false by default)
Optional customizations: Partial<VirtualJoystickCustomizations>
Defines the options we want to customize the VirtualJoystick
Returns VirtualJoystick
Properties
delta
Gets the offset value for the position (ie. the change of the position value)
limit
boolean indicating whether or not the joystick's puck's movement should be limited to the joystick's container area
pressedSearch playground for pressed
Gets a boolean indicating if the virtual joystick was pressed
reverse
Gets or sets a boolean indicating that left and right values must be inverted
reverse
Gets or sets a boolean indicating that up and down values must be inverted
Static CanvasSearch playground for Canvas
Canvas the virtual joystick will render onto, default z-index of this is 5
Accessors
always
Defines whether or not the joystick container is always visible
Returns boolean
Defines whether or not the joystick container is always visible
Parameters
value: boolean
Returns void
container
Size of the joystick's container
Returns number
Size of the joystick's container
Parameters
newSize: number
Returns void
puck
Size of the joystick's puck
Returns number
Size of the joystick's puck
Parameters
newSize: number
Returns void
Methods
clear
Clears the set position of the joystick
Returns void
release
Release internal HTML canvas
Returns void
set
Defines a callback to call when the joystick is touched
Parameters
action: (() => any)
defines the callback
Returns any
Returns void
set
Defines which axis you'd like to control for left & right
Parameters
axis: JoystickAxis
defines the axis to use
Returns void
set
Defines which axis you'd like to control for up & down
Parameters
axis: JoystickAxis
defines the axis to use
Returns void
set
Loads
urlPathto be used for the container's imageParameters
urlPath: string
defines the urlPath of an image to use
Returns void
set
Change the color of the virtual joystick
Parameters
newColor: string
a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
Returns void
set
Defines joystick sensibility (ie. the ratio between a physical move and virtual joystick position change)
Parameters
newJoystickSensibility: number
defines the new sensibility
Returns void
set
Sets the constant position of the Joystick container
Parameters
x: number
X axis coordinate
y: number
Y axis coordinate
Returns void
set
Loads
urlPathto be used for the puck's imageParameters
urlPath: string
defines the urlPath of an image to use
Returns void
Class used to define virtual joystick (used in touch mode)