SetAnalogControlState: Difference between revisions

Revision as of 00:49, 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 Arguement

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
)

@@ Line 6: / Line 6: @@
 ==Syntax==
-<syntaxhighlight lang="lua"> bool setAnalogControlState ( string controlName [, float state] ) </syntaxhighlight>
+<syntaxhighlight lang="lua"> bool setAnalogControlState ( string control [, float state ] ) </syntaxhighlight>
 ===Required Arguement===
-* '''controlName''': the control name you wish to set the analog state of. Here's a list:
+*'''control:''' The control that you want to set the state of. See [[control names]] for a list of possible controls.
-**'''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.
+*'''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.
+Returns ''true'' if the control state was successfully set, ''false'' otherwise.
 ==Example==
-/analog command starts to go forward control state if you are not, if you are going forward by control state then you will stop.
+This creates an ''/forwards'' command, which toggles your ''forwards'' control state between 0 and 1.
 <syntaxhighlight lang="lua">
-addCommandHandler("analog", function()
+addCommandHandler( "forwards",
-    if (getAnalogControlState("forwards") == 0) then
+    function( )
-        setAnalogControlState("forwards", 1);
+        if ( getAnalogControlState( "forwards" ) == 0 ) then
-    else
+            setAnalogControlState( "forwards", 1 )
-        setAnalogControlState("forwards", 0);
+        else
+            setAnalogControlState( "forwards", 0 )
+        end
      end
-end);
+)
 </syntaxhighlight>
-This example written by '''Samurai'''
 ==See Also==
 {{Client input functions}}