SetAnalogControlState: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
(5 intermediate revisions by 3 users not shown)
Line 3: Line 3:
This sets the analog control state of a control for the local player.
This sets the analog control state of a control for the local player.


To change the analog controls for a ped, please use [[setPedAnalogControlState]].
To change the analog controls for a [[ped]], please use [[setPedAnalogControlState]].


==Syntax==
==Syntax==
<syntaxhighlight lang="lua"> bool setAnalogControlState ( string controlName [, float state] ) </syntaxhighlight>
<syntaxhighlight lang="lua">bool setAnalogControlState ( string control [, float state ] ) </syntaxhighlight>
===Required Arguement===
===Required Arguments===
* '''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===
===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===
Returns true, else false if invalid argument.
Returns ''true'' if the control state was successfully set, ''false'' otherwise.


==Example==
==Example==
<section name="Client" class="client" show="true">
This creates an ''/forwards'' command, which toggles your ''forwards'' control state between 0 and 1.
/analog command starts to go forward control state if you are not, if you are going forward by control state then you will stop.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function analog()
addCommandHandler( "forwards",
if (getAnalogControlState("forwards") == 0) then
    function( )
setAnalogControlState ("forwards",1)
        if ( getAnalogControlState( "forwards" ) == 0 ) then
else
            setAnalogControlState( "forwards", 1 )
setAnalogControlState ("forwards",0)
        else
end
            setAnalogControlState( "forwards", 0 )
end
        end
addCommandHandler("analog",analog)
    end
)
</syntaxhighlight>
</syntaxhighlight>
This example written by '''Samurai'''
</section>


==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