Add-On Documentation
  • Preparing search index...
  • The search index is not available
8Crafter's Server Utilities API
  • 8Crafter's Server Utilities API
  • Globals
  • modules
  • uis
  • playerMenu_bounty_individuals

Function playerMenu_bounty_individuals

  • playerMenu_bounty_individuals(
        sourceEntity: loosePlayerType,
        totalBounty: Globals.modules.main.TotalBounty,
        targetPlayer?: Globals.modules.playersave.savedPlayer,
        pagen?: number,
        maxentriesperpage?: number,
        search?: { caseSensitive?: boolean; value: string },
        cachedEntries?: [
            bounty: Globals.modules.main.Bounty,
            source: Globals.modules.playersave.savedPlayer,
        ][],
    ): Promise<0 | 1>

    Parameters

    • sourceEntity: loosePlayerType

      The player accessing the menu.

    • totalBounty: Globals.modules.main.TotalBounty

      The total bounty object.

    • OptionaltargetPlayer: Globals.modules.playersave.savedPlayer

      The player the bountieis are on.

    • 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: [
          bounty: Globals.modules.main.Bounty,
          source: Globals.modules.playersave.savedPlayer,
      ][]

    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.

    • Defined in modules/ui/functions/playerMenu_bounty_individuals.ts:25

Settings

Member Visibility
Add-On Documentation
8Crafter's Server Utilities API
  • Loading...

Generated using TypeDoc