Command reference
Commands grouped by function
-
Data handling
- Text
- Arrays
- ARRAY_CREATE → Creates an array
- ARRAY_ADD → Adds an item to an array
- ARRAY_SET → Sets the value of an item in an array
- ARRAY_GET → Gets the value of an item in an array
- ARRAY_COUNT → Counts the items in an array
- ARRAY_CLEAR → Clears an array
- Maps
- MAP_CREATE → Creates a map
- MAP_SET → Sets a key-value pair in a map
- MAP_KEYEXISTS → Checks whether a key exists in a map or not
- MAP_GET → Gets the value paired to a key from a map
- MAP_CLEAR → Deletes the contents of a map
-
Model object handling
- Object creation
- LOAD_SECTION_LIBRARY → Loads a section into the section list from the standard section library
- LOAD_SECTION_MACRO → Loads a macro section into the section list
- LOAD_SECTION_MACRO_STIFFENED → Loads a stiffened macro section into the section list (since CS 17)
- CREATE → Creates an object
- GENERATE → Generates multiple objects
- CONVERT_AND_LOAD_SECTIONS → Converts and loads sections from section bank (since CS 17 build 3303)
- Object selection
- Object modification
- MOVE_SELECTED → Moves pre-selected objects
- COPY_SELECTED → Copies pre-selected objects
- ROTATE_SELECTED → Rotates pre-selected objects
- MIRROR_SELECTED → Mirrors pre-selected objects
- MOVE_SELECTED_POINT_OR_EDGE → Moves pre-selected points and edges
- SET → Sets or modifies an attribute value of an object
- Object removal
- DELETE → Deletes an object (since CS 17)
- Object creation
-
Query tools
- GET → Gets an attribute value of an object
- GET_LOADED_SECTIONS → Saves all section IDs into an array
- GET_RELEASE_NAME → Gets the name of a release type
- GET_SUPPORT_NAME → Gets the name of a support type
- FILTER → Creates an ID list of model objects based on object type and attributes
- GET_RESULT → Queries results from an analysis or design run
- GET_REFERENCING_OBJECTS → Gets the IDs of objects referencing the input object (since CS 17)
-
Calculation
- ANALYSIS RUN → Starts an analysis run
- DESIGN RUN → Starts a design calculation
-
Input/output
- Text files
- OPEN_FILE → Selects a text file for output
- WRITE_FILE → Writes an output to the currently open text file
- CLOSE_FILE → Closes the currently open text file
- Excel
- EXCEL_OPEN → Opens an excel file
- EXCEL_WRITE_CELL → Writes a value into a specific cell in an excel spreadsheet
- EXCEL_READ_CELL → Reads out the value stored in a specific cell in an excel spreadsheet
- EXCEL_COUNT_FILLED_ROWS → Counts the filled rows in a column of an excel spreadsheet
- EXCEL_CLOSE → Closes the currently open excel file
- Text files
-
Other
- GET_USER_INPUT → Requests input from the user during the script run
- TAB → Changes tab in the main window (since CS 17)
- MSG_BOX → Pops up a message box (since CS 17)
- WAIT → Waits a specified time before executing the next command
- CLEAR_ALL → Clears all content in the model file
- RETURN → Exits the script run
- SAVE_AS → Saves the model to specific storage location
- EXIT → Exits Consteel