GetAnalogControlState: Difference between revisions
Jump to navigation
Jump to search
(New page: __NOTOC__ {{Client function}} This retrieves the analog control state of a control. This is useful for detecting sensitive controls, such as those used on a joypad. ==Syntax== <syntaxhighlight lang="lua">[lua...) |
|||
(8 intermediate revisions by 4 users not shown) | |||
Line 2: | Line 2: | ||
{{Client function}} | {{Client function}} | ||
This retrieves the analog control state of a control. This is useful for detecting sensitive controls, such as those used on a joypad. | This retrieves the analog control state of a control. This is useful for detecting sensitive controls, such as those used on a joypad. | ||
To get the analog control state for a [[ped]], please use [[getPedAnalogControlState]]. | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua">float getAnalogControlState ( string control )</syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
*''' | *'''control:''' The control that you want to get the state of. See [[control names]] for a list of possible controls. | ||
===Returns=== | ===Returns=== | ||
Returns a float between 0 and 1 indicating the amount the control is pressed. | 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. | |||
<syntaxhighlight lang="lua"> | |||
addCommandHandler( "forwards", | |||
function( ) | |||
if ( getAnalogControlState( "forwards" ) == 0 ) then | |||
setAnalogControlState( "forwards", 1 ) | |||
else | |||
setAnalogControlState( "forwards", 0 ) | |||
end | |||
end | |||
) | |||
</syntaxhighlight> | |||
==See Also== | ==See Also== | ||
{{Client input functions}} | {{Client input functions}} |
Revision as of 21:14, 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.
To get the analog control state for a ped, please use getPedAnalogControlState.
Syntax
float getAnalogControlState ( string control )
Required Arguments
- control: The control that you want to get the state of. See control names for a list of possible controls.
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
Shared
- addCommandHandler
- bindKey
- executeCommandHandler
- getCommandHandlers
- getFunctionsBoundToKey
- getKeyBoundToFunction
- isControlEnabled
- removeCommandHandler
- toggleAllControls
- toggleControl
- unbindKey