Class PlayerShop

constructor

• new PlayerShop(config: playerShopConfig): PlayerShop

  Parameters

  • config: playerShopConfig

  Returns PlayerShop

buyShop

id

OptionalmainBuyPageBodyText

OptionalmainPageBodyText

OptionalmainSellPageBodyText

Optionalname

playerID

OptionalplayerName

publicShop

sellShop

Optionaltitle

buyData

• get buyData(): PlayerBuyableShopElement[]

  Returns PlayerBuyableShopElement[]

• set buyData(data: PlayerBuyableShopElement[]): void

  Parameters

  • data: PlayerBuyableShopElement[]

  Returns void

sellData

• get sellData(): PlayerSellableShopElement[]

  Returns PlayerSellableShopElement[]

• set sellData(data: PlayerSellableShopElement[]): void

  Parameters

  • data: PlayerSellableShopElement[]

  Returns void

buyItem

• buyItem(
      player: Player,
      item: PlayerSavedShopItem,
      path: ["buy" | "sell", ...(string | number)[]],
      itemIndex: number,
  ): Promise<0 | 1>

  Parameters

  • player: Player
  • item: PlayerSavedShopItem
  • path: ["buy" | "sell", ...(string | number)[]]
  • itemIndex: number

  Returns Promise<0 | 1>

createStorageEntity

• createStorageEntity(player?: Player): Promise<void>

  Parameters

  • player: Player = ...

  Returns Promise<void>

editShopElements

• editShopElements<T extends "buy" | "sell">(
      mode: T,
      data: (
          T extends "buy" ? PlayerBuyableShopElement : PlayerSellableShopElement
      )[],
  ): void

  Type Parameters

  • T extends "buy" | "sell"

  Parameters

  • mode: T
  • data: (T extends "buy" ? PlayerBuyableShopElement : PlayerSellableShopElement)[]

  Returns void

openShop

• openShop(
      player: Player,
      mode?: "none" | "both" | "buy" | "sell",
      showBackButton?: boolean,
  ): Promise<0 | 1>

  Parameters

  • player: Player
  • mode: "none" | "both" | "buy" | "sell" = ...
  • showBackButton: boolean = true

  Returns Promise<0 | 1>

openShopPage

• openShopPage<mode extends "buy" | "sell">(
      player: Player,
      data: mode extends "buy"
          ? PlayerBuyableShopElement[]
          : PlayerSellableShopElement[],
      path: [mode, ...string[]],
  ): Promise<0 | 1>

  Type Parameters

  • mode extends "buy" | "sell"

  Parameters

  • player: Player
  • data: mode extends "buy" ? PlayerBuyableShopElement[] : PlayerSellableShopElement[]
  • path: [mode, ...string[]]

  Returns Promise<0 | 1>

save

• save(): void

  Returns void

sellItem

• sellItem(
      player: Player,
      item: PlayerSellableShopItem | PlayerSellableAdvancedShopItem,
      path: ["buy" | "sell", ...(string | number)[]],
      itemIndex: number,
  ): Promise<0 | 1>

  Parameters

  • player: Player
  • item: PlayerSellableShopItem | PlayerSellableAdvancedShopItem
  • path: ["buy" | "sell", ...(string | number)[]]
  • itemIndex: number

  Returns Promise<0 | 1>

Staticget

• get(shopID: string): undefined | PlayerShop

  Parameters

  • shopID: string

  Returns undefined | PlayerShop

StaticgetAll

• getAll(): PlayerShop[]

  Returns PlayerShop[]

StaticgetAllForPlayer

• getAllForPlayer(playerID: `${number}`): PlayerShop[]

  Parameters

  • playerID: `${number}`

  Returns PlayerShop[]

StaticgetIds

• getIds(): string[]

  Returns string[]

StaticgetIdsForPlayer

• getIdsForPlayer(playerID: `${number}`): string[]

  Parameters

  • playerID: `${number}`

  Returns string[]

StaticopenPublicShopsSelector

• openPublicShopsSelector(
      sourceEntity: loosePlayerType,
      showBackButton?: boolean,
  ): Promise<0 | 1>

  Opens the public shops selector interface for the player.

  Parameters

  • sourceEntity: loosePlayerType

    The player viewing the menu, can be an Entity, executeCommandPlayerW, or Player.
  • OptionalshowBackButton: boolean = false

    Optional boolean to indicate if a back button should be displayed.

  Returns Promise<0 | 1>

  A promise that resolves to 0 or 1 depending on the user's interaction:

  • 0: Indicates that the previous menu should be closed.
  • 1: Indicates that the previous menu should be re-opened.

  See

  ServerShop.openPublicShopsSelector

  Remarks

  The function performs the following actions:

  1. Retrieves the player entity from the source entity.
  2. Asserts that the source entity is defined.
  3. Creates and configures an ActionFormData form with options for public player shops.
  4. Displays the form to the player and handles their selection:
     • manageMyShops: Opens the manage player shops interface.
     • manageAllShops: Opens the manage all shops interface (admin only).
     • playerShopSystemSettings: Opens the player shop system settings interface (admin only).
     • back: Returns 1.
     • close: Returns 0.
     • refresh: Refreshes the public shops selector interface.
     • shop: Opens the selected shop interface.
  5. Handles errors by logging and showing a message to the player.