OnClientObjectDamage: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "__NOTOC__ {{Client event}} This event is fired before an object gets damaged. Also note that this event is only triggered for players nearby the local player's camera. This is du...")
 
No edit summary
 
(7 intermediate revisions by 5 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client event}}
{{Client event}}
This event is fired before an object gets damaged. Also note that this event is only triggered for players nearby the local player's camera. This is due to elements far away being streamed out.
This event is fired before an object gets damaged.
{{Note|This event is only triggered for objects that are streamed in.}}
==Parameters==
==Parameters==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
float loss
float loss, element attacker
</syntaxhighlight>
</syntaxhighlight>
*'''loss:''' the health loss caused by the damage. This parameter contains the theoretical loss, which could be less than 0, if you substract it of the current health. If you want to get the real loss, you have to substract the new health of the old health (use a timer for this).
*'''loss:''' the health loss caused by the damage. This parameter contains the theoretical loss, which could be less than 0, if you substract it of the current health. If you want to get the real loss, you have to substract the new health of the old health (use a timer for this).
*'''attacker:''' the vehicle/ped/player who is damaging the object.


==Source==
==Source==
The source of this event is the object which was damaged
The source of this event is the object which was damaged.


==Cancel effect==
==Cancel effect==
Line 15: Line 17:


==Example==
==Example==
<section class="client" name="Client" show="true">
This example outputs the theoretical and real loss:
This example outputs the theoretical and real loss.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function outputLoss(loss)
function outputLoss(loss)
     local oldHealth = getElementHealth(source)
     local oldHealth = getElementHealth(source)
     setTimer(function()
     setTimer(function(source)
         local newHealth = getElementHealth(source)
         local newHealth = getElementHealth(source)
         outputChatBox("Real loss: "..(newHealth-oldHealth))
         outputChatBox("Real loss: "..(newHealth-oldHealth))
         outputChatBox("Theoretical loss: "..loss)
         outputChatBox("Theoretical loss: "..loss)
     end)
     end,100,1,source)
end
end
addEventHandler("onClientObjectDamage", root, outputLoss)
addEventHandler("onClientObjectDamage", root, outputLoss)
</syntaxhighlight>
</syntaxhighlight>
</section>


==Requirements==
==Requirements==
{{Requirements|n/a|1.4-9.04924|}}
{{Requirements|n/a|1.3-9.05086|}}


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

Latest revision as of 15:20, 3 September 2020

This event is fired before an object gets damaged.

[[{{{image}}}|link=|]] Note: This event is only triggered for objects that are streamed in.

Parameters

float loss, element attacker
  • loss: the health loss caused by the damage. This parameter contains the theoretical loss, which could be less than 0, if you substract it of the current health. If you want to get the real loss, you have to substract the new health of the old health (use a timer for this).
  • attacker: the vehicle/ped/player who is damaging the object.

Source

The source of this event is the object which was damaged.

Cancel effect

If this event is canceled, the object will not be damaged.

Example

This example outputs the theoretical and real loss:

function outputLoss(loss)
    local oldHealth = getElementHealth(source)
    setTimer(function(source)
        local newHealth = getElementHealth(source)
        outputChatBox("Real loss: "..(newHealth-oldHealth))
        outputChatBox("Theoretical loss: "..loss)
    end,100,1,source)
end
addEventHandler("onClientObjectDamage", root, outputLoss)

Requirements

Minimum server version n/a
Minimum client version 1.3-9.05086

Note: Using this feature requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version client="1.3-9.05086" />

See Also

Client object events


Client event functions