Function managePlayers

  • managePlayers(
        sourceEntity: loosePlayerType,
        pagen?: number,
        maxplayersperpage?: number,
        search?: {
            caseSensitive?: boolean;
            searchIds?: boolean;
            searchLastOnlineDates?: boolean;
            searchLastOnlineTimes?: boolean;
            searchNames?: boolean;
            value: string;
        },
        cachedPlayers?: [
            online: Globals.modules.playersave.savedPlayer[],
            offline: Globals.modules.playersave.savedPlayer[],
            banned: Globals.modules.playersave.savedPlayer[],
        ],
    ): Promise<0 | 1>

    Displays a UI for managing bans on players.

    Parameters

    • sourceEntity: loosePlayerType

      The player accessing the menu.

    • Optionalpagen: number = 0

      The page of the menu to go to. Defaults to 0.

    • Optionalmaxplayersperpage: number = ...

      How many players to show per page. Defaults to the value of config.ui.pages.maxPlayersPerManagePlayersPage.

    • Optionalsearch: {
          caseSensitive?: boolean;
          searchIds?: boolean;
          searchLastOnlineDates?: boolean;
          searchLastOnlineTimes?: boolean;
          searchNames?: boolean;
          value: string;
      }

      The search query and options.

      • OptionalcaseSensitive?: boolean

        Whether to search case sensitively.

      • OptionalsearchIds?: boolean

        Whether to search by UUID.

      • OptionalsearchLastOnlineDates?: boolean

        Whether to search by last online date.

      • OptionalsearchLastOnlineTimes?: boolean

        Whether to search by last online time.

      • OptionalsearchNames?: boolean

        Whether to search by name.

      • value: string

        The search query.

    • OptionalcachedPlayers: [
          online: Globals.modules.playersave.savedPlayer[],
          offline: Globals.modules.playersave.savedPlayer[],
          banned: Globals.modules.playersave.savedPlayer[],
      ]

      The cached players.

    Returns Promise<0 | 1>

    A promise that resolves to 0 if the previous menu should be closed, or 1 if 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