SetAnalogControlState: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 4: | Line 4: | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> bool setAnalogControlState ( string controlName , float state ) </syntaxhighlight> | <syntaxhighlight lang="lua"> bool setAnalogControlState ( string controlName [, float state] ) </syntaxhighlight> | ||
===Required Arguement=== | ===Required Arguement=== | ||
* '''controlName''': the control name you wish to set the analog state of. Here's a list: | * '''controlName''': the control name you wish to set the analog state of. Here's a list: | ||
| Line 21: | Line 21: | ||
**'''special_control_up''' | **'''special_control_up''' | ||
**'''special_control_down''' | **'''special_control_down''' | ||
* '''state''' | |||
===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=== | ||
Revision as of 23:33, 15 April 2013
This sets the analog control state of a control.
Syntax
bool setAnalogControlState ( string controlName [, float state] )
Required Arguement
- controlName: the control name you wish to set the analog state of. Here's a list:
- 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
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, else false if invalid argument.
Example
Click to collapse [-]
Client/analog command starts to go forward control state if you are not, if you are going forward by control state then you will stop.
function analog()
if (getAnalogControlState("forwards") == 0) then
setAnalogControlState ("forwards",1)
else
setAnalogControlState ("forwards",0)
end
end
addCommandHandler("analog",analog)
This example written by Samurai
See Also
- getAnalogControlState
- getBoundKeys
- getCommandsBoundToKey
- getKeyBoundToCommand
- getKeyState
- isCapsLockEnabled
- setAnalogControlState
- addCommandHandler
- bindKey
- executeCommandHandler
- getCommandHandlers
- getFunctionsBoundToKey
- getKeyBoundToFunction
- isControlEnabled
- removeCommandHandler
- toggleAllControls
- toggleControl
- unbindKey