API:Class/SkateboardController

Filtered-inheritance mode: While this class technically inherits all Instance class members, some (if not all) have been hidden because they serve no purpose for this object.

UserInputService.pngSkateboardController : Object Icon.pngController : Object Icon.pngInstance

A SkateboardController is an object responsible for translating PlayerActions to movements with a SkateboardPlatform.

Properties

Properties [toggle]

floatSteer [readonly]

The direction of movement, tied to the keys A and D. Must be 1 (right), 0 (straight), or -1 (left). Will refresh back to 0 unless constantly set.

|RMD member="API:Class/SkateboardController/Steer"|The direction of movement, tied to the keys A and D. Must be 1 (right), 0 (straight), or -1 (left). Will refresh back to 0 unless constantly set.|/RMD|
floatThrottle [readonly]

The direction of movement, tied to the keys W and S. Must be an integer 1 (forward), 0 (null), or -1 (reverse). Will refresh back to 0 unless constantly set.

|RMD member="API:Class/SkateboardController/Throttle"|The direction of movement, tied to the keys W and S. Must be an integer 1 (forward), 0 (null), or -1 (reverse). Will refresh back to 0 unless constantly set.|/RMD|
Steer [readonly]
The direction of movement, tied to the keys A and D. Must be 1 (right), 0 (straight), or -1 (left). Will refresh back to 0 unless constantly set.
Throttle [readonly]
The direction of movement, tied to the keys W and S. Must be an integer 1 (forward), 0 (null), or -1 (reverse). Will refresh back to 0 unless constantly set.

Functions

FunctionsmemberhiddenFunctions [toggle]

Inherited from Object Icon.pngController:
voidBindButton ( Button button, string caption )

Activates an overriding bind on the specified button.

|RMD member="API:Class/Controller/BindButton"|Activates an overriding bind on the specified button.|/RMD|
boolGetButton ( Button button )

Returns whether or not Button is being pressed.

|RMD member="API:Class/Controller/GetButton"|Returns whether or not Button is being pressed.|/RMD|
voidUnbindButton ( Button button )

Removes the bind on button.

|RMD member="API:Class/Controller/UnbindButton"|Removes the bind on button.|/RMD|
voidbindButton ( Button button, string caption ) [deprecated]

Deprecated in favor of BindButton.

|RMD member="API:Class/Controller/bindButton"|Deprecated in favor of BindButton.|/RMD|
boolgetButton ( Button button ) [deprecated]

Deprecated in favor of GetButton.

|RMD member="API:Class/Controller/getButton"|Deprecated in favor of GetButton.|/RMD|
BindButton ( Button button, string caption )
Activates an overriding bind on the specified button.
GetButton ( Button button )
Returns whether or not Button is being pressed.
UnbindButton ( Button button )
Removes the bind on button.
bindButton ( Button button, string caption ) [deprecated]
Deprecated in favor of BindButton.
getButton ( Button button ) [deprecated]
Deprecated in favor of GetButton.


Events

Events [toggle]

AxisChanged ( string axis )

Fired when any input state of the skateboard controller is updated.

|RMD member="API:Class/SkateboardController/AxisChanged"|Fired when any input state of the skateboard controller is updated.|/RMD|
Fired when any input state of the skateboard controller is updated.
Inherited from Object Icon.pngController:
ButtonChanged ( Button button )

Fired when the pressed state of a bound button is changed. This event can be used in conjunction with GetButton to see whether a bound button is being pressed down or not.

|RMD member="API:Class/Controller/ButtonChanged"|Fired when the pressed state of a bound button is changed. This event can be used in conjunction with GetButton to see whether a bound button is being pressed down or not.|/RMD|
Fired when the pressed state of a bound button is changed. This event can be used in conjunction with GetButton to see whether a bound button is being pressed down or not.

|RMD member="API:Class/SkateboardController"|A SkateboardController is an object responsible for translating PlayerActions to movements with a SkateboardPlatform. |/RMD|