Skip to main content

Escaping

Gets called when the player is escaping.

Start a script section

!-- OnEvent Escaping
-- require @evPlayer $evOldRole $evNewRole $evEscapeScenario *evEscapeZone $evIsAllowed

# Add your instructions here
  • Group: PlayerEvents
  • Cancellable: Yes
  • Event data: PlayerEscapingEventArgs

Injected variables

VariableTypeDescription
@evPlayerplayer valueGets the player who is escaping.
$evOldRoleRoleTypeId enum valueGets the old role of the player.
$evNewRoleRoleTypeId enum valueGets or sets the new role that is set after escape.
$evEscapeScenarioEscapeScenarioType enum valueGets or sets the escape scenario.
*evEscapeZonereference to Bounds objectThe bounds of the escape zone that was triggered.
$evIsAllowedbool valueWhether the event is allowed to run.