Description
Creates a script which can be used to recreate the current scene in Shogun Post.
Use createSceneScript to output a Shogun Post script, saving out the current scene modules and animation.
The generated output script can be run to recreate the exact scene that was saved out, or the script can be edited and used for more generic automatic creation of scene elements. The command can be run with a number of arguments to determine what is contained in the output script. For example, using the –defaultOnly flag, modules can be output into the script with no animation.
The output script can be written to a file or to the Script Editor. If the command is run with no arguments then the output script file will be written to the default path. (typically C:\Users\Public\Documents\Vicon\ShogunPost#.#).
Functional area
System
Command syntax
Syntax
createSceneScript [-file string] [-interface] [-defaultOnly] [-curTimeOnly] [-playRangeOnly] [-activeClipOnly] [-selectedOnly] [-relativeTime] |
Arguments
None
Flags
ERROR
The requested URL could not be retrieved
The following error was encountered while trying to retrieve the URL: https://scroll-exporter-extensions.de.exporter.k15t.app/*
Unable to forward this request at this time.
This request could not be forwarded to the origin server or to any parent caches.
Some possible problems are:
- An Internet connection needed to access this domains origin servers may be down.
- All configured parent caches may be currently unreachable.
- The administrator may not allow this cache to make direct connections to origin servers.
Your cache administrator is webmaster.
Generated Wed, 02 Apr 2025 08:41:11 GMT by ip-10-19-3-88 (squid)
| Name | Flag arguments | Argument type | Exclusive to | Comments |
|---|---|---|---|---|
file | 1 | string | — | Writes the output script to a given file path. |
interface | 0 | — | — | Writes the output script to the Script Editor panel. |
defaultOnly | 0 | — | curTimeOnly, playRangeOnly, activeClipOnly, relativeTime | Creates a script with module information only. No animation data is saved. |
curTimeOnly | 0 | — | defaultOnly, playRangeOnly | Animation data is saved in the script from the current frame only. |
playRangeOnly | 0 | — | curTimeOnly, defaultOnly | Animation data is saved in the script from the play range only. Otherwise data is saved from the animation range. |
activeClipOnly | 0 | — | defaultOnly | Animation data is saved from the active clip only. Otherwise all clips are saved in the script. |
selectedOnly | 0 | — | — | Only selected modules are saved in the script. Animation data for those modules will be saved unless the defaultOnly flag is also used. |
relativeTime | 0 | --- | defaultOnly | The output script will ensure that when it is run, any animation data will start at the current frame. |
Return value
void
ERROR
The requested URL could not be retrieved
The following error was encountered while trying to retrieve the URL: https://scroll-exporter-extensions.de.exporter.k15t.app/*
Unable to forward this request at this time.
This request could not be forwarded to the origin server or to any parent caches.
Some possible problems are:
- An Internet connection needed to access this domains origin servers may be down.
- All configured parent caches may be currently unreachable.
- The administrator may not allow this cache to make direct connections to origin servers.
Your cache administrator is webmaster.
Generated Wed, 02 Apr 2025 08:41:11 GMT by ip-10-19-3-22 (squid)
Examples
//save out a script to recreate the current Shogun Post scene
createSceneScript –file "c:/scene1.hsl";
//save out a script to recreate the current Shogun Post scene
// with no animation
createSceneScript –file "c:/scene2.hsl" –defaultOnly;
//save out a script to recreate the currently selected modules
//for the play range only
createSceneScript –file "c:/scene3.hsl" –selectedOnly –playRangeOnly;
