GetAnalogControlState: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 2: Line 2:
{{Client function}}
{{Client function}}
This retrieves the analog control state of a control.  This is useful for detecting sensitive controls, such as those used on a joypad.
This retrieves the analog control state of a control.  This is useful for detecting sensitive controls, such as those used on a joypad.
To get the analog control state for a [[ped]], please use [[getPedAnalogControlState]].


==Syntax==
==Syntax==

Revision as of 21:14, 8 July 2018

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

To get the analog control state for a ped, please use getPedAnalogControlState.

Syntax

float getAnalogControlState ( string control )

Required Arguments

  • control: The control that you want to set the state of. See control names for a list of possible controls.

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