GetPedAnalogControlState: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client function}}
{{Client function}}
{{Needs_Example}}
This function retrieves the analog control state of a [[ped]], as set by [[setPedAnalogControlState]].
This function retrieves the analog control state of a ped, as set by [[setPedAnalogControlState]].


==Syntax==
==Syntax==
Line 13: Line 12:
===Optional Arguments===
===Optional Arguments===
{{New feature/item|3.0158|1.5.7|20383|
{{New feature/item|3.0158|1.5.7|20383|
*'''rawValue:''' A bool indicating if it should return the raw player input value (will always return script value for non-player peds).
*'''rawValue:''' A [[bool]] indicating if it should return the raw player input value (will always return script value for non-player peds).
}}
}}


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


<section name="Client-side example" class="client" show="true">
==Example==
<syntaxhighlight lang="lua">
{{Example}}
x, y, z = getElementPosition(localPlayer)
rotX, rotY, rotZ = getElementRotation(localPlayer)
CJ = createPed(0, x, y, z)
CJ2 = createPed(0, x, y, z)
copcar = createVehicle(597, x, y+5, z+2)
copcar2 = createVehicle(597, x+2, y+10, z+4)
warpPedIntoVehicle(CJ2, copcar2, 0)
warpPedIntoVehicle(CJ, copcar, 0)
 
function onGetCJAnalogControlState()
setPedAnalogControlState(CJ, "accelerate", 0.90)
if getPedAnalogControlState(CJ, "accelerate", 0.90) then
setPedAnalogControlState(CJ2, "brake_reverse", 0.90)
end
end
addEventHandler("onClientRender", getRootElement(), onGetCJAnalogControlState)
</syntaxhighlight>
</section>
<br /><br />
 
* This example was created by '''Hydra'''.


==Requirements==
==Requirements==

Revision as of 08:08, 30 August 2021

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 if it should return the raw player input value (will always return script value for non-player peds).

Returns

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

Example

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. 
-- 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

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