GetPedAnalogControlState: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Function arguments updated as pull #1165 was merged)
m (fix typo)
Line 12: Line 12:


===Optional Arguments===
===Optional Arguments===
{{New feature/item|3.0157|1.5.7|20383|
{{New feature/item|3.0160|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.
*'''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.
}}
}}

Revision as of 20:13, 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

This template will be deleted.

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/GetPedAnalogControlState?oldid=64901"