SetAnalogControlState: Difference between revisions
Jump to navigation
Jump to search
Xthepr0mise (talk | contribs) No edit summary |
|||
(10 intermediate revisions by 6 users not shown) | |||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client function}} | {{Client function}} | ||
This sets the analog control state of a control for the local player. | |||
This sets the analog control state of a control. | |||
To change the analog controls for a [[ped]], please use [[setPedAnalogControlState]]. | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> bool setAnalogControlState ( string | <syntaxhighlight lang="lua">bool setAnalogControlState ( string control [, float state ] ) </syntaxhighlight> | ||
===Required | ===Required Arguments=== | ||
* ''' | *'''control:''' The control that you want to set the state of. See [[control names]] for a list of possible controls. | ||
===Optional Arguments=== | |||
*'''state:''' A [[float]] between 0 and 1 indicating the amount the control is pressed. If no value is provided, the analog control is removed. | |||
* '''state''' | |||
===Returns=== | ===Returns=== | ||
Returns true, | Returns ''true'' if the control state was successfully set, ''false'' otherwise. | ||
==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:13, 8 July 2018
This sets the analog control state of a control for the local player.
To change the analog controls for a ped, please use setPedAnalogControlState.
Syntax
bool setAnalogControlState ( string control [, float state ] )
Required Arguments
- control: The control that you want to set the state of. See control names for a list of possible controls.
Optional Arguments
- state: A float between 0 and 1 indicating the amount the control is pressed. If no value is provided, the analog control is removed.
Returns
Returns true if the control state was successfully set, false otherwise.
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
- addCommandHandler
- bindKey
- executeCommandHandler
- getCommandHandlers
- getFunctionsBoundToKey
- getKeyBoundToFunction
- isControlEnabled
- removeCommandHandler
- toggleAllControls
- toggleControl
- unbindKey