SetAnalogControlState: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 26: Line 26:
===Returns===
===Returns===
Returns true, else false if invalid argument.
Returns true, else false if invalid argument.
==Example==
<section name="Client" class="client" show="true">
/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">
function analog()
if (getAnalogControlState("forwards") == 0) then
setAnalogControlState ("forwards",1)
else
setAnalogControlState ("forwards",0)
end
end
addCommandHandler("analog",analog)
</syntaxhighlight>
This example written by '''Samurai'''
</section>


==See Also==
==See Also==
{{Client input functions}}
{{Client input functions}}

Revision as of 16:36, 20 February 2013

Accessories-text-editor.png Script Example Missing Function SetAnalogControlState needs a script example, help out by writing one.

Before submitting check out Editing Guidelines Script Examples.

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
  • state: a float between 0 and 1 indicating the amount the control is pressed.

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