query · world.actor
Actor wealth
Returns paginated detached personal currency balances for one actor.
world.actor.wealth(filters?, cursor?, page_size?) -> query-page- Stable ID
world.actor.wealth- Owner
- game.resource-economy and assets.runtime-content-catalog
- Authority
- read_only
- Timing
- immediate
- Availability
- active-session
- Side effects
- none
- Determinism
- stable owner order at the current committed tick
- Introduced
- 1.4.0
Usage
Query one actor_id to read detached personal currency balances and the current wallet revision. The returned table cannot move or reserve money.
Parameters
- filters.actor_id: required stable Actor identity.
- cursor: optional continuation cursor.
- page_size: bounded currency-row limit.
Returns
One detached row per authored currency in stable catalog order, including zero balances.
Cost
One Actor-wallet lookup plus bounded content-catalog and Resource-definition visits.
Fields
| ID | Type | Units | Required | Description |
|---|---|---|---|---|
actor_id | stable-id | none | yes | Actor identity. |
balance | unsigned-integer | minor-currency-units | yes | Current personal balance. |
container_id | stable-id | none | yes | Actor-wallet container identity. |
container_revision | revision | none | yes | Wallet owner revision. |
currency_definition_id | string | none | yes | Authored currency definition identity. |
display_name | string | none | yes | Player-facing currency name. |
resource_id | stable-id | none | yes | Runtime Resource identity. |
Errors
error.capability-unavailableerror.invalid-queryerror.query-budget-exhaustederror.query-contract-violation
Examples
local money = world.query("world.actor.wealth", {page_size = 8, filters = {actor_id = actor_id}})API history
- 1.4.0: Physical Actor wallet custody exposed for Phase 16D2.