GetAnalogControlState

From Multi Theft Auto: Wiki
Jump to navigation Jump to search

This retrieves the analog control state of a control. This is useful for detecting sensitive controls, such as those used on a joypad.

Syntax

float getAnalogControlState ( string controlName )

Required Arguments

  • controlName : the name of the control you wish to get the analog state of. Possible values are:
    • 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

Returns

Returns a float between 0 and 1 indicating the amount the control is pressed.

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