Class PlayerShop

See

ServerShop

Constructors

constructor

Properties

buyShop id mainBuyPageBodyText? mainPageBodyText? mainSellPageBodyText? name? playerID playerName? publicShop sellShop title?

Accessors

buyData sellData

Methods

buyItem createStorageEntity editShopElements openShop openShopPage save sellItem get getAll getAllForPlayer getIds getIdsForPlayer openPublicShopsSelector

Constructors

constructor

Properties

buyShop

buyShop: boolean

Whether or not players can buy items in this shop.

id

id: `playerShop:${number}:${string}`

The id of the player shop.

OptionalmainBuyPageBodyText

mainBuyPageBodyText?: string

The body text that is displayed on the main buy page of the server shop.

OptionalmainPageBodyText

mainPageBodyText?: string

The body text that is displayed on the main page of the player shop.

OptionalmainSellPageBodyText

mainSellPageBodyText?: string

The body text that is displayed on the main sell page of the server shop.

Optionalname

name?: string

The display name of the player shop. This is displayed on the button for the player shop in the manage player shops menu.

playerID

playerID: `${number}`

The ID of the player who owns this player shop.

OptionalplayerName

playerName?: string

The name of the player who owns this player shop.

publicShop

publicShop: boolean

Whether or not this shop can be accessed by any player through the use of the \viewplayershops command.

sellShop

sellShop: boolean

Whether or not players can sell items in this shop.

Optionaltitle

title?: string

The title of the player shop. This is the title displayed at the top of the UI for the player shop.

Accessors

buyData

sellData

Methods

buyItem

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

    Parameters

    Returns Promise<0 | 1>

createStorageEntity

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

    Parameters

    Returns Promise<void>

editShopElements

openShop

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

    Parameters

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

    Returns Promise<0 | 1>

openShopPage

save

  • save(): void

    Returns void

sellItem

Staticget

  • get(shopID: string): PlayerShop

    Parameters

    • shopID: string

    Returns PlayerShop

StaticgetAll

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.

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods