Scenario
There are a number of Connect commands available for the scenario or all objects in the scenario.
Since only one scenario can be open at any given time in STK, you can substitute the scenario name with a wildcard (*) so that the <ObjectPath> is Scenario/* or just *. For example, you could type Scenario/* for Scenario/stkDemo, where * refers to the scenario loaded.
| Command | Format | Description | Version |
|---|---|---|---|
| ADFLoad | ADFLoad <ApplicationPath> <Parameters> | Load a VDF or STK file from the ADF into STK (Deprecated Command) | 10 |
| ADFSave | ADFSave <ApplicationPath> <ObjectPath> "<ServerFilePath>" [<Options>] | Save or check in a VDF or STK object to the ADF (Deprecated Command) | 10 |
| AllInstanceNames | AllInstanceNames <ApplicationPath> [IncludeAccess] [<Delimiter>] | Identify all <ObjectPaths> within the current scenario | 11 |
| CalculationTool | CalculationTool <ScenarioPath> {Options} | Define coordinate systems and elements used in constructing them, including templates. | 10.1.1 |
| CalculationTool Condition | CalculationTool <ScenarioPath> <ParentObject> {Action} {"Condition" | "ConditionTemplate"} <ComponentName> [{ConditionType} <TypeParams>] | Define and modify Condition components and templates. | 11.2 |
| CalculationTool Condition Set | CalculationTool <ScenarioPath> <ParentObject> {Action} {"Condition Set" | "Condition SetTemplate"} <ComponentName> [{ConditionType} <TypeParams>] | Define and modify Condition Set components and templates. | 10.1 |
| CalculationTool Parameter Set | CalculationTool <ScenarioPath> <ParentObject> {Action} {"Parameter Set" | "Parameter SetTemplate"} <ComponentName> [{ParameterSetType} <TypeParams>] | Define and modify Parameter Set components and templates. | 10 |
| CalculationTool Scalar Calculation | CalculationTool <ScenarioPath> <ParentObject> {Action} {"Scalar Calculation" | "Scalar CalculationTemplate"} <ComponentName> [{ScalarCalculationType} <TypeParams>] | Define and modify Scalar Calculation components and templates. | 11.2 |
| CalculationTool_R | CalculationTool_R <ScenarioPath> {Option} [<Parameters>] | Return information about CalculationTool components. | 11 |
| CalculationTool_RM | CalculationTool_RM <ScenarioPath> {Option} [<Parameters>] | Return information about CalculationTool components. | 10.1 |
| CentralBody_R | CentralBody_R <ApplicationPath> <ObjectPath> | Returns the name of the central body of any object | 10.0.2 |
| CheckIsAppBusy | CheckIsAppBusy <ApplicationPath> | Determine the busy state of the STK application. | 9.0 |
| CheckScenario | CheckScenario <ApplicationPath> | Determine if a scenario is open in the current STK session | 4.0.2 |
| Convert CBPosition | Convert <ScenarioPath> CBPosition {Planetodetic | Planetocentric} {CentralBodyName} <Latitude> <Longitude> {<Altitude> | <Radius>} | Convert a planetodetic position to/from a planetocentric position. | 6.1 |
| Convert MapGridPoint | Convert <ScenarioPath> MapGridPoint {FromMapGridSpec} {PointDef} {ToMapGridSpec} | Convert a map point between Latitude/Longitude and UTM. | 6.2 |
| Convert OrbitPointMotion | Convert <ScenarioPath> OrbitPointMotion [Precision <Value>] {FromElementsType} <Elements> {ToElementsType} | Perform orbit element conversions. | 10.1 |
| ConvertDate | ConvertDate <ScenarioPath> {InputFormat} {OutputFormat} "<DateTime>" | Convert a date from one format to another. (Deprecated Command) | 10.1 |
| ConvertUnit | ConvertUnit <ScenarioPath> {Dimension} {InputUnitID} {OuputUnitID} <InputValue> | Convert a value from one unit to another. (Deprecated Command) | 10.1 |
| CreateTLEFile | CreateTLEFile <ScenarioPath> {Source} "<TLEFilePath>" [{Options}] {SearchParameters} | Creates a TLE file, using Satellites obtained from the Satellite database. | 10 |
| Database | Database <ScenarioPath> {DBOption} | Update the satellite database from the AGI Web site, or set the default and auxiliary databases | 9.2.1 |
| DoesObjExist | DoesObjExist <ApplicationPath> <ObjectPath> | Determine if an object or scenario is open in the current STK session | 4.0.2 |
| EarthData | EarthData <ScenarioPath> {EarthDataOption} <Parameter> | Load or reload an EarthData file. | 11.3 |
| Environment | Environment <ScenarioPath> SetValue <AttributePath> <Value> [<Unit>] | Control the use of environmental models in a scenario | 9.0 |
| Environment (Comm & Radar) | Environment <ScenarioPath> {EnvironmentOption} | Control the use of environmental models in a scenario (Deprecated Command) | 9.0 |
| Environment_RM | Environment_RM <ScenarioPath> GetValue [<AttributePath>] | Get information about environmental models. | 9.0 |
| ExportCZML | ExportCZML <ScenarioPath> "<OutputFilePath>" {3D Model Server URL} | Export an STK Scenario to Cesium | 11.2 |
| ExportMapStyles | ExportMapStyles <ScenarioPath> {Options} | Export map styles. | 6.1 |
| GIS Export | GIS <ScenarioPath> Export "<ShapefilePath>" {ShapeType} <ObjectPath>... [{ExportOptions}] | Export STK object data into a shapefile | 10.1.1 |
| GIS Import | GIS <ScenarioPath> Import "<ShapefilePath>" {ObjectType} [<ImportOptions>] | Import GIS shapefile into current scenario | 11 |
| GIS Pattern | GIS <ScenarioPath> Pattern "<ShapefilePath>" <SensorObjectPath> | Export the footprint of a sensor to a shapefile | 4.0.6 |
| GIS Swath | GIS <ScenarioPath> Swath "<ShapefilePath>" <SensorObjectPath> | Export a sensor swath to a shapefile | 4.0.6 |
| GenFluxHistory | GenFluxHistory <ScenarioPath> ({FluxOption} <Value>)... | Generate daily solar flux and geomagnetic data histories in the .fxm format based on CSSI predicts files. | 11 |
| GetAnimationData | GetAnimationData <ScenarioPath> {Option} | Return information about the animation settings. | 6.1 |
| GetDB | GetDB <ApplicationPath> | Return the path of the current STK database (Deprecated Command) | 9.0 |
| GetDefaultDir | GetDefaultDir <ApplicationPath> | Return the path to the current default directory (Deprecated Command) | 9.0 |
| GetDescription | GetDescription <ObjectPath> {Type} | Return the description of an object | 4.0.6 |
| GetDirectory | GetDirectory <ApplicationPath> {DirOption} | Return the path of the selected directory. | 9.2.1 |
| GetEpoch | GetEpoch <ScenarioPath> | Return the current scenario epoch | 4.0 |
| GetMapStyles_R | GetMapStyles_R <ScenarioPath> | Return a list of map styles. | 6.1 |
| GetScenPath | GetScenPath <ScenarioPath> | Return the path to the directory in which the current scenario resides (Deprecated Command) | 9.0 |
| GetTimePeriod | GetTimePeriod <ObjectPath> | Return the current scenario time period or the start and stop times for a vehicle. | 4.0 |
| Graphics Label | Graphics <ObjectPath> Label {Options} | Control the display of object labels | 9.0 |
| Graphics ObjectStateInWin | Graphics <ScenarioPath> ObjectStateInWin {Options} | Control the display of objects' graphics in the 2D window. | 7.0 |
| Graphics WindowState | Graphics <ObjectPath> WindowState {Options} | Control the display of object graphics in the 2D window. | 10 |
| ImportFromDB | ImportFromDB <ScenarioPath> {Type} {Source} [{Options}] {SearchParameters} | Import Cities, Facilities and Satellites from the database or Stars from a collection. | 10 |
| ImportMapStyles | ImportMapStyles <ScenarioPath> {Options} | Import map styles. | 6.1 |
| KeyValueMetaData | KeyValueMetaData <ScenarioPath> {Option} [<Parameters>] | Save properties to STK objects for search in STK Data Federate (SDF). | 11.2 |
| KeyValueMetaData_RM | KeyValueMetaData_RM <ScenarioPath> {Option} [<Parameters>] | Return information about KeyValueMetaData. | 11.2 |
| Load | Load <ApplicationPath> {<ClassPath> | VDF} "<FilePath>" | Open an existing scenario or insert an object into the current scenario | 8.0 |
| MeasureSurfaceDistance | MeasureSurfaceDistance <ScenarioPath> <StartLat> <StartLon> <EndLat> <EndLon> [<CentralBodyName>] | Returns the distance between two points on the surface of the central body in meters | 5.0 |
| New | New <ApplicationPath> <ClassPath> <NewObjectName> {NewOptions} | Create a new scenario or add a new object to the current scenario | 8.1 |
| NewMulti | NewMulti <ApplicationPath> <ClassPathOfObjectToCreate> <NumToCreate> <NewName1> [<NewName2>...] [NoDefault] [Ignore] | Create multiple instances of new objects | 4.2 |
| ObjectTreeCollapse | ObjectTreeCollapse <ScenarioPath> {All | Object <TruncObjectPath> | Class <TruncObjectPath> | Children <TruncObjectPath>} | Selectively collapse items in the STK Object Browser tree. | 11.1 |
| ObjectTreeExpand | ObjectTreeExpand <ScenarioPath> {All | Object <TruncObjectPath> | Class <TruncObjectPath> | Children <TruncObjectPath>} | Selectively expand items in the STK Object Browser tree. | 11.1 |
| Parallel | Parallel <AppOrScenPath> {ParallelOption} | Configure parallel processing. | 11.3 |
| Parallel_RM | Parallel_RM <AppOrScenPath> {ParallelOption} | Return information related to parallel processing. | 11.3 |
| QuickSave | QuickSave <ScenarioPath> | Save a scenario without saving subobjects | 4.0 |
| RCS | RCS <ObjectPath> {Options} <Parameters> | Set and modify RCS values for an object | 10.1 |
| RCS (Deprecated) | RCS <ObjectPath> {RCSOption} <Parameters> | Set and modify RCS values for an object (Deprecated Command) | 10.1 |
| RCS_R | RCS_R <ObjectPath> <Frequency> [<IncidentAz> <IncidentEl> <ReflectedAz> <ReflectedEl>] | Return the RCS value for an object | 8.0 |
| RCS_RM | RCS_RM <ObjectPath> GetValue [<AttributePath>] | Get information about radar cross section properties. | 10.1 |
| RadarClutter | RadarClutter <ObjectPath> SetValue <AttributePath> <Value> [<Unit>] | Set and modify properties for radar clutter. | 10.1 |
| RadarClutter_RM | RadarClutter_RM <ObjectPath> GetValue [<AttributePath>] | Get information about an object's clutter properties. | 10.1 |
| Rename | Rename <ObjectPath> <NewName> | Rename an object | 4.0 |
| SDFLoad | SDFLoad <ApplicationPath> <Parameters> | Load a VDF or STK file from the STK Data Federate (SDF) servers into STK. | 11 |
| SDFSave | SDFSave <ApplicationPath> <ObjectPath> "<ServerFilePath>" [<Options>] | Save or check in a VDF or STK object to the STK Data Federate (SDF) servers. | 11.2 |
| SEET Graphics (Scenario) | SEET <ScenarioPath> Graphics MagField {GfxOptions} | Specify SEET magnetic field graphics options. | 9.1 |
| SEET Radiation (Scenario) | SEET <ScenarioPath> Radiation {RadOptions} | Specify SEET radiation options. | 9.1 |
| SOC | SOC <ScenarioPath> {Options} <Parameters> | Set search criteria, perform a search, and insert search results into the Scenario | 11.2 |
| SOC_RM | SOC_RM <ScenarioPath> {Options} | Return information needed to set up a search of the SOC | 11.2 |
| Save | Save <ApplicationPath> <ObjectPath> ["<SaveInDirectory>"] | Save a scenario or object within a scenario | 4.0 |
| SaveAs | SaveAs <ApplicationPath> <ObjectPath> "<FilePath>" | Save a scenario or object within a scenario with a different name | 4.2 |
| SetAnalysisTimePeriod | SetAnalysisTimePeriod <ScenarioPath> {TimeInterval} | Establish the scenario's analysis time period | 10 |
| SetAsDefault | SetAsDefault <ApplicationPath> [<ObjectPath>] | Save the indicated object as the default | 4.2 |
| SetConnectReportUnits | SetConnectReportUnits <ScenarioPath> {Dimension} <Unit> ["<Offset>"] [{Dimension2} {Unit2}...] | Set units of measure to be used when generating and displaying reports during the current Connect session (Deprecated Command) | 10.1 |
| SetConnectReportUnitsFlag | SetConnectReportUnitsFlag <ScenarioPath> {On | Off} | Turn on or off the use of Connect report units. (Deprecated Command) | 10.1 |
| SetDefaultDir | SetDefaultDir <ApplicationPath> "<NewDirectoryPath>" | Set the current default directory path | 4.0.5 |
| SetDescription | SetDescription <ObjectPath> {Type} [{Option}] "<Description>" | Set the long or short description of a scenario or object | 6.2 |
| SetEpoch | SetEpoch <ScenarioPath> {"<EpochTime>" | UseAnalysisStartTime} | Set the scenario epoch | 9.0 |
| SetGUIUnits | SetGUIUnits <ScenarioPath> {Dimension} {UnitID} [{Dimension2} {UnitID2}...] | Set units of measure for entering data via the graphical user interface (panels) (Deprecated Command) | 10.1 |
| SetInternalUnits | SetInternalUnits <ScenarioPath> {UnitOption} | Set units to the internal STK values (Deprecated Command) | 10.1 |
| SetReportUnits | SetReportUnits <ScenarioPath> {Dimension} <Unit> ["<Offset>"] [{Dimension2} {Unit2}...] | Set units of measure to be used when generating and displaying reports during the current Connect session (Deprecated Command) | 10.1 |
| SetTimePeriod | SetTimePeriod <ScenarioPath> "<StartTime>" "<StopTime>" | Establish the scenario's time period (Deprecated Command) | 9.0 |
| SetUnits | SetUnits <ApplicationPath> {Unit1} [{Unit2}] [{Unit3}] | Set date, distance and time units for data transfer during the Connect session (Deprecated Command) | 10.1 |
| ShowNames | ShowNames <ScenarioPath> [SubObjects [<ParentPath>]] [Class <ClassName>] | Identify the subobjects of an object or all objects of a certain type | 10.1 |
| ShowUnits | ShowUnits <ScenarioPath> {UnitLevel} | Get the current units of measure being used for entering data via the interface, displaying data in reports or entering data via the Connect socket (Deprecated Command) | 10.1 |
| SubObjUnload | SubObjUnload <ObjectPath> | Unload all subobjects of a scenario or object | 4.0 |
| Terrain | Terrain <ScenarioPath> {Action} <Parameters> | Add or remove terrain data to be used in STK calculations | 11 |
| TerrainServer | TerrainServer <ApplicationPath> <Parameters> | Specify a terrain server to be used in STK calculations | 11 |
| TerrainServer_RM | TerrainServer_RM <ApplicationPath> {Option} | To get information about the terrain server being used in STK calculations | 11 |
| Terrain_RM | Terrain_RM <ScenarioPath> TerrainServer {Option} | Return information about the Terrain Server. | 11 |
| TimeTool | TimeTool <ScenarioPath> {Options} | Define components defining instances or intervals of time. | 10.1.1 |
| TimeTool Interval | TimeTool <ScenarioPath> <ParentObject> {Action} {"Interval" | "IntervalTemplate"} <ComponentName> [{IntervalType} <TypeParams>] | Define and modify Interval components and templates. | 11.3 |
| TimeTool Interval List | TimeTool <ScenarioPath> <ParentObject> {Action} {"Interval List" | "Interval ListTemplate"} <ComponentName> [{IntervalListType} <TypeParams>] | Define and modify Interval List components and templates. | 11.3 |
| TimeTool Time Array | TimeTool <ScenarioPath> <ParentObject> {Action} {"Time Array" | "Time ArrayTemplate"} <ComponentName> [{TimeArrayType} <TypeParams>] | Define and modify Time Array components and templates. | 11.2 |
| TimeTool Time Instant | TimeTool <ScenarioPath> <ParentObject> {Action} {"Time Instant" | "Time InstantTemplate"} <ComponentName> [{TimeInstantType} <TypeParams>] | Define and modify Time Instant components and templates. | 10 |
| TimeTool_R | TimeTool_R <ScenarioPath> {Option} [<Parameters>] | Return information about TimeTool components. | 10 |
| TimeTool_RM | TimeTool_RM <ScenarioPath> {Option} [<Parameters>] | Return information about TimeTool components. | 10.1 |
| Timeline | Timeline <ScenarioPath> {Option} <Parameters> | Define and manage the Timeline in STK | 10.1 |
| Units_Convert | Units_Convert <ScenarioPath> {Date | Unit} <Parameters> | Convert a value from one unit to another. | 10.1 |
| Units_Get | Units_Get <ScenarioPath> {Option} [Abbreviation] | List the current units of measure. | 11.2 |
| Units_Set | Units_Set <ScenarioPath> {Option} <Parameters> | Set units of measure. | 11 |
| Units_SetConnect | Units_SetConnect <AppOrScenPath> {Default | Internal | {Dimension} {Unit}... } | Set units of measure for Connect. | 10.1 |
| Unload | Unload <ApplicationPath> <ObjectPath> [RemAssignedObjs] | Remove an object or scenario | 4.0 |
| UnloadMulti | UnloadMulti <ApplicationPath> <ObjectPath> | Remove an object and all of its subobjects from the current scenario | 9.1 |
| VO ObjectStateInWin | VO <ScenarioPath> ObjectStateInWin {Options} | Control the display of object graphics in the 3D window. | 7.0 |
| VO WindowState | VO <ObjectPath> WindowState {Options} | Control the display of object graphics in the 3D window. | 10 |
| VectorTool Angle | VectorTool <ScenarioPath> <ParentObject> {Action} {Angle | AngleTemplate} <AngleName> [{AngleType} <AngleTypeParams>] | Define and modify Angle geometry components and templates. | 10 |
| VectorTool Axes | VectorTool <ScenarioPath> <ParentObject> {Action} {Axes | AxesTemplate} <AxesName> [{AxesType} <AxesTypeParams>] | Define and modify Axes geometry components and templates. | 11.2 |
| VectorTool Plane | VectorTool <ScenarioPath> <ParentObject> {Action} {Plane | PlaneTemplate} <PlaneName> [{PlaneType} <PlaneTypeParams>] | Define and modify Plane geometry components and templates. | 11.2 |
| VectorTool Point | VectorTool <ScenarioPath> <ParentObject> {Action} {Point | PointTemplate} <PointName> [{PointType} <PointTypeParams>] | Define and modify Point geometry components and templates. | 11.2 |
| VectorTool System | VectorTool <ScenarioPath> <ParentObject> {Action} {System | SystemTemplate} <SystemName> [{SystemType} <SystemTypeParams>] | Define and modify System geometry components and templates. | 10 |
| VectorTool Vector | VectorTool <ScenarioPath> <ParentObject> {Action} {Vector | VectorTemplate} <VectorName> [{VectorType} <VectorTypeParams>] | Define and modify Vector geometry components and templates. | 11.2 |
| VectorTool_R | VectorTool_R <ScenarioPath> {Option} [<Parameters>] | Return information about VectorTool components. | 10.1 |
| VectorTool_RM | VectorTool_RM <ScenarioPath> {Option} [<Parameters>] | Return information about VectorTool components. | 10.1 |
| WinMedia2d | WinMedia2d <ScenarioPath> {WinMediaOptions} | Set Windows Media WebCast options for the 2D graphics window. | 6.1 |
| WinMedia3d | WinMedia3d <ScenarioPath> {WinMediaOptions} | Set Windows Media WebCast options for the 3D graphics window. | 6.1 |
Visit AGI.com