Class ServerShop

Todo

Convert the functions to async functions that return Promise<0|1>.

See

PlayerShop

Index

Constructors

constructor

new ServerShop(config: serverShopConfig): ServerShop
Parameters
- config: serverShopConfig
Returns ServerShop
- Defined in ExtraFeatures/server_shop.ts:112

Properties

buyShop

buyShop: boolean

Whether or not players can buy items in this shop.

id

id: `shop:${string}`

The id of the server shop.

`Optional`mainBuyPageBodyText

mainBuyPageBodyText?: string

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

Todo

`Optional`mainPageBodyText

mainPageBodyText?: string

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

`Optional`mainSellPageBodyText

mainSellPageBodyText?: string

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

Todo

`Optional`name

name?: string

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

publicShop

publicShop: boolean

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

sellShop

sellShop: boolean

Whether or not players can sell items in this shop.

`Optional`title

title?: string

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

Accessors

buyData

get buyData(): BuyableShopElement[]
Returns BuyableShopElement[]
- Defined in ExtraFeatures/server_shop.ts:447
set buyData(data: BuyableShopElement[]): void
Parameters
- data: BuyableShopElement[]
Returns void
- Defined in ExtraFeatures/server_shop.ts:454

sellData

get sellData(): SellableShopElement[]
Returns SellableShopElement[]
- Defined in ExtraFeatures/server_shop.ts:457
set sellData(data: SellableShopElement[]): void
Parameters
- data: SellableShopElement[]
Returns void
- Defined in ExtraFeatures/server_shop.ts:464

Methods

buyItem

buyItem(player: Player, item: ShopItem): Promise<0 | 1>
Parameters
- player: Player
- item: ShopItem
Returns Promise<0 | 1>
See
PlayerShop.buyItem

Async
- Defined in ExtraFeatures/server_shop.ts:486

editShopElements

editShopElements<T extends "buy" | "sell">(
mode: T,
data: (T extends "buy" ? BuyableShopElement : SellableShopElement)[],
): void
Type Parameters
- T extends "buy" | "sell"
Parameters
- mode: T
- data: (T extends "buy" ? BuyableShopElement : SellableShopElement)[]
Returns void
- Defined in ExtraFeatures/server_shop.ts:444

openShop

openShop(
    player: Player,
    mode?: "both" | "none" | "buy" | "sell",
    showBackButton?: boolean,
): Promise<0 | 1>
Opens the shop UI for the specified player.
Parameters
- player: Player
  The player to open the shop UI for.
- mode: "both" | "none" | "buy" | "sell" = ...
  The mode to open this shop in.
- showBackButton: boolean = true
Returns Promise<0 | 1>
A promise that will resolve with either a 0 or a 1, a 0 meaning that the previous UI should not be re-opened, and a 1 meaning that it should.

See
PlayerShop.openShop

Async
- Defined in ExtraFeatures/server_shop.ts:147

openShopPage

openShopPage<mode extends "buy" | "sell">(
    player: Player,
    data: mode extends "buy" ? BuyableShopElement[] : SellableShopElement[],
    path: [mode, ...string[]],
): Promise<0 | 1>
Opens the shop UI for the specified player.
Type Parameters
- mode extends "buy" | "sell"
Parameters
- player: Player
  The player to open the shop UI for.
- data: mode extends "buy" ? BuyableShopElement[] : SellableShopElement[]
  The object representing this page of the shop.
- path: [mode, ...string[]]
  The path to this page of the shop.
Returns Promise<0 | 1>
A promise that will resolve with either a 0 or a 1, a 0 meaning that the previous UI should not be re-opened, and a 1 meaning that it should.

See
PlayerShop.openShopPage

Async
- Defined in ExtraFeatures/server_shop.ts:308

save

save(): void
Returns void
- Defined in ExtraFeatures/server_shop.ts:123

sellItem

sellItem(player: Player, item: SellableShopItem): Promise<0 | 1>
Parameters
- player: Player
- item: SellableShopItem
Returns Promise<0 | 1>
Todo
Make return type be Promise<0|1>.

Todo
Copy over the menu for the item information from the player shop system.

Todo
Copy over the updated code from the player shop system.

See
PlayerShop.sellItem

Async
- Defined in ExtraFeatures/server_shop.ts:713

`Static`get

get(shopID: string): ServerShop
Parameters
- shopID: string
Returns ServerShop
- Defined in ExtraFeatures/server_shop.ts:467

`Static`getAll

getAll(): ServerShop[]
Returns ServerShop[]
- Defined in ExtraFeatures/server_shop.ts:473

`Static`getIds

getIds(): string[]
Returns string[]
- Defined in ExtraFeatures/server_shop.ts:476

`Static`openPublicShopsSelector

openPublicShopsSelector(
    sourceEntitya:
        | Entity
        | Player
        | Globals.modules.cmds.executeCommandPlayerW,
    showBackButton?: boolean,
): Promise<0 | 1>
Parameters
- sourceEntitya: Entity | Player | Globals.modules.cmds.executeCommandPlayerW
- showBackButton: boolean = false
Returns Promise<0 | 1>
Todo
Make an async function with return type of Promise<0|1>.

See
PlayerShop.openPublicShopsSelector
- Defined in ExtraFeatures/server_shop.ts:796

Class ServerShop

Todo

See

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ServerShop

Properties

buyShop

id

OptionalmainBuyPageBodyText

Todo

OptionalmainPageBodyText

OptionalmainSellPageBodyText

Todo

Optionalname

publicShop

sellShop

Optionaltitle

Accessors

buyData

Returns BuyableShopElement[]

Parameters

Returns void

sellData

Returns SellableShopElement[]

Parameters

Returns void

Methods

buyItem

Parameters

Returns Promise<0 | 1>

See

Async

editShopElements

Type Parameters

Parameters

Returns void

openShop

Parameters

Returns Promise<0 | 1>

See

Async

openShopPage

Type Parameters

Parameters

Returns Promise<0 | 1>

See

Async

save

Returns void

sellItem

Parameters

Returns Promise<0 | 1>

Todo

Todo

Todo

See

Async

Staticget

Parameters

Returns ServerShop

StaticgetAll

Returns ServerShop[]

StaticgetIds

Returns string[]

StaticopenPublicShopsSelector

Parameters

Returns Promise<0 | 1>

Todo

See

Settings

On This Page

`Optional`mainBuyPageBodyText

`Optional`mainPageBodyText

`Optional`mainSellPageBodyText

`Optional`name

`Optional`title

`Static`get

`Static`getAll

`Static`getIds

`Static`openPublicShopsSelector