`ScriptEditor`

Inheritance

The ScriptEditor object is derived from the Object object.

Usage locations

The ScriptEditor object can be accessed from the following locations:

Properties
- Application object has property ScriptEditorWindow.

Usage locations

The ScriptEditor object can be accessed from the following locations:

Properties
- MockApplication object has property ScriptEditorWindow.
- MockApplicationForSchematics object has property ScriptEditorWindow.
- MockApplicationForCables object has property ScriptEditorWindow.
- MockMeshApplication object has property ScriptEditorWindow.
- MockApplicationForOptimisation object has property ScriptEditorWindow.
- MockVoxelsApplication object has property ScriptEditorWindow.

Property List

Label: The object label. (Read/Write string)
Type: The object type string. (Read only string)

Property List (internal only)

ActiveScript: (Read only AbstractScript)
HasOpenScripts: (Read only boolean)
HasScriptFailed: (Read/Write boolean)
IsAScriptRunning: (Read/Write boolean)
IsScriptPaused: (Read/Write boolean)
Path: (Read only string)

Method List

Delete (): Deletes the entity.
Duplicate (): Duplicates the entity. (Returns a Object object.)
GetProperties (): Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step. (Returns a table object.)
SetProperties (properties Object): Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.

Method List (internal only)

Activate ( AbstractScript)
Close ( AbstractScript)
Exit ()
Open ( AbstractScript): (Returns a AbstractScript object.)
OpenFiles ( string): (Returns a AbstractScript object.)
Pause ( AbstractScript)
Run ( AbstractScript)
RunWithoutEditor ( AbstractScript)
Save ( AbstractScript)
Step ( AbstractScript)
Stop ( AbstractScript)
TakeOwnership ( AbstractScript)

Static Function List

GetDefaultProperties (): Creates a table containing the default settings to create an object. (Returns a table object.)

Property Details

Label

The object label.

Type: string
Access: Read/Write

Type

The object type string.

Type: string
Access: Read only

Property Details (internal only)

ActiveScript

Type: AbstractScript
Access: Read only

HasOpenScripts

Type: boolean
Access: Read only

HasScriptFailed

Type: boolean
Access: Read/Write

IsAScriptRunning

Type: boolean
Access: Read/Write

IsScriptPaused

Type: boolean
Access: Read/Write

Path

Type: string
Access: Read only

Method Details

Delete ()

Deletes the entity.

Duplicate ()

Duplicates the entity.

Return

Object: The new (duplicated) entity.

GetProperties ()

Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step.

Return

table: A table defining the properties.

SetProperties (properties Object)

Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.

Input Parameters