Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Excerpt |
---|
A global event triggered when a player is revived (brought back to life). |
Syntax
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
function eventPlayerRevived(player) { // code to run when player is resurrected } |
Parameters
Parameter | Type | Mandatory | Notes | API Version |
---|---|---|---|---|
player | Players Object | The players object associated with the player that was revived. | 1.0 |
Return value
The return value is not currently processed.
Notes
The event is not triggered for players identified as spectators or vacant slots.
After the player is revived, the event may lag behind a little - it's only triggered the next time a script tries to determine if the player is alive (and even then only when any caches invalidate). If you want to force a periodical check, set a timer as follows:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
function checkPlayerStates() { void Players.alive; // will cause applicable events to be triggered } setTimer("checkPlayerStates", 2000); // check every 2 seconds |
Example
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
function eventPlayerRevived(player) { console(""+player+" has been resurrected!"); // a team member might have given them a truck... // or they might have received reinforcements... // or they are in debug mode and revived themselves... } |
Div | ||||||
---|---|---|---|---|---|---|
| ||||||
Availability
Requires:
|
Div | ||||
---|---|---|---|---|
| ||||
ContentsJump to:
|
Div | ||
---|---|---|
| ||
See alsoRelated articles:
|
Div | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Players APITopics:
|