Function manageMutes

  • manageMutes(
        sourceEntity: loosePlayerType,
        pagen?: number,
        maxentriesperpage?: number,
        search?: { caseSensitive?: boolean; value: string },
        cachedEntries?: [playerName: string, status: "online" | "offline"][],
    ): Promise<0 | 1>

    Displays a UI for managing mutes on players.

    Parameters

    • sourceEntity: loosePlayerType

      The player accessing the menu.

    • Optionalpagen: number = 0

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

    • Optionalmaxentriesperpage: number = ...

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

    • Optionalsearch: { caseSensitive?: boolean; value: string }
    • OptionalcachedEntries: [playerName: string, status: "online" | "offline"][]

    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