Skip to content
Lucent
Esc
↑↓navigate↵open
On this page

api.shop

Members

api.shop.buy()

api.shop.buy(query: ShopItemQuery, options?: ScriptShopQuantityOptions): Effect.Effect<boolean>
Name Type Required Default Description
query ShopItemQuery
options ScriptShopQuantityOptions

Returns: boolean

Errors: never

api.shop.canBuy()

api.shop.canBuy(query: ShopItemQuery, options?: ScriptShopQuantityOptions): Effect.Effect<boolean>
Name Type Required Default Description
query ShopItemQuery
options ScriptShopQuantityOptions

Returns: boolean

Errors: never

api.shop.close()

api.shop.close(shopId?: number): Effect.Effect<boolean>
Name Type Required Default Description
shopId number

Returns: boolean

Errors: never

api.shop.enhanceItem()

api.shop.enhanceItem(item: ItemQuery, options: ScriptEnhanceItemOptions): Effect.Effect<boolean>
Name Type Required Default Description
item ItemQuery
options ScriptEnhanceItemOptions

Returns: boolean

Errors: never

api.shop.get()

api.shop.get(query: ShopItemQuery): Effect.Effect<LiveItem | null>
Name Type Required Default Description
query ShopItemQuery

Returns: LiveItem | null

Errors: never

api.shop.getAll()

api.shop.getAll(): Effect.Effect<readonly LiveItem[]>

Returns: readonly LiveItem[]

Errors: never

api.shop.getCurrent()

api.shop.getCurrent(): Effect.Effect<LiveShop | null>

Returns: LiveShop | null

Errors: never

api.shop.getMaxBuyQuantity()

api.shop.getMaxBuyQuantity(query: ShopItemQuery): Effect.Effect<number>
Name Type Required Default Description
query ShopItemQuery

Returns: number

Errors: never

api.shop.isMergeShop()

api.shop.isMergeShop(): Effect.Effect<boolean>

Returns: boolean

Errors: never

api.shop.isOpen()

api.shop.isOpen(shopId?: number): Effect.Effect<boolean>
Name Type Required Default Description
shopId number

Returns: boolean

Errors: never

api.shop.open()

api.shop.open(shopId: number): Effect.Effect<boolean>
Name Type Required Default Description
shopId number

Returns: boolean

Errors: never

api.shop.openArmorCustomize()

api.shop.openArmorCustomize(): Effect.Effect<void>

Returns: void

Errors: never

api.shop.openHairShop()

api.shop.openHairShop(shopId: number): Effect.Effect<void>
Name Type Required Default Description
shopId number

Returns: void

Errors: never

api.shop.sell()

api.shop.sell(query: ItemQuery, options?: ScriptShopQuantityOptions): Effect.Effect<boolean>
Name Type Required Default Description
query ItemQuery
options ScriptShopQuantityOptions

Returns: boolean

Errors: never

Type preview
Open page

Last updated on September 26, 2026

Was this page helpful?