Difference between revisions of "GetPedAnalogControlState"

From Multi Theft Auto: Wiki
(Function arguments updated as pull #1165 was merged)
Line 5: Line 5:
  
 
==Syntax==
 
==Syntax==
<syntaxhighlight lang="lua">float getPedAnalogControlState ( ped thePed, string controlName )</syntaxhighlight>
+
<syntaxhighlight lang="lua">float getPedAnalogControlState ( ped thePed, string controlName [, bool rawValue ] )</syntaxhighlight>
  
 
===Required Arguments===
 
===Required Arguments===
 
*'''thePed:''' The ped you wish to retrieve the control state of.
 
*'''thePed:''' The ped you wish to retrieve the control state of.
 
*'''controlName:''' The control. See [[control names]] for a list of possible controls.
 
*'''controlName:''' The control. See [[control names]] for a list of possible controls.
 +
 +
===Optional Arguments===
 +
{{New feature/item|3.0157|1.5.7|20383|
 +
*'''rawValue:''' A bool indicating whether to poll for raw controller state, which ignores keyboard input and any overrides from [[setPedAnalogControlState]] and others. When set to true, and a controller is not used, the function will always return 0.
 +
}}
  
 
===Returns===
 
===Returns===

Revision as of 12:45, 16 January 2020

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

Before submitting check out Editing Guidelines Script Examples.

This function retrieves the analog control state of a ped, as set by setPedAnalogControlState.

Syntax

float getPedAnalogControlState ( ped thePed, string controlName [, bool rawValue ] )

Required Arguments

  • thePed: The ped you wish to retrieve the control state of.
  • controlName: The control. See control names for a list of possible controls.

Optional Arguments

  • rawValue: A bool indicating whether to poll for raw controller state, which ignores keyboard input and any overrides from setPedAnalogControlState and others. When set to true, and a controller is not used, the function will always return 0.

Returns

Returns a float between 0 ( full release ) and 1 ( full push ) indicating the amount the control is pushed.

Example

-- todo

Requirements

Minimum supported server n/a
Minimum supported client 1.3.0-9.04185

Note: Using this function requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version client="1.3.0-9.04185" />

See Also