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.

OnPlayerConnect

Description

This callback is called when a player connects to the server.

Name	Description
playerid	The ID of the player that connected.

Returns

0 - Will prevent other filterscripts from receiving this callback.

1 - Indicates that this callback will be passed to the next filterscript.

It is always called first in filterscripts.

Examples

public OnPlayerConnect(playerid)
{
    new
        string[64],
        playerName[MAX_PLAYER_NAME];

    GetPlayerName(playerid, playerName, MAX_PLAYER_NAME);
    format(string, sizeof string, "%s has joined the server. Welcome!", playerName);
    SendClientMessageToAll(0xFFFFFFAA, string);
    return 1;
}

Notes

tip

This callback can also be called by NPC.

Related Callbacks

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

OnPlayerDisconnect: This callback is called when a player leaves the server.
OnIncomingConnection: This callback is called when a player is attempting to connect to the server.
OnPlayerFinishedDownloading: This callback is called when a player finishes downloading custom models.