GetPedAnalogControlState: Difference between revisions

Latest revision as of 17:12, 7 November 2024

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

This exmaple creating a ped can drive with command /drive

local ped = createPed(0, 0,0,3)
local vehicle = createVehicle(554,0,0,3)
warpPedIntoVehicle(ped, vehicle)

addCommandHandler("drive",function()
    isDriving = getPedAnalogControlState ( ped, "accelerate" ) -- get the analaog state of (accelerate)
    if isDriving==1 then -- checks if equals 1 that means is driving
        outputChatBox("Ped is driving stoping..")
        setPedAnalogControlState( ped, "accelerate", 0 ) -- set the analaog (accelerate) to 0 
    else 
        outputChatBox("Starting drive")
        setPedAnalogControlState( ped, "accelerate", 1 ) -- set the analaog (accelerate) to 1 
    end 
end)

@@ Line 1: / Line 1: @@
 __NOTOC__
 {{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==
-<syntaxhighlight lang="lua">float getPedAnalogControlState ( ped thePed, string controlName )</syntaxhighlight>
+<syntaxhighlight lang="lua">float getPedAnalogControlState ( ped thePed, string controlName [, bool rawValue ] )</syntaxhighlight>
 ===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===
+{{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).
+}}
 ===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.
 ==Example==
+This exmaple creating a ped can drive with command '''/drive'''
 <syntaxhighlight lang="lua">
--- todo
+local ped = createPed(0, 0,0,3)
+local vehicle = createVehicle(554,0,0,3)
+warpPedIntoVehicle(ped, vehicle)
+addCommandHandler("drive",function()
+    isDriving = getPedAnalogControlState ( ped, "accelerate" ) -- get the analaog state of (accelerate)
+    if isDriving==1 then -- checks if equals 1 that means is driving
+        outputChatBox("Ped is driving stoping..")
+        setPedAnalogControlState( ped, "accelerate", 0 ) -- set the analaog (accelerate) to 0
+    else
+        outputChatBox("Starting drive")
+        setPedAnalogControlState( ped, "accelerate", 1 ) -- set the analaog (accelerate) to 1
+    end
+end)
 </syntaxhighlight>
-==Requirements==
-{{Requirements|n/a|1.3.0-9.04185|}}
 ==See Also==