query · world.household

Household for actor

Returns detached household membership, strain, residence, and latest care facts for one actor.

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

Stable ID: world.household.for-actor
Owner: game.household
Authority: read_only
Timing: immediate
Availability: active-session
Side effects: none
Determinism: stable owner order at the current committed tick
Introduced: 1.3.0

Usage

Query one actor_id to inspect household identity, membership, strain, revision, assigned residence, and the latest retained meal or health-care result.

Parameters

filters.actor_id: required stable Actor identity.
cursor: optional continuation cursor.
page_size: bounded record limit.

Returns

One detached household record, or a stable unavailable result when the Actor has no loaded household.

Cost

One indexed Household lookup.

Fields

ID	Type	Units	Required	Description
`actor_id`	`stable-id`	none	yes	Actor identity.
`household_id`	`stable-id`	none	yes	Household identity.
`latest_care_kind`	`enumeration-or-null`	none	no	Latest retained meal or health-care kind.
`latest_care_recipient_id`	`stable-id-or-null`	none	no	Actor who received the latest retained care.
`latest_care_resource_id`	`stable-id-or-null`	none	no	Resource consumed by the latest retained care.
`latest_care_tick`	`unsigned-integer-or-null`	ticks	no	Tick when the latest retained care completed.
`latest_caregiver_id`	`stable-id-or-null`	none	no	Actor who completed the latest retained care.
`member_count`	`unsigned-integer`	none	yes	Current household member count.
`residence_building_id`	`stable-id-or-null`	none	no	Assigned residence building when present.
`revision`	`unsigned-integer`	none	yes	Household owner revision.
`strain`	`unsigned-integer`	basis-points	yes	Current household strain.

Errors

Examples

local household = world.query("world.household.for-actor", {page_size = 1, filters = {actor_id = selected_id}})

API history

1.3.0: Detached household membership query added for Phase 16D.
1.8.0: Latest care kind, caregiver, recipient, material, and completion tick added for Phase 17B.