query · world.household

Household wealth

Returns paginated detached currency balances held by one household.

world.household.wealth(filters?, cursor?, page_size?) -> query-page

Stable ID: world.household.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 household_id to read its detached currency balances and the current Resource custody revision. The returned table cannot move or reserve money.

Parameters

filters.household_id: required stable Household 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 Household-money container lookup plus bounded content-catalog and Resource-definition visits.

Fields

ID	Type	Units	Required	Description
`balance`	`unsigned-integer`	minor-currency-units	yes	Current household balance.
`container_id`	`stable-id`	none	yes	Household-money container identity.
`container_revision`	`revision`	none	yes	Money-custody owner revision.
`currency_definition_id`	`string`	none	yes	Authored currency definition identity.
`display_name`	`string`	none	yes	Player-facing currency name.
`household_id`	`stable-id`	none	yes	Household identity.
`resource_id`	`stable-id`	none	yes	Runtime Resource identity.

Errors

Examples

local money = world.query("world.household.wealth", {page_size = 8, filters = {household_id = household_id}})

API history

1.0.0: Capability boundary reserved.
1.4.0: Physical Household money custody exposed for Phase 16D2.