GetPedAnalogControlState: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "__NOTOC__ {{Client function}} This function retrieves the analog control state of a control for a ped, as set by setPedAnalogControlState. ==Syntax== <syntaxhighlight lang="lua">float getPed...")
 
mNo edit summary
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client function}}
{{Client function}}
This function retrieves the analog control state of a control for a ped, as set by [[setPedAnalogControlState]].
This function retrieves the analog control state of a ped, as set by [[setPedAnalogControlState]].


==Syntax==
==Syntax==
Line 8: Line 8:
===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.
*'''control:''' The control. See [[control names]] for a list of possible controls.
*'''controlName:''' The control. See [[control names]] for a list of possible controls.


===Returns===
===Returns===

Revision as of 16:45, 5 January 2014

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

Syntax

float getPedAnalogControlState ( ped thePed, string controlName )

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.

Returns

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

Example

-- todo

Requirements

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

Note: Using this feature 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