{"id":1399,"date":"2017-02-09T00:10:19","date_gmt":"2017-02-09T00:10:19","guid":{"rendered":"http:\/\/spaceengine.org\/?page_id=1399"},"modified":"2021-03-15T15:58:30","modified_gmt":"2021-03-15T15:58:30","slug":"scenario-scripts","status":"publish","type":"page","link":"https:\/\/spaceengine.org\/manual\/making-addons\/scenario-scripts\/","title":{"rendered":"Scenario scripts"},"content":{"rendered":"

[vc_row row_type=\"row\" use_row_as_full_screen_section=\"no\" type=\"full_width\" text_align=\"left\" box_shadow_on_row=\"no\"][vc_column][no_accordion active_tab=\"1\" collapsible=\"yes\" background_transparency=\"no\" style=\"boxed_toggle\"][no_accordion_section title=\"SCENARIO SCRIPTS\" accordion_type=\"accordion_icon\" icon_pack=\"font_elegant\" fe_icon=\"icon_cog\"][vc_column_text]<\/p>\n

Scenario scripts were introduced in SpaceEngine 0.990. Older versions does not supports scripts.<\/b><\/p>\n

This manual describes how to make scenario scripts in SpaceEngine. Before continuing, it is recommended to read this manual: Introduction<\/a><\/p>\n

SpaceEngine console and *.se files<\/h4>\n

SpaceEngine 0.990 introduced a new type of file \u2013 *.se<\/span>. These are scenario script files. They contains code which can be executed by SpaceEngine. A great example of what scenarios are capable of are Tutorials, introduced in 0.990. The default location for *.se<\/span> files is data\/scripts\/<\/span> or addons\/*\/scripts\/<\/span>. You can run an *.se<\/span> file from SpaceEngine by opening the console ([~] key by default) and typing this command:<\/p>\n

\n
Code<\/div>\n
run filename\n<\/div>\n<\/div>\n

If the file filename.se<\/span> exists in the mentioned folders, it will be executed. Another way to run *.se<\/span> files is by passing them into SpaceEngine\u2019s executable through a command line argument. The best way to do that is to associate the *.se<\/span> extension with SpaceEngine.exe<\/span> in your system. In that case double-clicking on the file will launch SpaceEngine and order it to execute the scenario script. If SpaceEngine is already running, this running instance will execute the script.<\/p>\n

All commands could be executed in the 'direct mode' by typing them in the console, or executed from a *.se<\/span> script file. Commands and most of their parameters are not case-sensitive, but string constants such as names of GUI widgets and names of triggers are case-sensitive.<\/p>\n

Some commands can have (or even must have) additional parameters, provided in the curly braces block (i.e. those commands are actually tags<\/i>). Example:<\/p>\n

\n
Code<\/div>\n
Goto
\n{<\/p>\n
\nTime 5.5
\nDist 25000<\/div>\n

}\n<\/p><\/div>\n<\/div>\n

Additional parameters could be typed in a single row:<\/p>\n

\n
Code<\/div>\n
Goto { Time 5.5 Dist 25000 }\n<\/div>\n<\/div>\n

Using the single-row style sometimes makes the script code more compact and easy to read and understand.<\/p>\n

All commands are split into groups according to their functions. Unroll the blocks below to read details.<\/p>\n

[\/vc_column_text][\/no_accordion_section][no_accordion_section title=\"SCRIPT CONTROL COMMANDS\" accordion_type=\"accordion_icon\" icon_pack=\"font_elegant\" fe_icon=\"icon_cog\" el_id=\"lowtabtitle\"][vc_column_text]<\/p>\n

Run<\/h4>\n

Runs a *.se<\/span> script. It is possible to run one script from another, up to 16 nested calls are allowed. This is useful for executing a common set of commands, or to add a camera spline path from another script file (see the Camera spline path<\/span> chapter for details). Syntax:
\nRun filename<\/span> - executes the filename.se<\/span> script file located in the data\/scripts\/<\/span> or addons\/*\/scripts\/<\/span> folder.
\nRun \"path\/filename.sc\"<\/span> - executes the script file located at the provided path. Path is relative to SpaceEngine's folder.<\/p>\n

Break<\/h4>\n

Interrupts the currently executed script. If there was multiple scripts running, they will all be interrupted. Used primarily in direct mode (from the console) to break the script, but could be called from the *.se<\/span> file.<\/p>\n

Wait<\/h4>\n

Delays script execution by specified time in seconds. Syntax:
\nWait 3.5<\/span> - delays script by 3.5 seconds.
\nThis is one of the most useful command in SE scripts. You will use it after many commands, which require delays before the next command. For example, when you call the Goto<\/span> command with parameter Time 10<\/span> (duration of the flight - 10 seconds), you probably want to follow it by Wait 10<\/span> to delay the script execution until the Goto<\/span> command completes.<\/p>\n

CheckVersion<\/h4>\n

Checks if the current version of SpaceEngine corresponding the version number provided in the command. If not, the following error message will be displayed to the user: \"This script was designed for a different version of SpaceEngine. It cannot be run in the current version, sorry\". Syntax:
\nCheckVersion 990<\/span> - for SE version 0.990<\/p>\n

if, elif, else, endif<\/h4>\n

This is the conditional operator statement. Syntax:
\nif { Variable == 1.0 }<\/span><\/p>\n

if_commands<\/span><\/div>\n

elif { Variable >= 2.0 }<\/span><\/p>\n

elif_commands<\/span><\/div>\n

else<\/span><\/p>\n

else_commands<\/span><\/div>\n

endif<\/span>
\nThe Variable<\/span> is a name of SpaceEngine variable (see Variables<\/span> chapter for details). The ==<\/span> is a comparison operator, possible operators are:
\n==<\/span> (equal)
\n!=<\/span> (not equal)
\n<<\/span> (less)
\n><\/span> (greater)
\n<=<\/span> (not greater)
\n>=<\/span> (not less)
\nThe value to the right of the operator is numerical for the integer, float and double variables, or 0<\/span>\/1<\/span> or true<\/span>\/false<\/span> for boolean variables (see Variables<\/span> chapter for details).
\nIf the first condition (after if<\/span>) is satisfied, then all the if_commands<\/span> will be executed; after that control will be given to the first command after endif<\/span>.
\nIf the first condition is not satisfied, then control will be given to the first elif<\/span>, if present, or to the else<\/span>, if present, otherwise to the first command after endif<\/span>. The elif<\/span> statement works like if<\/span>: if condition is satisfied, then all the elif_commands<\/span> will be executed; after that control will be given to the first command after endif<\/span>. Otherwise control will be given to the next elif<\/span> or else<\/span>, if they are present, otherwise - to the first command after endif<\/span>. So you may use multiple elif<\/span> statements. They can have conditions for other variables than if<\/span>, statements are fully independent.
\nIf the else<\/span> statement is present and neither of the if<\/span> and\/or elif<\/span> conditions were satisfied, all the else_commands<\/span> will be executed, and after that control will be given to the first command after endif<\/span>.
\nCurly braces for the conditions and the endif<\/span> are mandatory, otherwise the \"Syntax error\" message will be shown. The elif<\/span> and else<\/span> statements are optional.
\nImportant<\/span>: nested if<\/span> statement is not yet supported, i.e. you cannot do something like this:
\nif { Var1 == 1 } if { Var2 == 0 } command endif endif<\/span>.
\nThe error message \"Nested IF statement is not supported\" will be shown in this case.<\/p>\n

Loop, EndLoop<\/h4>\n

This is a simple loop statement. Syntax:
\nLoop<\/span><\/p>\n

commands<\/span><\/div>\n

EndLoop<\/span>
\nThis repeats all commands enclosed between the Loop<\/span> and EndLoop<\/span> infinitely. Use Wait<\/span> command there to delay execution.<\/p>\n

[\/vc_column_text][\/no_accordion_section][no_accordion_section title=\"CAMERA CONTROL COMMANDS\" accordion_type=\"accordion_icon\" icon_pack=\"font_elegant\" fe_icon=\"icon_cog\" el_id=\"lowtabtitle\"][vc_column_text]<\/p>\n

FOV<\/h4>\n

Sets field-of-view in degrees. Syntax:
\nFOV 90<\/span><\/p>\n

Select<\/h4>\n

Selects a space object, ship, waypoint or spline path. Equivalent of a mouse click on the object, selecting it using search tool, etc. If the command succeeds, the selection pointer will be switched to the selected object. If the command fails, an error message will be shown in the console, and further execution of the scenario could be wrong. Syntax:
\nSelect Earth<\/span> - selects a space object by its name. Quotes can be skipped if there are no spaces in object's name.
\nSelect \"RS 8474-2738-5-27954-210 1\"<\/span> - selects a space object by its name. Use quotes if there are spaces in the object's name.
\nSelect \"Waypoint 1\"<\/span> - selects a previously defined waypoint (see Waypoint<\/span>).
\nSelect \"Path 1\"<\/span> - selects a previously defined spline path (see SplinePath<\/span>).
\nTo resolve name ambiguity, prepend object's name with its parent name, separated by |. For example:
\nSelect \"Saturn|Pandora\"<\/span> - selects Pandora (satellite of Satrun)
\nSelect \"Sol|Pandora\"<\/span> - selects asteroid (55) Pandora.<\/p>\n

Unselect<\/h4>\n

Removes any selection. The selection pointer will disappear.<\/p>\n

Goto<\/h4>\n

Moves the camera to the selection. If there is no object selected, an error message will be shown in the console, and further execution of the scenario could be wrong. Syntax:
\nGoto<\/span> - starts a flight with default parameters.
\nGoto { ... }<\/span> - starts a flight with custom parameters provided below:
\n{<\/span><\/p>\n

\nTime 15.0<\/span> - duration of the flight in seconds; default is 2.
\nAccelTime 2.0<\/span> - duration of acceleration phase in seconds; default is Time\/2<\/span>.
\nDecelTime 2.0<\/span> - duration of deceleration phase in seconds; default is Time\/2<\/span>.
\nDriftTime 10.0<\/span> - duration of constant speed phase in seconds; default is 0.
\nAccelPower 2.0<\/span> - steepness of acceleration; default is determined by the parameter GotoSpeed or GotoSpeedVR in the config file.
\nDecelPower 2.0<\/span> - steepness of deceleration; default is determined by the parameter GotoSpeed or GotoSpeedVR in the config file.
\nDist 0.001<\/span> - stop point distance from the target in pc; no default.
\nDistKm 12500.0<\/span> - stop point distance from the target in km; no default.
\nDistRad 2.5<\/span> - stop point distance from the target in multiples of the target's radii; default depends of object type, 2 for planets.
\nHeightKm 150.0<\/span> - stop point height from the target in km; no default.
\nLon 86.4<\/span> - stop point longitude in degrees; no default.
\nLat 13.5<\/span> - stop point latitude in degrees; no default.
\nLon 86 25 13<\/span> - stop point longitude in degrees minutes seconds; no default.
\nLat 13 30 29<\/span> - stop point latitude in degrees minutes seconds; no default.
\nLon ( 86 25 13 )<\/span> - stop point longitude in degrees minutes seconds; no default.
\nLat ( 13 30 29 )<\/span> - stop point latitude in degrees minutes seconds; no default.
\nUp 0.871, 0.124, -0.355<\/span> - stop point up vector; no default.
\nUp ( 0.871, 0.124, -0.355)<\/span> - stop point up vector; no default.
\nYaw 60.3<\/span> - stop point yaw Euler angle in degrees; no default.
\nPitch 21.6<\/span> - stop point Pitch angle in degrees; no default.
\nRoll 35.5<\/span> - stop point Roll angle in degrees; no default.
\nCenter false<\/span> - do not rotate camera to the target; default is true (do rotation).\n<\/div>\n

}<\/span>
\nIf Lon<\/span> and\/or Lat<\/span> are provided, the end point binding mode will be \"SyncRot\".
\nIf no stop-point rotation-parameters were provided, the camera will end up rotated towards the center of the selected object.
\nIf selection is a spline path, camera will go to its first knot point position and change its orientation to the first knot point orientation.
\nIf you want to instantly \"teleport\" to the selection, use Time 0<\/span>.
\nIf you want to end the flight with the camera looking straight at the object, don't specify any orientation parameters, or use Yaw 0 Pitch -90 Roll 0<\/span>.
\nImportant<\/span>: the next script command will be executed immediately after this one. You must follow this command with the Wait<\/span> command, with wait time equal to those in the Time<\/span> parameter.<\/p>\n

Center<\/h4>\n

Starts a turn toward the selection. If there is no object selected, an error message will shown in the console, and further execution of the scenario could be wrong. Syntax:
\nCenter<\/span> - starts a turn with default parameters.
\nCenter { ... }<\/span> - starts a turn with custom parameters provided below:
\n{<\/span><\/p>\n

\nTime 15.0<\/span> - duration of the turn in seconds; default is 2.\n<\/div>\n

}<\/span>
\nImportant<\/span>: the next script command will be executed immediately after this one. You must follow this command with the Wait<\/span> command, with wait time equal to those in the Time<\/span> parameter.<\/p>\n

Horizon<\/h4>\n

Starts a turn toward the selection's horizon. If were no object selected, an error message will shown in the console, and further execution of the scenario could be wrong. Syntax:
\nHorizon<\/span> - starts a turn with default parameters.
\nHorizon { ... }<\/span> - starts a turn with custom parameters provided below:
\n{<\/span><\/p>\n

\nTime 15.0<\/span> - duration of the turn in seconds; default is 2.\n<\/div>\n

}<\/span>
\nImportant<\/span>: the next script command will be executed immediately after this one. You must follow this command with the Wait<\/span> command , with wait time equal to those in the Time<\/span> parameter.<\/p>\n

GotoLocation<\/h4>\n

Immediately moves (teleports) the camera to the specified location. Depending on the complexity of the location scene, loading may take a while. You may use FadeOut\/FadeIn<\/span> combined with WaitTrigger \"LoadingComplete\"<\/span> to hide the loading process. If the current SpaceEngine version differs from the version number specified in the location code, a warning message will be shown to the user. of Syntax:
\nGotoLocation \"Volcano under rings\"<\/span> - go to a location from the Locations browser (F6 menu).
\nGotoLocation \"Location name\" { ... }<\/span> - go to a location, whose code is defined directly in the scenario script in the curly braces block. Always use this method if the location is not one of the default SE locations, otherwise your scenario will not work for other users. To generate the code, add a location in the Location browser, then press \"Share\" -> \"Copy script code to clipboard\", and paste the location code from the clipboard to the scenario script. Then change Place<\/span> to GotoLocation<\/span>
\nNote: the location saves the current stereobase (sense of a scale in 3D\/VR modes). You may use this fact to setup a custom stereobase when starting a scenario. Another way to setup the stereobase is using the Stereobase<\/span> variable (the command Set Stereobase XXXX<\/span>, see the Variables<\/span> chapter for details).<\/p>\n

GotoURL<\/h4>\n

Similar to GotoLocation<\/span>, but uses a location URL instead of code. If the current SpaceEngine version differs from the version number specified in the URL, a warning message will be shown to the user. Syntax:
\nGotoLocation \"se:\/\/v=981&m=1&n=%CB%F3%ED%E0%20%C3%...\"<\/span> - go to a specified location URL. Use this as a more compact alternative of the GotoLocation<\/span>. To generate the URL, add a location in the Location browser, then press \"Share\" -> \"Copy URL to clipboard\", and paste the location URL from the clipboard to the scenario script. Enclose it with quotes and add GotoURL<\/span> before it.<\/p>\n

Follow<\/h4>\n

Changes camera binding mode to \"Follow\": the camera moves together with the selected object's center, i.e. ignoring its rotation. If a new object is selected, the currently followed object changes to that object, otherwise only the binding mode changes.<\/p>\n

SyncRot<\/h4>\n

Changes camera binding mode to \"SyncRot\": the camera moves together with the selected object's surface, i.e. keeps itself in rest relative to selection's rotating surface. If a new object is selected, the currently followed object changes to that object, otherwise only binding mode changes.<\/p>\n

Free<\/h4>\n

Changes camera binding mode to \"Free\": no binding to any object, camera stays at rest in space. The currently followed object clears.<\/p>\n

Track<\/h4>\n

Enables tracking the selected object: camera rotates so that the tracking object stays in the center of the screen. Changing the selected object will not affect tracking.<\/p>\n

Untrack<\/h4>\n

Disables tracking mode.<\/p>\n

MoveMode<\/h4>\n

Changes camera motion mode (free\/spacecraft\/aircraft). Syntax:
\nMoveMode 2<\/span>
\nPossible values:
\n1<\/span> - free mode (no inertia, flight direction follows the orientation);
\n2<\/span> - spacecraft mode (motion and rotation inertia, flight direction is independent of orientation);
\n3<\/span> - aircraft mode (motion and rotation inertia, flight direction follows the orientation).<\/p>\n

Speed<\/h4>\n

Sets assigned camera speed in parsecs per second. Syntax:
\nSpeed 2.5<\/span> - set a speed of 2.5 pc\/s in the Spectator motion mode, otherwise acceleration<\/i> of 0.25 pc\/s2<\/sup> will be set (in modes with inertia - Spacecraft and Aircraft).<\/p>\n

SpeedKm<\/h4>\n

Sets assigned camera speed in kilometers per second. Syntax:
\nSpeedKm 123.4<\/span> - set a speed of 123.4 km\/s in the Spectator motion mode, otherwise acceleration<\/i> of 0.01234 km\/s2<\/sup> will be set (in modes with inertia - Spacecraft and Aircraft).<\/p>\n

Fly<\/h4>\n

Starts camera moving in a view direction. Syntax:
\nFly<\/span> - starts moving with default parameters.
\nFly { ... }<\/span> - starts moving with custom parameters provided below:
\n{<\/span><\/p>\n

\nAxis (0, 0.707, 0.707)<\/span> - motion direction vector, relative to the current camera orientation; default is (0, 0, 1) - flying forward.
\nSpeed 5.5<\/span> - motion speed in parsecs per second; no default.
\nSpeedKm 17.6<\/span> - motion speed in kilometers per second; default is 100.
\nFadeTime 1.5<\/span> - smooth start duration in seconds; default is 2.
\nFunc \"Cubic\"<\/span> - smooth start function; default is \"Linear\", possible values: \"Linear\", \"Quadric\", \"Cubic\", \"Sin\".\n<\/div>\n

}<\/span>
\nImportant<\/span>: the next script command will be executed immediately after this one. You must follow this command with the Wait<\/span> command, with some wait time to see the motion effect.<\/p>\n

StopFly<\/h4>\n

Smoothly stops camera motion in the motion modes that have inertia, or cancels out the Fly<\/span> command. Syntax:
\nStopFly<\/span>
\nStopFly { ... }<\/span> - starts moving with custom parameters provided below:
\n{<\/span><\/p>\n

\nFadeTime 1.5<\/span> - smooth stop duration in seconds; default is 2.
\nFunc \"Cubic\"<\/span> - smooth stop function; default is \"Linear\", possible values: \"Linear\", \"Quadric\", \"Cubic\", \"Sin\".\n<\/div>\n

}<\/span><\/p>\n

Turn<\/h4>\n

Starts turning (rotating) camera around its own axes. Syntax:
\nTurn<\/span> - starts turning with default parameters.
\nTurn { ... }<\/span> - starts turning with custom parameters provided below:
\n{<\/span><\/p>\n

\nAngularSpeed 45.0<\/span> - turn rate in degrees per second; default is 10.
\nAxis (0, 0.707, 0.707)<\/span> - axis around which turn occurs; default is (0, 1, 0) - vertical axis of the camera.
\nFadeTime 1.5<\/span> - smooth start duration in seconds; default is 2.
\nFunc \"Cubic\"<\/span> - smooth start function; default is \"Linear\", possible values: \"Linear\", \"Quadric\", \"Cubic\", \"Sin\".\n<\/div>\n

}<\/span>
\nImportant<\/span>: the next script command will be executed immediately after this one. You must follow this command with the Wait<\/span> command, with some wait time to see the motion effect.<\/p>\n

StopTurn<\/h4>\n

Cancels out the Turn<\/span> command. Syntax:
\nStopTurn<\/span> - stops orbiting with default parameters.
\nStopTurn{ ... }<\/span> - starts orbiting with custom parameters provided below:
\n{<\/span><\/p>\n

\nFadeTime 1.5<\/span> - smooth stop duration in seconds; default is 2.
\nFunc \"Cubic\"<\/span> - smooth stop function; default is \"Linear\", possible values: \"Linear\", \"Quadric\", \"Cubic\", \"Sin\".\n<\/div>\n

}<\/span><\/p>\n

Orbit<\/h4>\n

Starts circular motion ('orbiting') around selected object. Syntax:
\nOrbit<\/span> - starts orbiting with default parameters.
\nOrbit { ... }<\/span> - starts orbiting with custom parameters provided below:
\n{<\/span><\/p>\n

\nAngularSpeed 45.0<\/span> - orbiting rate in degrees per second; default is 10.
\nAxis (0, 0.707, 0.707)<\/span> - axis around which orbiting occurs; default is (0, 1, 0) - polar axis of an object.
\nFadeTime 1.5<\/span> - smooth start duration in seconds; default is 2.
\nFunc \"Cubic\"<\/span> - smooth start function; default is \"Linear\", possible values: \"Linear\", \"Quadric\", \"Cubic\", \"Sin\".\n<\/div>\n

}<\/span>
\nDuring orbiting, camera orientation changes in that way so the object remains static on the screen. Use the Goto\/GotoLocation\/GotoURL<\/span> commands before this one to set a proper initial orientation.
\nImportant<\/span>: the next script command will be executed immediately after this one. You must follow this command with the Wait<\/span> command, with some wait time to see the motion effect.<\/p>\n

StopOrbit<\/h4>\n

Cancels out the Orbit<\/span> command. Syntax:
\nStopOrbit<\/span> - stops orbiting with default parameters.
\nStopOrbit { ... }<\/span> - starts orbiting with custom parameters provided below:
\n{<\/span><\/p>\n

\nFadeTime 1.5<\/span> - smooth stop duration in seconds; default is 2.
\nFunc \"Cubic\"<\/span> - smooth stop function; default is \"Linear\", possible values: \"Linear\", \"Quadric\", \"Cubic\", \"Sin\".\n<\/div>\n

}<\/span><\/p>\n

UserMoveControl<\/h4>\n

Limits user movement ability. Sytax:
\nUserMoveControl \"disabled\"<\/span> - disables user's movement ability. Camera cannot be moved by user.
\nUserMoveControl \"free\"<\/span> - restores user's movement ability.
\nUserMoveControl \"limited\" { ... }<\/span> - limits user's movement ability by a some distance from the specified object, and\/or limits user movement speed:
\n{<\/span><\/p>\n

\nCenter \"Mars\"<\/span> - name of object, relative to which movement will be limited. Format is same as in the Select<\/span> command (prepend name with a parent object name and | to resolve naming ambiguity).
\nDist 0.1<\/span> - the greatest allowed movement distance from the object in parsecs.
\nDistLy 0.3<\/span> - the same in light years.
\nDistKm 10000<\/span> - the same in kilometers.
\nDistRad 2.5<\/span> - the same in object's radii.
\nSpeed 0.5<\/span> - maximum user movement speed in parsecs per second.
\nSpeedKm 500<\/span> - the same in kilometers per second.\n<\/div>\n

}<\/span>
\nYou can use either distance limiting or speed limiting, or both.<\/p>\n

UserRotationControl<\/h4>\n

Limits user rotation ability. Sytax:
\nUserRotationControl \"disabled\"<\/span> - disables user's rotation ability. Camera cannot be turned by user.
\nUserRotationControl \"free\"<\/span> - restores user's rotation ability.<\/p>\n

UserTimeControl<\/h4>\n

Limits user time control ability. Sytax:
\nUserTimeControl \"disabled\"<\/span> - disables user's time control ability. Simulation date\/time cannot be altered by user.
\nUserTimeControl \"free\"<\/span> - restores user's time control ability.
\nUserTimeControl \"limited\" { ... }<\/span> - limits user's time control ability by a specified date\/time range and\/or time speed range:
\n{<\/span><\/p>\n

\nTimeRange (\"2017.02.01 12:00:00\", \"2017.02.28 11:59:59\")<\/span> - date\/time range, array of two strings representing starting and ending dates, between which user is allowed to set the simulation time.
\nTimeRateRange (1.0, 10.0)<\/span> - time speed range, array of two floating-point nubmers representing minimum and maximum allowed time speed.\n<\/div>\n

}<\/span>
\nYou can use either time range limiting or time speed limiting, or both.<\/p>\n

UserStereobaseControl<\/h4>\n

Limits user stereobase control ability. Sytax:
\nUserStereobaseControl \"disabled\"<\/span> - disables user's stereobase control ability. 3D deteobase cannot be altered by user.
\nUserStereobaseControl \"free\"<\/span> - restores user's stereobase control ability.
\nUserStereobaseControl \"limited\" { ... }<\/span> - limits user's stereobase control ability by a specified range:
\n{<\/span><\/p>\n

\nRange (1.0, 1000.0)<\/span> - stereoabse range, array of two floating-point nubmers representing minimum and maximum allowed stereoabse.\n<\/div>\n

}<\/span><\/p>\n

[\/vc_column_text][\/no_accordion_section][no_accordion_section title=\"WAYPOINTS\" accordion_type=\"accordion_icon\" icon_pack=\"font_elegant\" fe_icon=\"icon_cog\" el_id=\"lowtabtitle\"][vc_column_text]<\/p>\n

Waypoints are a special 'virtual' objects that can be displayed to the user and used in the script. Waypoints can be selected with the Select<\/span> command using its name, then the Goto<\/span> or Center<\/span> command can be called to move\/rotate the camera to that waypoint. They also can be used with triggers to detect certain events, such as a reaching a specific point in space, by using the WaitTrigger \"Object|Approach\"<\/span> command. See the Triggers<\/span> chapter for details. Waypoint's name can contain abbreviations and BB codes, including the [LOC] code to make translations to other languages. The text label near the waypoint can be controlled independently from the waypoint itself (i.e. can be hidden, faded out, changed in color etc).<\/p>\n

Waypoint script commands<\/h5>\n

Waypoint<\/h4>\n

Adds (defines) a new waypoint, or modifies an existing one. If a waypoint with such name has been defined in the script previously, it will be updated with the provided data, otherwise a new waypoint will be added. Syntax:
\nWaypoint \"Name\" { ... }<\/span> - adds\/modifies a waypoint with name \"Name\", with parameters provided below:
\n{<\/span><\/p>\n

\nParent \"Pandora|Sol\"<\/span> - name of a parent object, i.e. object to which this waypoint is bound. It has the same format as in the Select<\/span> command (\"Parent|Object\").
\nVisible false<\/span> - is the waypoint visible to the user or not. Use false<\/span> to hide previously defined waypoint, and true<\/span> to show it again. Default is true<\/span>.
\nLabel true<\/span> - is the waypoint's label visible (text, equal to its Name). Default is true<\/span>.
\nRadius 0.25<\/span> - radius in parsecs.
\nRadiusKm 500.0<\/span> - radius in kilometers; default is 1.
\nRoll 45.0<\/span> - rotation angle of the waypoint model in degrees; default is 0.
\nColor (1.0, 0.8, 0.0, 0.6)<\/span> - color in (R, G, B, A) format (A is opacity); default is white - (1, 1, 1, 1).
\nColorEmpty (0.2, 0.2, 0.0, 0.6)<\/span> - color in the empty (non-filled) animation state in (R, G, B, A) format (A is opacity); default is transparent black - (0, 0, 0, 0).
\nLabelColor (1.0, 0.8, 0.0, 0.6)<\/span> - color of the text label in (R, G, B, A) format (A is opacity); default is equal to Color<\/span>, if specified.
\nFadeRange (10, 20, 900, 1000)<\/span> - distance range, at which the waypoint is visible, in parsecs. First two values in vector are distance range of smooth transition form invisible to visible state, last two values are distance range of back transition from visible to invisible. Default values are (1e38, 0, 0, 1e38) effectively disables transitions (makes waypoint visible at all distances).
\nFadeRangeKm (10, 20, 900, 1000)<\/span> - the same as FadeRange<\/span>, in kilometers.
\nLabelFadeRange (10, 20, 900, 1000)<\/span> - the same as FadeRange<\/span>, in parsecs, for waypoint's label.
\nLabelFadeRangeKm (10, 20, 900, 1000)<\/span> - the same as LabelFadeRange<\/span>, in kilometers, for waypoint's label.
\nLineWidth 10<\/span> - width of the line in pixels; default is 2.
\nShape \"Diamond\"<\/span> - shape of the waypoint which will be displayed to the user. Allowed shapes are: \"Circle\", \"Triangle\", \"Square\", \"Diamond\", \"Hexagon\", \"Billboard\", \"Sphere\", \"WireSphere\"<\/span>. The latter two are 3-dimensional. Default is \"Circle\"<\/span>.
\nStaticPosXYZ (1.0, 0.5, 0.7)<\/span> - static Cartesian coordinates (x, y, z) relative to the parent object in parsecs.
\nStaticPosXYZKm (110.5, 57.3, 16.7)<\/span> - static Cartesian coordinates (x, y, z) relative to the parent object in kilometers.
\nStaticPosPolar (32.9, 60.3, 1.65)<\/span> - static polar coordinates (latitude, longitude, distance) relative to the parent object; lat\/lon in degrees, distance in parsecs.
\nStaticPosPolarKm (32.9, 60.3, 7500.0)<\/span> - static polar coordinates (latitude, longitude, distance) relative to the parent object; lat\/lon in degrees, distance in kilometers.
\nFixedPosXYZ (1.0, 0.5, 0.7)<\/span> - fixed Cartesian coordinates (x, y, z) relative to the parent object in parsecs.
\nFixedPosXYZKm (110.5, 57.3, 16.7)<\/span> - fixed Cartesian coordinates (x, y, z) relative to the parent object in kilometers.
\nFixedPosPolar (32.9, 60.3, 1.65)<\/span> - fixed polar coordinates (latitude, longitude, distance) relative to the parent object; lat\/lon in degrees, distance in parsecs.
\nFixedPosPolarKm (32.9, 60.3, 7500.0)<\/span> - fixed polar coordinates (latitude, longitude, distance) relative to the parent object; lat\/lon in degrees, distance in kilometers.
\nTexture \"data\/textures\/common\/logo0990.*\"<\/span> - path to the image file for the billboard waypoint.
\nTexCoord (0.5, 0.5, 0.2, 0.5)<\/span> - texture coordinates in relative units: (x offset, y offset, width, height). Value of 0.5 means 50% of the texture dimension (width or height), 0.25 means 25% and so on. The specified area of the texture will be displayed. Default is (0, 0, 1, 1) - display the whole texture.
\nTexCoordPix (0.5, 0.5, 0.2, 0.5)<\/span> - texture coordinates in pixels: (x offset, y offset, width, height). The specified area of the texture will be displayed.\n<\/div>\n

}<\/span>
\nStatic coordinates are equivalent to the 'Follow' mode, while fixed coordinates are equivalent to the 'SyncRot' mode. In the first case, waypoint is bound to the parent object's center, i.e. moves together with the object, ignoring its rotation. In the second case, it moves and rotates together with the object, i.e. remains fixed relative to the object's surface.
\nWaypoint with shape \"Circle\" supports filling-like animation, when used with the WaitTrigger \"Object|See\" (see Triggers<\/span> for details). It starts as the circle of the color ColorEmpty<\/span>, and while user looking on it during the Delay<\/span> seconds (this is the trigger's parameter), it filling up clockwise with the color Color<\/span>.
\nWaypoint with shape \"Billboard\" is alpha-blended textured billboard (a rectangle always oriented to the user). Parameter Texture<\/span> specifies the image used to texture the billboard. If not specified or image file does not exist, the default 'No image' texture will be used. Parameters TexCoord<\/span> or TexCoordPix<\/span> specifies which part of the image to use. If not specified, the whole image will be displayed. Parameter Color<\/span> specifies color modulation of the texture and its alpha (opacity) channel.<\/p>\n

DeleteWaypoint<\/h4>\n

Deletes a previously added waypoint. Syntax:
\nDeleteWaypoint \"Name\"<\/span><\/p>\n

ClearWaypoints<\/h4>\n

Deletes all waypoints.<\/p>\n

[\/vc_column_text][\/no_accordion_section][no_accordion_section title=\"CAMERA SPLINE PATHS\" accordion_type=\"accordion_icon\" icon_pack=\"font_elegant\" fe_icon=\"icon_cog\" el_id=\"lowtabtitle\"][vc_column_text]<\/p>\n

The camera spline path is a powerful tool to make custom flybys. Using the Camera path editor, you can 'record' your manual flight, and save it to a script file for a further use. This includes:<\/p>\n

- replaying a recorded path in the Camera path editor;
\n- replaying a recorded path while simultaneously capturing video in a high quality rendering mode (offline video rendering);
\n- replaying a recorded path in a script using the PlaySplinePath<\/span> command.<\/p>\n

Spline<\/i> is a mathematical function which is used for a smooth interpolation of some value (in SpaceEngine, camera coordinates and orientation) between a discrete number of data points, called knots<\/i>. In other words, you may have, say, only 50 knots - data points which represents fixed position and orientation in space - and perform a smooth movement between them. This is a very compact and convenient way to record a flights.<\/p>\n

Spline path script commands<\/h5>\n

SplinePath<\/h4>\n

Adds (defines) a camera spline path. Syntax:
\nSplinePath \"SplineName\" { ... }<\/span> - adds a spline path with a name \"SplineName\" with parameters provided below:
\n{<\/span><\/p>\n

\nBody \"PI Hya 7\"<\/span> - name of a reference object.
\nParent \"PI Hya\"<\/span> - name of a reference object's parent.
\nSyncRot true<\/span> - spline path binding mode: SyncRot if true, Follow if false.
\nDuration 52.0<\/span> - replay duration in seconds.
\nPosSpline \"Catmull-Rom\"<\/span> - a type of position interpolation spline.
\nRotSpline \"B-spline\"<\/span> - a type of orientation interpolation spline.
\nFollowQuat (1, 0, 0, 0)<\/span> - initial camera orientation in the Follow binding mode.
\nSplineData { ... }<\/span> - array of knot points: multiple lines in the form of (time, pos.x, pos.y, pos.z, rot.w, rot.x, rot.y, rot.z), enclosed in a curly braces.\n<\/div>\n

}<\/span>
\nYou may type all the data points into the SplineData { }<\/span> tag manually, but using the Camera path editor is a more convenient way.<\/p>\n

DeleteSplinePath<\/h4>\n

Deletes a camera spline path. Syntax:
\nDeleteSplinePath \"SplineName\"<\/span><\/p>\n

ClearSplinePaths<\/h4>\n

Deletes all camera spline paths. Syntax:
\nClearSplinePaths<\/span><\/p>\n

PlaySplinePath<\/h4>\n

Starts flight through the spline path. Syntax:
\nPlaySplinePath \"SplineName\"<\/span> - starts flight through the spline path \"SplineName\" with default parameters.
\nPlaySplinePath \"SplineName\" { ... }<\/span> - starts flight through the spline path \"SplineName\" with custom parameters provided below:
\n{<\/span><\/p>\n

\nTime 30.0<\/span> - overrides the flight duration; default value is a spline duration described in the SplinePath<\/span> command.\n<\/div>\n

}<\/span>
\nSeeing as the camera is being teleported to the first spline's knot point and starts smooth moving through other knot points, it is a good idea to smoothly move the camera to the first knot point before calling this command. To do this, use the Goto \"SplineName\"<\/span> command.
\nImportant<\/span>: the next script command will be executed immediately after this one. You must follow this command with the Wait<\/span>, with a wait time equal to the Time<\/span> parameter of the spline path duration, to delay the execution of the next commands until the spline flight completes. Other commands may be executed during the spline flight, except commands which change the camera position\/orientation.<\/p>\n

Using the Camera path editor<\/h5>\n

Open the Camera path editor in the Main menu > Editor menu. Configure the path parameters: its name, types of splines, how often to add a knot point. Start recording a path by pressing the [Record] (red round) button; when done, stop recording by pressing the [Stop] (white square) button. You may visualize the recorded path by ticking the 'Display path curve', and replay it by pressing the [Play] (white triangle) button. It is possible to add knot points manually while recording .<\/p>\n

\"\"<\/a><\/p>\n

In the current version of SpaceEngine, it is impossible to edit the recorded spline, but this functionality will be added in future. You may only change the spline type and replay duration.<\/p>\n

Once completed, save the file to the desired directory, for example addons\/my_addon\/scripts\/path.ssp<\/span>. The saved file is a usual SE scenario script file, which contains only one command SplinePath<\/span> with some parameters and data points. It has the *.ssp<\/span> extension just to distinguish it from a usual script files *.se<\/span> in the open\/save file dialog. You may use this file further, either to it load back into the editor, or to replay the recorded path from another script. There are two ways to achieve this:<\/p>\n

- simply open the saved file, copy its content and paste into your script;
\n- call the script file with a recorded path from your script using the Run<\/span> command:<\/p>\n

\n
Code<\/div>\n
Run \"path.ssp\"\n<\/div>\n<\/div>\n

After defining the spline path in the script by one of these methods, you may replay it by the PlaySplinePath<\/span> command:<\/p>\n

\n
Code<\/div>\n
PlaySplinePath \"PathName\"\n<\/div>\n<\/div>\n

Here \"PathName\" is the same name used in the SplinePath<\/span> command (either in the *.ssp<\/span> file or directly in your script). It is a good idea to smoothly move camera to the first spline's knot point before starting the replay. Use the Goto \"PathName\"<\/span> to do this.<\/p>\n

The spline path is bound to some space object. By default, it is the same object that is bound to the camera when you started recording the path. It has two binding modes: Follow and SyncRot. In the Follow mode, spline moves together with the object, ignoring its rotation. In the SyncRot, it moves and rotates together with the object, i.e. remains fixed relative to the object's surface. The first is useful for a deep-space path recording, while the second is best for flights above the planetary terrain. You may switch modes by the 'SyncRot' checkbox in the Camera path editor.<\/p>\n

You may set any custom date\/time and speed up the time flow during path replay (either manually or by the time control script commands), and this will not affect the motion of the camera relative to the object or its surface. This is useful for making a 'timelapse' effect.<\/p>\n

Usage of the Camera path editor and recording a video with it is summarized in this video. Note that it may be out of date; the tools shown in your version of SpaceEngine are likely much more advanced.<\/p>\n