GetPedAnalogControlState: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (fix typo)
(Remove obsolete Requirements section)
 
(8 intermediate revisions by 4 users not shown)
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 12: Line 11:


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


==Example==
==Example==
This exmaple creating a ped can drive with command '''/drive'''
<syntaxhighlight lang="lua">
<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>
</syntaxhighlight>
==Requirements==
{{Requirements|n/a|1.3.0-9.04185|}}


==See Also==
==See Also==

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)

See Also

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