command · restricted.capacity-policy

Set capacity-policy limit

Requests one revision-checked scenario capacity-limit change from a development package.

restricted.capacity-policy.set-limit(policy_id, value, expected_revision) -> command.receipt

Stable ID: restricted.capacity-policy.set-limit
Owner: app.scenario-capacity-policy
Authority: restricted_request
Timing: fixed_tick
Availability: active-session
Side effects: may change one scenario capacity limit without changing current owner state
Determinism: record request and owner result in engine sequence order; successful changes apply at the requested fixed tick
Introduced: 1.2.0

Usage

Submit one registered limit with the current policy revision.

Parameters

policy_id: registered identity.
value: unsigned limit.
expected_revision: current revision.

Returns

A command receipt.

Cost

One bounded command and owner validation.

Fields

ID	Type	Units	Required	Description
`expected_revision`	`revision`	none	yes	Expected scenario capacity-policy revision.
`policy_id`	`string`	none	yes	Registered scenario capacity-policy identity.
`value`	`unsigned-integer`	none	yes	Requested capacity limit.

Errors

Examples

local receipt = restricted.command.submit("restricted.capacity-policy.set-limit", {policy_id = "population.maximum-live-actors", value = 25000, expected_revision = current.revision}, 1)

API history

1.2.0: Revision-checked capacity command added.