SetPedOxygenLevel: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "__NOTOC__ {{Client function}} This function allows you to set the oxygen level of a ped. ==Syntax== <syntaxhighlight lang="lua">bool setPedOxygenLevel ( ped thePed, float oxygen )</syntaxhighlight> ==...")
 
(Added OOP syntax)
 
(7 intermediate revisions by 4 users not shown)
Line 5: Line 5:
==Syntax==
==Syntax==
<syntaxhighlight lang="lua">bool setPedOxygenLevel ( ped thePed, float oxygen )</syntaxhighlight>
<syntaxhighlight lang="lua">bool setPedOxygenLevel ( ped thePed, float oxygen )</syntaxhighlight>
{{OOP||[[ped]]:setOxygenLevel|oxygenLevel|getPedOxygenLevel}}


===Required Arguments===
===Required Arguments===
*'''thePed''': the [[ped]] whose oxygen level you want to modify.
*'''thePed''': the [[ped]] whose oxygen level you want to modify.
*'''oxygen''': the amount of oxygen you want to set on the ped. Valid values are from 0 to 1000 (Higher values do not appear in the HUD).
*'''oxygen''': the amount of oxygen you want to set on the [[ped]]. Native values are from 0 to 1000. Each of the stamina (22) and underwater stamina (225) [[Template:Stats|stat]] maximum adds a bonus of 1500. So the maximum oxygen level is 4000.


===Returns===
===Returns===
Line 14: Line 15:


==Example==
==Example==
<section name="Client" class="client" show="true">
This example fills the local player's oxygen.
This example fills the local player's oxygen.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function fillOxygen ( command )
function fillOxygen ( command )
setPedOxygenLevel ( localPlayer, 1000 )
local maxOxygen = math.floor ( 1000 + getPedStat ( localPlayer, 22 ) * 1.5 + getPedStat ( localPlayer, 225 ) * 1.5 )
setPedOxygenLevel ( localPlayer, maxOxygen )
end
end
addCommandHandler ( "filloxygen", fillOxygen )
addCommandHandler ( "filloxygen", fillOxygen )
</syntaxhighlight>
</syntaxhighlight>
</section>


==See Also==
==See Also==
{{Ped functions}}
{{Client_ped_functions}}

Latest revision as of 17:45, 26 November 2014

This function allows you to set the oxygen level of a ped.

Syntax

bool setPedOxygenLevel ( ped thePed, float oxygen )

OOP Syntax Help! I don't understand this!

Method: ped:setOxygenLevel(...)
Variable: .oxygenLevel
Counterpart: getPedOxygenLevel


Required Arguments

  • thePed: the ped whose oxygen level you want to modify.
  • oxygen: the amount of oxygen you want to set on the ped. Native values are from 0 to 1000. Each of the stamina (22) and underwater stamina (225) stat maximum adds a bonus of 1500. So the maximum oxygen level is 4000.

Returns

Returns true if the oxygen level was changed succesfully. Returns false if an invalid ped and/or oxygen level was specified.

Example

This example fills the local player's oxygen. 

function fillOxygen ( command )
	local maxOxygen = math.floor ( 1000 + getPedStat ( localPlayer, 22 ) * 1.5 + getPedStat ( localPlayer, 225 ) * 1.5 )
	setPedOxygenLevel ( localPlayer, maxOxygen )
end
addCommandHandler ( "filloxygen", fillOxygen )

See Also



Retrieved from "https://wiki.multitheftauto.com/wiki/SetPedOxygenLevel?oldid=43087"