Update scene
update-sceneUpdate an existing Foundry VTT scene: change its name, navigation label, background, size, folder, navigation state, or linked scene journal.
Instructions
Change an existing scene: name, navigation label, background image or video, background colour, size, folder, navigation, or the linked scene journal. A new background without width and height is measured and the scene takes its size. An empty journalIdentifier removes the link. Every change is read back.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"sceneIdentifier": "<sceneIdentifier>"
},
"name": "update-scene"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | New name; the navigation label follows unless navName is given | |
| width | No | ||
| height | No | ||
| navName | No | New label in the navigation | |
| background | No | New background path inside the Foundry data directory | |
| folderPath | No | Move into this folder path; empty for no folder | |
| navigation | No | ||
| backgroundColor | No | Colour around the artwork, as hex like "#000000" | |
| journalPageName | No | Page of that journal to open, by id or exact name | |
| sceneIdentifier | Yes | Id or name of the scene. A name matches exactly, or in any case when only one scene has it. | |
| journalIdentifier | No | Journal linked as the scene journal (shown by Foundry for the scene, unlike a note on the map), by id or name. An empty string removes the link. |