Settings
Inheritance
The Settings object is derived from the Object object.
The following internal objects are derived (specialisations) from the Settings object:
Property List
- AbsoluteFilePath
- The full path of the project file (directory path and file name including the file extension). (Read only string)
- AbsolutePath
- The full directory path of the project file (directory path excluding the file name and extension). (Read only string)
- Label
- The object label. (Read/Write string)
- Type
- The object type string. (Read only string)
Property List (internal only)
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)
Static Function List
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object. (Returns a table object.)
Property Details
- AbsoluteFilePath
- The full path of the project file (directory path and file name including the file extension).
- Type
- string
- Access
- Read only
- AbsolutePath
- The full directory path of the project file (directory path excluding the file name and extension).
- Type
- string
- Access
- Read only
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- Type
- The object type string.
- Type
- string
- Access
- Read only
Property Details (internal 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
- properties(Object)
- A table of properties defining the new state of the object.
Method Details (internal only)
Static Function Details
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object.
- Return
- table
- A table containing the default properties.