✨
Irminsul Docs
  • Home
  • Reference
    • Configuration
    • Plugin Installation Tutorial
  • API
    • API Tutorials
      • Plugin Tutorial: Discord Integration
    • API References
      • Game Events
        • PlayerChatEvent
        • PlayerExecuteCommandEvent
        • PlayerLoginEvent
        • PlayerSendCommandEvent
        • PlayerSwitchAvatarEvent
        • PlayerTeleportEvent
        • PlayerTickEvent
        • WorldTickEvent
Powered by GitBook
On this page
  • Fields
  • cancelled
  • player
  • from
  • to
  1. API
  2. API References
  3. Game Events

PlayerSwitchAvatarEvent

Documentation for the PlayerSwitchAvatarEvent event in the Irminsul game server API

PlayerSwitchAvatarEvent is a cancellabe event fired when a player attempts to switch their active on-field avatar (character).

Fields

cancelled

boolean, inherited

Whether this event has been cancelled

player

final io.irminsul.common.game.player.Player

The player switching avatars. Guaranteed non-null.

from

final io.irminsul.common.game.avatar.Avatar

The avatar the player is switching from. Guaranteed non-null.

to

final io.irminsul.common.game.avatar.Avatar

The avatar the player is switching to. Guaranteed non-null.

PreviousPlayerSendCommandEventNextPlayerTeleportEvent

Last updated 4 months ago