OnVehicleDamage: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (See Also for server events)
No edit summary
 
(10 intermediate revisions by 6 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Server event}}
{{Server event}}
This event is triggered when a vehicle encounters damage.
This event is triggered when a vehicle is damaged. If you want to get the attacker you can use [[onClientVehicleDamage]].


==Parameters==  
==Parameters==  
Line 8: Line 8:
</syntaxhighlight>  
</syntaxhighlight>  


*'''loss''': A float representing the amount of health the vehicle lost.
*'''loss''': a [[float]] representing the amount of health the [[vehicle]] lost.


==Source==
==Source==
Line 14: Line 14:


==Example==  
==Example==  
This example page lacks an example
This example displays a message with the amount of health lost when a vehicle gets damaged.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--add an example here
function displayVehicleLoss(loss)
    local thePlayer = getVehicleOccupant(source)
    if(thePlayer) then -- Check there is a player in the vehicle
        outputChatBox("Your vehicle just lost " .. tonumber(loss) .. " health.", thePlayer) -- Display the message
    end
end
 
addEventHandler("onVehicleDamage", root, displayVehicleLoss)
</syntaxhighlight>
</syntaxhighlight>


{{See also/Server event|Vehicle events}}
{{See also/Server event|Vehicle events}}
[[Category:Needs Example]]

Latest revision as of 03:05, 27 September 2018

This event is triggered when a vehicle is damaged. If you want to get the attacker you can use onClientVehicleDamage.

Parameters

float loss
  • loss: a float representing the amount of health the vehicle lost.

Source

The source of this event is the vehicle that got damaged.

Example

This example displays a message with the amount of health lost when a vehicle gets damaged.

function displayVehicleLoss(loss)
    local thePlayer = getVehicleOccupant(source)
    if(thePlayer) then -- Check there is a player in the vehicle
        outputChatBox("Your vehicle just lost " .. tonumber(loss) .. " health.", thePlayer) -- Display the message
    end
end

addEventHandler("onVehicleDamage", root, displayVehicleLoss)

See Also

Vehicle events


Event functions