SendDeathMessage

SendDeathMessage

Description:

Function SendDeathMessage adds a death to the 'killfeed' on the right-hand side of the screen for all players.

Death messages can be cleared by using a valid player ID for 'playerid' that is not connected. To show a death message for just a single player, use SendDeathMessageToPlayer. You can use NPCs to create your own custom death reasons.

Parameters:

(killer, playerid, weapon)

int

killer

The ID of the killer (can be INVALID_PLAYER_ID).

int

playerid

The ID of the player that died.

int

weapon

The reason (not always a weapon) for the victim's death. Special icons can also be used (ICON_CONNECT and ICON_DISCONNECT).

Return Values:

This function always returns 1, even if the function fails to execute. The function fails to execute (no death message shown) if 'playerid' is invalid. If 'reason' is invalid, a generic skull-and-crossbones icon is shown. 'killerid' being invalid (INVALID_PLAYER_ID) is valid.

Examples:

Example 1

public OnPlayerDeath(playerid, killerid, reason)
{
    SendDeathMessage(killerid, playerid, reason);
    return 1;
}

Related Functions

The following functions may be useful, as they are related to this function in one way or another.

• SendDeathMessageToPlayer: Add a kill to the death list for a player.

Related Callbacks

The following callbacks might be useful as well, as they are related to this callback in one way or another.

• OnPlayerDeath: Called when a player dies.