OnPedDamage: Difference between revisions
Jump to navigation
Jump to search
(Added onPedDamage event docs) |
mNo edit summary |
||
| (5 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server event}} | {{Server event}} | ||
This event is triggered when a ped is | This event is triggered when a ped is damaged. For player damage, use [[onPlayerDamage]] instead. | ||
{{Note|This event is not triggered prior to r21247.}} | |||
==Parameters== | ==Parameters== | ||
<syntaxhighlight lang="lua">float | <syntaxhighlight lang="lua">float loss</syntaxhighlight> | ||
*'''loss''': an [[int]] representing the percentage of health the ped lost. | |||
==Source== | ==Source== | ||
The [[event system#Event source|source]] of this event is the [[ped]] that got damaged. | The [[event system#Event source|source]] of this event is the [[ped]] that got damaged. | ||
==Cancel Effect== | |||
Canceling this event has no effect. Cancel the client-side event [[onClientPedDamage]] instead. | |||
==Example== | ==Example== | ||
This example outputs to the console | This example outputs a message to the console when a specific ped is damaged. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
ped1 = createPed(112, 0, 0, 0) -- | local ped1 = createPed(112, 0, 0, 0) -- create our ped | ||
function | |||
outputConsole(" | function pedDamaged(loss) | ||
outputConsole("ped1 damaged! loss: " .. tostring(loss)) | |||
end | end | ||
addEventHandler("onPedDamage", ped1, | |||
addEventHandler("onPedDamage", ped1, pedDamaged) -- triggered only when ped1 gets damaged | |||
</syntaxhighlight> | </syntaxhighlight> | ||
{{See also/Server event|Ped events}} | {{See also/Server event|Ped events}} | ||
Latest revision as of 20:22, 31 May 2022
This event is triggered when a ped is damaged. For player damage, use onPlayerDamage instead.
| Note: This event is not triggered prior to r21247. |
Parameters
float loss
- loss: an int representing the percentage of health the ped lost.
Source
The source of this event is the ped that got damaged.
Cancel Effect
Canceling this event has no effect. Cancel the client-side event onClientPedDamage instead.
Example
This example outputs a message to the console when a specific ped is damaged.
local ped1 = createPed(112, 0, 0, 0) -- create our ped
function pedDamaged(loss)
outputConsole("ped1 damaged! loss: " .. tostring(loss))
end
addEventHandler("onPedDamage", ped1, pedDamaged) -- triggered only when ped1 gets damaged
See Also
Ped events
Event functions
Shared
- addEvent
- addEventHandler
- cancelEvent
- cancelLatentEvent
- getEventHandlers
- getLatentEventHandles
- getLatentEventStatus
- removeEventHandler
- triggerEvent
- wasEventCancelled