OnPlayerEnterAreaTrigger

Triggers when a player exits an AreaTrigger.

Syntax

export function OnPlayerExitAreaTrigger(eventPlayer: mod.Player, eventAreaTrigger: mod.AreaTrigger): void;

Parameters

Parameter	Type	Description
eventPlayer	Player	The player who exited the area trigger
eventAreaTrigger	AreaTrigger	The area trigger that was exited

Example

script.ts

// Enable the area trigger when the game starts
export async function OnGameModeStarted() {
  console.log("Game mode started")
  const areaTrigger = mod.GetAreaTrigger(500);
  mod.EnableAreaTrigger(areaTrigger, true);
}

// Publish a message
export async function OnPlayerExitAreaTrigger(eventPlayer: mod.Player, eventAreaTrigger: mod.AreaTrigger) {
  const msg = mod.Message(mod.stringkeys.s0);
  mod.DisplayNotificationMessage(msg);
}

strings.json

{
  "s0": "A player exited an area trigger"
}