OnPlayerStealthKill: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Improve example.)
 
(10 intermediate revisions by 6 users not shown)
Line 8: Line 8:
</syntaxhighlight>  
</syntaxhighlight>  


*'''targetPlayer''': The [[player]] or [[ped]] that is being stealth killed.
*'''targetPlayer''': the [[player]] or [[ped]] that is being stealth killed.


<!-- Add the event's source in the section below -->
==Source==
==Source==
The [[event system#Event source|source]] of this event is the [[player]] that initiated the stealth kill.
The [[event system#Event source|source]] of this event is the [[player]] that initiated the stealth kill.
Line 21: Line 20:


<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
[lua]
function onStealthKill(targetPlayer)
function onStealthKill(targetPlayer)
     outputChatBox("Stealth kill!", source) -- Tell the player he/she has done a stealth kill.
     outputChatBox("Stealth kill!", source) -- Tell the player he/she has done a stealth kill.
     outputChatBox("" .. getPlayerName(targetPlayer) .. " has been stealth-killed by " .. getPlayerName(source) .. ".", source)
     outputChatBox(getPlayerName(targetPlayer).." has been stealth-killed by "..getPlayerName(source)..".")
end
end
addEventHandler("onPlayerStealthKill", getRootElement(), onStealthKill) -- Adds a handler for the stealth kill event.
addEventHandler("onPlayerStealthKill", root, onStealthKill) -- Adds a handler for the stealth kill event.
</syntaxhighlight>
</syntaxhighlight>
</section>
</section>
Line 33: Line 31:


<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
[lua]
function onStealthKill(targetPlayer)
function onStealthKill(targetPlayer)
     cancelEvent(true, "No more stealth kills.") -- Aborts the stealth-kill.
     cancelEvent(true, "No more stealth kills.") -- Aborts the stealth-kill.
end
end
addEventHandler("onPlayerStealthKill", getRootElement(), onStealthKill) -- Adds a handler for the stealth kill event.
addEventHandler("onPlayerStealthKill", root, onStealthKill) -- Adds a handler for the stealth kill event.
</syntaxhighlight>
</syntaxhighlight>
</section>
</section>


<section name="Server" class="server" show="true">
This example will prevent the stealthkill animation of the attacker as it occurs, something which is tricky to achieve (hence this example is extra useful).
Note: you won't get this to work properly without timer and 'fake' animation. Lots of scripters have broken their backs over this.
<syntaxhighlight lang="lua">
local function preventStealthAnimation(thePlayer)
    setPedAnimation(thePlayer, "ped", "0", -1, true, true, true, true, 350)
end
function onPlayerStealthKill(targetPlayer)
    setTimer(preventStealthAnimation, 50, 1, source)
end
addEventHandler("onPlayerStealthKill", root, onPlayerStealthKill)
</syntaxhighlight>
</section>


{{See also/Server event|Player events}}
{{See also/Server event|Player events}}

Latest revision as of 08:14, 16 September 2021

This event is triggered when a player stealth kills another player.

Parameters

element targetPlayer
  • targetPlayer: the player or ped that is being stealth killed.

Source

The source of this event is the player that initiated the stealth kill.

Cancel effect

If this event is canceled, then the stealth kill is aborted.

Example

Click to collapse [-]
Server
function onStealthKill(targetPlayer)
     outputChatBox("Stealth kill!", source) -- Tell the player he/she has done a stealth kill.
     outputChatBox(getPlayerName(targetPlayer).." has been stealth-killed by "..getPlayerName(source)..".")
end
addEventHandler("onPlayerStealthKill", root, onStealthKill) -- Adds a handler for the stealth kill event.
Click to collapse [-]
Server
function onStealthKill(targetPlayer)
     cancelEvent(true, "No more stealth kills.") -- Aborts the stealth-kill.
end
addEventHandler("onPlayerStealthKill", root, onStealthKill) -- Adds a handler for the stealth kill event.
Click to collapse [-]
Server

This example will prevent the stealthkill animation of the attacker as it occurs, something which is tricky to achieve (hence this example is extra useful). Note: you won't get this to work properly without timer and 'fake' animation. Lots of scripters have broken their backs over this. 

local function preventStealthAnimation(thePlayer)
    setPedAnimation(thePlayer, "ped", "0", -1, true, true, true, true, 350)
end

function onPlayerStealthKill(targetPlayer)
    setTimer(preventStealthAnimation, 50, 1, source)
end
addEventHandler("onPlayerStealthKill", root, onPlayerStealthKill)

See Also

Player events


Event functions


Retrieved from "https://wiki.multitheftauto.com/wiki/OnPlayerStealthKill?oldid=72073"