SetAnalogControlState: Difference between revisions
Jump to navigation
Jump to search
(→Syntax) |
|||
| Line 6: | Line 6: | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">bool setAnalogControlState ( string control [, float state ] ) </syntaxhighlight> | <syntaxhighlight lang="lua">bool setAnalogControlState ( string control [, float state, bool forceOverrideNextFrame = false ] ) </syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''control:''' The control that you want to set the state of. See [[control names]] for a list of possible controls. | *'''control:''' The control that you want to set the state of. See [[control names]] for a list of possible controls. | ||
| Line 12: | Line 12: | ||
===Optional Arguments=== | ===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:''' A [[float]] between 0 and 1 indicating the amount the control is pressed. If no value is provided, the analog control is removed. | ||
<noinclude>{{New feature/item|3.0300|1.5.8|20756| | |||
*'''forceOverrideNextFrame: ''' A [[bool]] indicating if the player input should force fully overriden for the next frame. | |||
}}</noinclude> | |||
===Returns=== | ===Returns=== | ||
Revision as of 17:59, 13 December 2020
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, bool forceOverrideNextFrame = false ] )
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