Class PlayerShopManager

constructor

• new PlayerShopManager(): PlayerShopManager

  Returns PlayerShopManager

StaticplayerShopItemTextureHints

StaticplayerShopPageTextureHints

StaticplayerShopItemTextureHint

• get playerShopItemTextureHint(): string

  Returns string

StaticplayerShopPageTextureHint

• get playerShopPageTextureHint(): string

  Returns string

StaticaddPlayerShop

• addPlayerShop(
      sourceEntitya:
          | Entity
          | Player
          | Globals.modules.cmds.executeCommandPlayerW,
  ): Promise<0 | 1>

  Parameters

  • sourceEntitya: Entity | Player | Globals.modules.cmds.executeCommandPlayerW

  Returns Promise<0 | 1>

StaticaddPlayerShopAsPlayer

• addPlayerShopAsPlayer(
      sourceEntitya:
          | Entity
          | Player
          | Globals.modules.cmds.executeCommandPlayerW,
      targetPlayerID: `${number}`,
      targetPlayerName: string,
  ): Promise<0 | 1>

  Parameters

  • sourceEntitya: Entity | Player | Globals.modules.cmds.executeCommandPlayerW
  • targetPlayerID: `${number}`
  • targetPlayerName: string

  Returns Promise<0 | 1>

StaticmanagePlayerShop

• managePlayerShop(
      sourceEntitya:
          | Entity
          | Player
          | Globals.modules.cmds.executeCommandPlayerW,
      shop: PlayerShop,
  ): Promise<0 | 1>

  Parameters

  • sourceEntitya: Entity | Player | Globals.modules.cmds.executeCommandPlayerW
  • shop: PlayerShop

  Returns Promise<0 | 1>

StaticmanagePlayerShop_addItem

• managePlayerShop_addItem<mode extends "buy" | "sell">(
      sourceEntitya:
          | Entity
          | Player
          | Globals.modules.cmds.executeCommandPlayerW,
      shop: PlayerShop,
      type: "player_shop_sellable",
      mode: mode,
  ): Promise<ModalFormResponse>

  Opens the UI for editing a player shop item.

  Type Parameters

  • mode extends "buy" | "sell"

    Whether this is a buy or sell shop.

  Parameters

  • sourceEntitya: Entity | Player | Globals.modules.cmds.executeCommandPlayerW

    The player editing the shop item.
  • shop: PlayerShop

    The player shop that the shop item is in.
  • type: "player_shop_sellable"

    The type of the shop item that the player is adding.
  • mode: mode

  Returns Promise<ModalFormResponse>

  The chosen options in the edit item screen.

StaticmanagePlayerShop_addPage

• managePlayerShop_addPage<mode extends "buy" | "sell">(
      sourceEntitya:
          | Entity
          | Player
          | Globals.modules.cmds.executeCommandPlayerW,
      shop: PlayerShop,
      mode: mode,
  ): Promise<1>

  Type Parameters

  • mode extends "buy" | "sell"

  Parameters

  • sourceEntitya: Entity | Player | Globals.modules.cmds.executeCommandPlayerW
  • shop: PlayerShop
  • mode: mode

  Returns Promise<1>

StaticmanagePlayerShop_contents

• managePlayerShop_contents(
      sourceEntitya:
          | Entity
          | Player
          | Globals.modules.cmds.executeCommandPlayerW,
      shop: PlayerShop,
      mode?: "buy" | "sell",
  ): Promise<0 | 1>

  Parameters

  • sourceEntitya: Entity | Player | Globals.modules.cmds.executeCommandPlayerW
  • shop: PlayerShop
  • mode: "buy" | "sell" = "buy"

  Returns Promise<0 | 1>

StaticmanagePlayerShop_editAdvancedItem

• managePlayerShop_editAdvancedItem<mode extends "sell">(
      sourceEntitya:
          | Entity
          | Player
          | Globals.modules.cmds.executeCommandPlayerW,
      shop: PlayerShop,
      item: PlayerSellableAdvancedShopItem,
      itemIndex: number,
      mode: mode,
  ): Promise<ModalFormResponse>

  Opens the UI for editing a player shop item.

  Type Parameters

  • mode extends "sell"

    Whether this is a buy or sell shop.

  Parameters

  • sourceEntitya: Entity | Player | Globals.modules.cmds.executeCommandPlayerW

    The player editing the shop item.
  • shop: PlayerShop

    The player shop that the shop item is in.
  • item: PlayerSellableAdvancedShopItem

    The shop item that the player is editing.
  • itemIndex: number

    The index of the shop item that is being edited in the shop page, it is zero-indexed.
  • mode: mode

  Returns Promise<ModalFormResponse>

  The chosen options in the edit item screen.

StaticmanagePlayerShop_editItem

• managePlayerShop_editItem<mode extends "buy" | "sell">(
      sourceEntitya:
          | Entity
          | Player
          | Globals.modules.cmds.executeCommandPlayerW,
      shop: PlayerShop,
      item: mode extends "buy" ? PlayerSavedShopItem : PlayerSellableShopItem,
      itemIndex: number,
      mode: mode,
  ): Promise<ModalFormResponse>

  Opens the UI for editing a player shop item.

  Type Parameters

  • mode extends "buy" | "sell"

    Whether this is a buy or sell shop.

  Parameters

  • sourceEntitya: Entity | Player | Globals.modules.cmds.executeCommandPlayerW

    The player editing the shop item.
  • shop: PlayerShop

    The player shop that the shop item is in.
  • item: mode extends "buy" ? PlayerSavedShopItem : PlayerSellableShopItem

    The shop item that the player is editing.
  • itemIndex: number

    The index of the shop item that is being edited in the shop page, it is zero-indexed.
  • mode: mode

  Returns Promise<ModalFormResponse>

  The chosen options in the edit item screen.

  See

  ServerShopManager.manageServerShop_editItem

StaticmanagePlayerShop_editPage

• managePlayerShop_editPage<mode extends "buy" | "sell">(
      sourceEntitya:
          | Entity
          | Player
          | Globals.modules.cmds.executeCommandPlayerW,
      shop: PlayerShop,
      page: PlayerShopPage,
      pageIndex: number,
      mode: mode,
  ): Promise<1>

  Type Parameters

  • mode extends "buy" | "sell"

  Parameters

  • sourceEntitya: Entity | Player | Globals.modules.cmds.executeCommandPlayerW
  • shop: PlayerShop
  • page: PlayerShopPage
  • pageIndex: number
  • mode: mode

  Returns Promise<1>

StaticmanagePlayerShop_manageItem

• managePlayerShop_manageItem<mode extends "buy" | "sell">(
      sourceEntitya:
          | Entity
          | Player
          | Globals.modules.cmds.executeCommandPlayerW,
      shop: PlayerShop,
      item: mode extends "buy" ? PlayerSavedShopItem : PlayerSellableShopItem,
      itemIndex: number,
      mode: mode,
  ): Promise<0 | 1>

  Type Parameters

  • mode extends "buy" | "sell"

  Parameters

  • sourceEntitya: Entity | Player | Globals.modules.cmds.executeCommandPlayerW
  • shop: PlayerShop
  • item: mode extends "buy" ? PlayerSavedShopItem : PlayerSellableShopItem
  • itemIndex: number
  • mode: mode

  Returns Promise<0 | 1>

StaticmanagePlayerShop_managePage

• managePlayerShop_managePage<mode extends "buy" | "sell">(
      sourceEntitya:
          | Entity
          | Player
          | Globals.modules.cmds.executeCommandPlayerW,
      shop: PlayerShop,
      page: PlayerShopPage,
      pageIndex: number,
      mode: mode,
  ): Promise<0 | 1>

  Type Parameters

  • mode extends "buy" | "sell"

  Parameters

  • sourceEntitya: Entity | Player | Globals.modules.cmds.executeCommandPlayerW
  • shop: PlayerShop
  • page: PlayerShopPage
  • pageIndex: number
  • mode: mode

  Returns Promise<0 | 1>

StaticmanagePlayerShop_settings

• managePlayerShop_settings(
      sourceEntitya:
          | Entity
          | Player
          | Globals.modules.cmds.executeCommandPlayerW,
      shop: PlayerShop,
  ): Promise<0 | 1>

  Parameters

  • sourceEntitya: Entity | Player | Globals.modules.cmds.executeCommandPlayerW
  • shop: PlayerShop

  Returns Promise<0 | 1>

StaticmanagePlayerShopPage_addItem

• managePlayerShopPage_addItem<mode extends "buy" | "sell">(
      sourceEntitya:
          | Entity
          | Player
          | Globals.modules.cmds.executeCommandPlayerW,
      shop: PlayerShop,
      path: [mode, ...string[]],
      type: "player_shop_sellable",
  ): Promise<1>

  Type Parameters

  • mode extends "buy" | "sell"

  Parameters

  • sourceEntitya: Entity | Player | Globals.modules.cmds.executeCommandPlayerW
  • shop: PlayerShop
  • path: [mode, ...string[]]
  • type: "player_shop_sellable"

  Returns Promise<1>

StaticmanagePlayerShopPage_addPage

• managePlayerShopPage_addPage<mode extends "buy" | "sell">(
      sourceEntitya:
          | Entity
          | Player
          | Globals.modules.cmds.executeCommandPlayerW,
      shop: PlayerShop,
      path: [mode, ...string[]],
  ): Promise<0 | 1>

  Type Parameters

  • mode extends "buy" | "sell"

  Parameters

  • sourceEntitya: Entity | Player | Globals.modules.cmds.executeCommandPlayerW
  • shop: PlayerShop
  • path: [mode, ...string[]]

  Returns Promise<0 | 1>

StaticmanagePlayerShopPage_contents

• managePlayerShopPage_contents<mode extends "buy" | "sell">(
      sourceEntitya:
          | Entity
          | Player
          | Globals.modules.cmds.executeCommandPlayerW,
      shop: PlayerShop,
      path: [mode, ...string[]],
  ): Promise<0 | 1>

  Type Parameters

  • mode extends "buy" | "sell"

  Parameters

  • sourceEntitya: Entity | Player | Globals.modules.cmds.executeCommandPlayerW
  • shop: PlayerShop
  • path: [mode, ...string[]]

  Returns Promise<0 | 1>

StaticmanagePlayerShopPage_editItem

• managePlayerShopPage_editItem<mode extends "buy" | "sell">(
      sourceEntitya:
          | Entity
          | Player
          | Globals.modules.cmds.executeCommandPlayerW,
      shop: PlayerShop,
      path: [mode, ...string[]],
      item: mode extends "buy" ? PlayerSavedShopItem : PlayerSellableShopItem,
      itemIndex: number,
  ): Promise<1>

  Type Parameters

  • mode extends "buy" | "sell"

  Parameters

  • sourceEntitya: Entity | Player | Globals.modules.cmds.executeCommandPlayerW
  • shop: PlayerShop
  • path: [mode, ...string[]]
  • item: mode extends "buy" ? PlayerSavedShopItem : PlayerSellableShopItem
  • itemIndex: number

  Returns Promise<1>

StaticmanagePlayerShopPage_editPage

• managePlayerShopPage_editPage<mode extends "buy" | "sell">(
      sourceEntitya:
          | Entity
          | Player
          | Globals.modules.cmds.executeCommandPlayerW,
      shop: PlayerShop,
      path: [mode, ...string[]],
      page: PlayerShopPage,
      pageIndex: number,
  ): Promise<1>

  Type Parameters

  • mode extends "buy" | "sell"

  Parameters

  • sourceEntitya: Entity | Player | Globals.modules.cmds.executeCommandPlayerW
  • shop: PlayerShop
  • path: [mode, ...string[]]
  • page: PlayerShopPage
  • pageIndex: number

  Returns Promise<1>

StaticmanagePlayerShopPage_manageItem

• managePlayerShopPage_manageItem<mode extends "buy" | "sell">(
      sourceEntitya:
          | Entity
          | Player
          | Globals.modules.cmds.executeCommandPlayerW,
      shop: PlayerShop,
      path: [mode, ...string[]],
      item: mode extends "buy" ? PlayerSavedShopItem : PlayerSellableShopItem,
      itemIndex: number,
  ): Promise<0 | 1>

  Type Parameters

  • mode extends "buy" | "sell"

  Parameters

  • sourceEntitya: Entity | Player | Globals.modules.cmds.executeCommandPlayerW
  • shop: PlayerShop
  • path: [mode, ...string[]]
  • item: mode extends "buy" ? PlayerSavedShopItem : PlayerSellableShopItem
  • itemIndex: number

  Returns Promise<0 | 1>

StaticmanagePlayerShopPage_managePage

• managePlayerShopPage_managePage<mode extends "buy" | "sell">(
      sourceEntitya:
          | Entity
          | Player
          | Globals.modules.cmds.executeCommandPlayerW,
      shop: PlayerShop,
      path: [mode, ...string[]],
      page: PlayerShopPage,
      pageIndex: number,
  ): Promise<0 | 1>

  Type Parameters

  • mode extends "buy" | "sell"

  Parameters

  • sourceEntitya: Entity | Player | Globals.modules.cmds.executeCommandPlayerW
  • shop: PlayerShop
  • path: [mode, ...string[]]
  • page: PlayerShopPage
  • pageIndex: number

  Returns Promise<0 | 1>

StaticmanagePlayerShops

• managePlayerShops(
      sourceEntitya:
          | Entity
          | Player
          | Globals.modules.cmds.executeCommandPlayerW,
      all?: boolean,
  ): Promise<0 | 1>

  Parameters

  • sourceEntitya: Entity | Player | Globals.modules.cmds.executeCommandPlayerW
  • all: boolean = false

  Returns Promise<0 | 1>

StaticplayerShopSystemSettings

• playerShopSystemSettings(
      sourceEntitya:
          | Entity
          | Player
          | Globals.modules.cmds.executeCommandPlayerW,
  ): Promise<0 | 1>

  Parameters

  • sourceEntitya: Entity | Player | Globals.modules.cmds.executeCommandPlayerW

  Returns Promise<0 | 1>

  Todo

  Add the "Shop Item Settings" section.

  See

  ServerShopManager.serverShopSystemSettings

StaticplayerShopSystemSettings_main

• playerShopSystemSettings_main(
      sourceEntitya:
          | Entity
          | Player
          | Globals.modules.cmds.executeCommandPlayerW,
  ): Promise<0 | 1>

  Parameters

  • sourceEntitya: Entity | Player | Globals.modules.cmds.executeCommandPlayerW

  Returns Promise<0 | 1>