query · world.settlement
Village life events
Returns newest-first partnership, separation, birth, immigration, emigration, and death facts derived from their authoritative owners.
world.settlement.life-events(filters?, cursor?, page_size?) -> query-page- Stable ID
world.settlement.life-events- Owner
- game.actor-runtime, game.relationship, game.household, game.settlement, and game.resource-economy
- Authority
- read_only
- Timing
- immediate
- Availability
- active-session
- Side effects
- none
- Determinism
- stable owner order at the current committed tick
- Introduced
- 1.11.0
Usage
Read retained partnership, birth, immigration, emigration, and death facts from their current gameplay owners for the normal village interface.
Parameters
- cursor: optional continuation cursor.
- page_size: bounded life-event row limit.
Returns
Newest-first detached life-event rows with the event kind, tick, primary Actor, optional related Actor and Household, and a direct summary.
Cost
One bounded Household, Relationship, and Actor traversal plus indexed Settlement, Resource wallet, and display-name lookups.
Fields
| ID | Type | Units | Required | Description |
|---|---|---|---|---|
actor_display_name | string | none | yes | Primary Actor display name. |
actor_id | stable-id | none | yes | Primary Actor identity. |
detail | string | none | yes | Direct player-facing event summary. |
household_id | stable-id-or-null | none | no | Related Household when present. |
kind | enumeration | none | yes | Partnership, separation, birth, immigration, emigration, or death. |
occurred_at_tick | unsigned-integer | ticks | yes | Retained event tick. |
related_actor_id | stable-id-or-null | none | no | Related Actor when present. |
Errors
error.capability-unavailableerror.invalid-queryerror.query-budget-exhaustederror.query-contract-violation
Examples
local events = world.query("world.settlement.life-events", {page_size = 3})API history
- 1.11.0: Family formation and population life events added for Village Life addendum E.