Function unbanPlayer

  • unbanPlayer(
        sourceEntity: loosePlayerType,
        selectedBan: Globals.modules.bans.ban,
    ): Promise<0 | 1 | 2>

    Shows a UI for unbanning a player.

    This menu prompts players to confirm the unbanning of the specified player, and unbans they player if they confirm.

    Parameters

    Returns Promise<0 | 1 | 2>

    A promise that resolves to 0 if the previous menu should be closed, 1 if the previous menu should be reopened, or 2 if the menu before the previous menu should be reopened.

    Throws

    If sourceEntity is not an instance of the Player class or an instance of the executeCommandPlayerW class with a Player linked to it.

Settings

Member Visibility