OnPlayerDeployed
This function triggers when a player has been deployed into the game world. This event occurs after a player spawns and is useful for initializing player-specific settings, granting items, or setting up player states at the start of their deployment.
Syntax
export function OnPlayerDeployed(eventPlayer: mod.Player): void;
Parameters
| Parameter | Type | Description |
|---|---|---|
| eventPlayer | mod.Player | The player who has been deployed into the game world |
Example
// Give players a welcome message and starting equipment when they deploy
export async function OnPlayerDeployed(eventPlayer: mod.Player) {
// Display welcome message
const welcomeMsg = mod.Message(mod.stringkeys.welcome_player, eventPlayer);
mod.DisplayNotificationMessage(welcomeMsg, eventPlayer);
}
{
"welcome_player": "Welcome, {}!"
}
