Difference between revisions of "GetAnalogControlState"

From Multi Theft Auto: Wiki
Jump to: navigation, search
m (Returns)
m (Required Arguments)
 
Line 9: Line 9:
  
 
===Required Arguments===
 
===Required Arguments===
*'''control:''' The control that you want to set the state of. See [[control names]] for a list of possible controls.
+
*'''control:''' The control that you want to get the state of. See [[control names]] for a list of possible controls.
  
 
===Returns===
 
===Returns===

Latest 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 get 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

FROM VERSION 1.5.6 r16256 ONWARDS