query · developer.capacity-policy
Current capacity policy
Returns the current scenario capacity limits, observed use, and policy revision.
developer.capacity-policy.current(filters?, cursor?, page_size?) -> query-page- Stable ID
developer.capacity-policy.current- Owner
- app.scenario-capacity-policy
- Authority
- read_only
- Timing
- immediate
- Availability
- active-session
- Side effects
- none
- Determinism
- stable owner order at the current committed tick
- Introduced
- 1.2.0
Usage
Read current population, resource, per-container, and aggregate-storage limits, use, and revision.
Parameters
- filters: none.
- cursor: zero.
- page_size: bounded record limit.
Returns
One detached capacity-policy record.
Cost
One bounded query and owner visit.
Fields
| ID | Type | Units | Required | Description |
|---|---|---|---|---|
container_capacity_limit | unsigned-integer | resource-units | yes | Maximum permitted capacity of one inventory container. |
largest_container_capacity | unsigned-integer | resource-units | yes | Largest observed inventory-container capacity. |
population_limit | unsigned-integer | actors | yes | Maximum permitted live population. |
population_usage | unsigned-integer | actors | yes | Observed live population. |
resource_units_limit | unsigned-integer | resource-units | yes | Maximum permitted aggregate resource quantity. |
resource_units_usage | unsigned-integer | resource-units | yes | Observed aggregate resource quantity. |
revision | unsigned-integer | none | yes | Current capacity-policy revision. |
storage_capacity_limit | unsigned-integer | resource-units | yes | Maximum permitted aggregate inventory capacity. |
storage_capacity_usage | unsigned-integer | resource-units | yes | Observed aggregate inventory capacity. |
Errors
error.capability-unavailableerror.invalid-queryerror.query-budget-exhaustederror.query-contract-violation
Examples
local result = world.query("developer.capacity-policy.current", {page_size = 1})API history
- 1.2.0: Capacity-policy query added.