SetPedBleeding: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
Tag: Reverted
(Remove obsolete Requirements section)
 
(7 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Client function}}
{{Client function}}
__NOTOC__
__NOTOC__
{{New feature/item|3.0159|1.5.8|20935|This function allows you to set [[player|player's]] or [[ped|ped's]] bleeding effect.}}
{{Added feature/item|1.5.9|1.5.8|20935|This function allows you to set [[player|player's]] or [[ped|ped's]] bleeding effect.}}
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">bool setPedBleeding( ped thePed, bool bleeding ) </syntaxhighlight>  
<syntaxhighlight lang="lua">bool setPedBleeding ( ped thePed, bool bleeding ) </syntaxhighlight>  
{{OOP||[[ped]]:setBleeding|bleeding|isPedBleeding}}
{{OOP||[[ped]]:setBleeding|bleeding|isPedBleeding}}


===Required Arguments===
===Required Arguments===
*'''thePed:''' the player or ped whose bleeding effect you want to set of.
*'''thePed:''' The [[player]] or [[ped]] whose bleeding effect you want to set of.
*'''bleeding:''' boolean specifying whether the player or ped is bleeding or not.
*'''bleeding:''' [[Boolean]] specifying whether the player or ped is bleeding or not.


===Returns===
===Returns===
Returns ''true'' if the bleeding state was successfully set, ''error'' is raised otherwise.
Returns ''true'' if the bleeding state was successfully set, ''false'' otherwise.


==Example==
==Example==
This example causes the player to bleed.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function makePedBleed()
addCommandHandler("bleed", function()
  if getElementHealth(localPlayer) == 20 then
    setPedBleeding(localPlayer, not isPedBleeding(localPlayer))
      setPedBleeding(localPlayer, true)
end)
  else
      setPedBleeding(localPlayer, false)
  end
end
addEventHandler("onClientRender", root, makePedBleed)
</syntaxhighlight>
</syntaxhighlight>
==Requirements==
{{Requirements|n/a|1.5.8-9.20935|}}


==See Also==
==See Also==
{{Client ped functions}}
{{Client ped functions}}

Latest revision as of 17:28, 7 November 2024

This function allows you to set player's or ped's bleeding effect.

Syntax

bool setPedBleeding ( ped thePed, bool bleeding )

OOP Syntax Help! I don't understand this!

Method: ped:setBleeding(...)
Variable: .bleeding
Counterpart: isPedBleeding


Required Arguments

  • thePed: The player or ped whose bleeding effect you want to set of.
  • bleeding: Boolean specifying whether the player or ped is bleeding or not.

Returns

Returns true if the bleeding state was successfully set, false otherwise.

Example

This example causes the player to bleed. 

addCommandHandler("bleed", function()
    setPedBleeding(localPlayer, not isPedBleeding(localPlayer))
end)

See Also



Retrieved from "https://wiki.multitheftauto.com/wiki/SetPedBleeding?oldid=81310"