note Help Needed

This wiki is the result of an ongoing community effort — thank you all for helping!

If you want to provide changes to this page then please click here.

OnPlayerRequestSpawn

Description

This callback is called when a player attempts to spawn via class selection either by pressing SHIFT or clicking the 'Spawn' button.

Name	Description
playerid	The ID of the player that requested to spawn.

Returns

It is always called first in filterscripts so returning 0 there also blocks other scripts from processing it.

Examples

public OnPlayerRequestSpawn(playerid)
{
    if (!IsPlayerAdmin(playerid))
    {
        SendClientMessage(playerid, -1, "You may not spawn.");
        return 0;
    }
    return 1;
}

Notes

tip

This callback can also be called by NPC.

tip

To prevent players from spawning with certain classes, the last viewed class must be saved in a variable in OnPlayerRequestClass.

Related Callbacks

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

OnPlayerSpawn: This callback is called when a player spawns.
OnPlayerRequestClass: This callback is called when a player changes class at class selection.