lifecycle · lifecycle

suspend

Host-dispatched bounded package lifecycle callback.

suspend()

Stable ID: lifecycle.suspend
Owner: app.ScriptPackageHost
Authority: host_lifecycle
Timing: lifecycle
Availability: Phase 14E package manifests
Side effects: Lifecycle callbacks cannot submit gameplay commands.
Determinism: Dependency order; shutdown and suspension use reverse order.
Introduced: 1.0.0

Usage

Declare and implement lifecycle.suspend through the package manifest lifecycle table. Keep the callback bounded and use only the API capabilities available at that transition.

Parameters

None

Returns

No engine-owned gameplay value. Success or a Lua error determines whether the lifecycle transition commits.

Cost

Runs only at a bounded package lifecycle transition under host instruction and memory limits.

Fields

This symbol has no fields.

Errors

None

Examples

function suspend_package()
    -- Perform bounded package suspend work.
end