GetAnalogControlState: Difference between revisions
Jump to navigation
Jump to search
m (→Example) |
m (→Example) |
||
| Line 27: | Line 27: | ||
==Example== | ==Example== | ||
/ | This creates an ''/forwards'' command, which toggles your ''forwards'' control state between 0 and 1. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function | addCommandHandler( "forwards", | ||
function( ) | |||
if ( getAnalogControlState( "forwards" ) == 0 ) then | |||
setAnalogControlState( "forwards", 1 ) | |||
else | |||
setAnalogControlState( "forwards", 0 ) | |||
end | |||
end | end | ||
) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{Client input functions}} | {{Client input functions}} | ||
Revision as of 21:12, 8 July 2018
This retrieves the analog control state of a control. This is useful for detecting sensitive controls, such as those used on a joypad.
Syntax
float getAnalogControlState ( string controlName )
Required Arguments
- controlName : the name of the control you wish to get the analog state of. Possible values are:
- left
- right
- forwards
- backwards
- vehicle_left
- vehicle_right
- steer_forward
- steer_back
- accelerate
- brake_reverse
- special_control_left
- special_control_right
- special_control_up
- special_control_down
Returns
Returns a float between 0 and 1 indicating the amount the control is pressed.
Example
This creates an /forwards command, which toggles your forwards control state between 0 and 1.
addCommandHandler( "forwards",
function( )
if ( getAnalogControlState( "forwards" ) == 0 ) then
setAnalogControlState( "forwards", 1 )
else
setAnalogControlState( "forwards", 0 )
end
end
)
See Also
- getAnalogControlState
- getBoundKeys
- getCommandsBoundToKey
- getKeyBoundToCommand
- getKeyState
- isCapsLockEnabled
- setAnalogControlState
- Shared
- addCommandHandler
- bindKey
- executeCommandHandler
- getCommandHandlers
- getFunctionsBoundToKey
- getKeyBoundToFunction
- isControlEnabled
- removeCommandHandler
- toggleAllControls
- toggleControl
- unbindKey