SetAnalogControlState: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Created page with "__NOTOC__ {{Client function}} This sets the analog control state of a control. ==Syntax== <syntaxhighlight lang="lua"> bool setAnalogControlState ( string controlName , int state ) </syntaxhighlight> ===...")
 
(13 intermediate revisions by 7 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client function}}
{{Client function}}
This sets the analog control state of a control.
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==
==Syntax==
<syntaxhighlight lang="lua"> bool setAnalogControlState ( string controlName , int state ) </syntaxhighlight>
<syntaxhighlight lang="lua">bool setAnalogControlState ( string control [, float state ] ) </syntaxhighlight>
===Required Arguement===
===Required Arguments===
* '''controlName''': the control name. 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'''
===Optional Arguments===
**'''forwards'''
*'''state:''' A [[float]] between 0 and 1 indicating the amount the control is pressed. If no value is provided, the analog control is removed.
**'''backwards'''
**'''vehicle_left'''
**'''vehicle_right'''
**'''steer_forward'''
**'''steer_back'''
**'''accelerate'''
**'''brake_reverse'''
**'''special_control_left'''
**'''special_control_right'''
**'''special_control_up'''
**'''special_control_down'''
* '''state''': a value between 0 and 1 indicating the amount the control is pressed.


===Returns===
===Returns===
Returns true, else false if invalid argument.
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