OnClientPedWasted: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Added a Compatability notice.)
(Killer element type)
 
(10 intermediate revisions by 7 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client event}}
{{Client event}}
'''NOTE In 1.0 revision 854 this event is being Temporarily replaced by the upgrader to onClientPlayerWasted for compatability purposes (This event will no longer fire for players), Therefore it is advised you run the upgrader before we remove this Temporary Compatability measure.'''


This event is triggered whenever a ped dies.
This event is triggered whenever a ped dies.
Line 7: Line 6:
==Parameters==
==Parameters==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
element killer, int weapon, int bodypart
element killer, int weapon, int bodypart, float loss / bool stealth
</syntaxhighlight>  
</syntaxhighlight>  


*'''killer''': A [[player]] [[element]] representing the killer.
*'''killer''': A [[player]], [[ped]] or [[vehicle]] [[element]] representing the killer.
*'''weapon''': An integer representing the weapon ID the killer used
*'''weapon''': An [[int|integer]] representing the [[Weapons|killer weapon]] or the [[Damage Types|damage types]].
*'''bodypart''': An integer representing the bodypart the player was damaged
*'''bodypart''': An [[int|integer]] representing the bodypart the player was damaged.
{{BodyParts}}
{{BodyParts}}
*'''loss''': A [[float]] representing the percentage of health the ped lost in the final "hit". ''Note: Only for client-side created peds.''
'''OR'''
*'''stealth''': A [[boolean]] representing whether or not this was a stealth kill.


==Source==
==Source==
The [[event system#Event source|source]] of this event is the [[ped]] that died.
The [[event system#Event source|source]] of this event is the [[ped]] that died.


==Example==  
==Example==
<section name="Client" class="client" show="true">
This example outputs a message every time a player kills another player.
<syntaxhighlight lang="lua">
-- define the event handler function
function onWasted(killer, weapon, bodypart)
    if ( killer and getElementType(killer) == "player" and getElementType(source) == "player" ) then
        outputChatBox(getPlayerName(killer).." has killed ".. getPlayerName(source) ..".") -- output the kill message to the chatbox.
    end
end
 
-- add the event handler
addEventHandler("onClientPedWasted", getRootElement(), onWasted)
</syntaxhighlight>
</section>


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

Latest revision as of 21:38, 14 November 2022

This event is triggered whenever a ped dies.

Parameters

element killer, int weapon, int bodypart, float loss / bool stealth
  • 3: Torso
  • 4: Ass
  • 5: Left Arm
  • 6: Right Arm
  • 7: Left Leg
  • 8: Right Leg
  • 9: Head
  • loss: A float representing the percentage of health the ped lost in the final "hit". Note: Only for client-side created peds.

OR

  • stealth: A boolean representing whether or not this was a stealth kill.

Source

The source of this event is the ped that died.

Example

Click to collapse [-]
Client

This example outputs a message every time a player kills another player. 

-- define the event handler function
function onWasted(killer, weapon, bodypart)
    if ( killer and getElementType(killer) == "player" and getElementType(source) == "player" ) then
        outputChatBox(getPlayerName(killer).." has killed ".. getPlayerName(source) ..".") -- output the kill message to the chatbox.
    end
end

-- add the event handler
addEventHandler("onClientPedWasted", getRootElement(), onWasted)

See Also

Client ped events


Client event functions



Retrieved from "https://wiki.multitheftauto.com/wiki/OnClientPedWasted?oldid=75668"