activate-scene
Make a scene the single active scene for all connected players, deactivating the prior scene and returning it so you can restore it later. GM-only; already-active scenes return a no-op status.
Instructions
ACTIVATE a scene — make it the one active scene, which is where connected clients land and where users log in. Foundry allows exactly ONE active scene world-wide, so this deactivates whatever was active; the previous scene is reported back so you can put it back. Activating an already-active scene is a no-op and says so (alreadyActive) rather than pretending it did something. Kept separate from update-scene (which is scene-DOCUMENT-only and never activates) because this changes every connected player's screen. To move only SOME players, leave the active scene alone and use pull-users-to-scene instead. GM-only.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sceneIdentifier | Yes | Scene id or exact name to make the active scene. STRICT — no fuzzy matching. |