api.bank

Members

`api.bank.contains()`

api.bank.contains(query: ItemQuery, quantity?: number): Effect.Effect<boolean>

Name	Type	Required	Default	Description
`query`	`ItemQuery`
`quantity`	`number`		`1`	The minimum quantity required.

Returns: boolean

Errors: never

`api.bank.deposit()`

api.bank.deposit(query: ItemQuery): Effect.Effect<boolean>

Name	Type	Required	Default	Description
`query`	`ItemQuery`

Returns: boolean

Errors: never

`api.bank.depositBatch()`

api.bank.depositBatch(selectors: readonly ItemQuery[]): Effect.Effect<boolean[]>

Name	Type	Required	Default	Description
`selectors`	`readonly` `ItemQuery`[]

Returns: boolean[]

Errors: never

`api.bank.get()`

api.bank.get(query: ItemQuery): Effect.Effect<LiveItem | null>

Name	Type	Required	Default	Description
`query`	`ItemQuery`

Returns: LiveItem | null

Errors: never

`api.bank.getAll()`

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

Returns: readonly LiveItem[]

Errors: never

`api.bank.getAvailableSlots()`

api.bank.getAvailableSlots(): Effect.Effect<number>

Returns: number

Errors: never

`api.bank.getSlots()`

api.bank.getSlots(): Effect.Effect<number>

Returns: number

Errors: never

`api.bank.getUsedSlots()`

api.bank.getUsedSlots(): Effect.Effect<number>

Returns: number

Errors: never

`api.bank.isOpen()`

api.bank.isOpen(view?: BankView): Effect.Effect<boolean>

Name	Type	Required	Default	Description
`view`	`BankView`

Returns: boolean

Errors: never

`api.bank.load()`

api.bank.load(force?: boolean): Effect.Effect<boolean>

Name	Type	Required	Default	Description
`force`	`boolean`		`false`	Whether to reload an already loaded bank.

Returns: boolean

Errors: never

`api.bank.open()`

api.bank.open(options?: BankOpenOptions): Effect.Effect<boolean>

Name	Type	Required	Default	Description
`options`	`BankOpenOptions`		`{}`

Returns: boolean

Errors: never

`api.bank.swap()`

api.bank.swap(inventoryQuery: ItemQuery, bankQuery: ItemQuery): Effect.Effect<boolean>

Name	Type	Required	Default	Description
`inventoryQuery`	`ItemQuery`
`bankQuery`	`ItemQuery`

Returns: boolean

Errors: never

`api.bank.withdraw()`

api.bank.withdraw(query: ItemQuery): Effect.Effect<boolean>

Name	Type	Required	Default	Description
`query`	`ItemQuery`

Returns: boolean

Errors: never

`api.bank.withdrawBatch()`

api.bank.withdrawBatch(selectors: readonly ItemQuery[]): Effect.Effect<boolean[]>

Name	Type	Required	Default	Description
`selectors`	`readonly` `ItemQuery`[]

Returns: boolean[]

Errors: never