ProtectedModels
A collection of protected components.
Inheritance
The ProtectedModels object is derived from the Object object.
Usage locations
The ProtectedModels object can be accessed from the following locations:
- Collection lists
Property List
Method List
- AddComponent (table table)
- Create an protected component from a table defining the properties. (Returns a ProtectedModel object.)
- AddComponentFromFile (Filename string)
- Create an protected component from the given file. (Returns a ProtectedModel object.)
- Delete ()
- Deletes the entity.
- DeleteEntities ( List of Object)
- Delete the given list of entities from the collection.
- 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.)
- Item (index number)
- Returns the ProtectedModel for the given index in the collection. (Returns a ProtectedModel object.)
- Item (label string)
- Returns the ProtectedModel for the given label in the collection. (Returns a ProtectedModel object.)
- Items ()
- Returns a table of ProtectedModel items. (Returns a UnsupportedType(List of ProtectedModel) 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.
Static Function List
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object. (Returns a table object.)
Property Details
- BoundingBox
- A box indicating the bounding box of this entity. (Read only Box).
- Type
- Box
- Access
- Read only
- Count
- The number of ProtectedModel items in the collection.
- Type
- number
- Access
- Read only
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- Type
- The object type string.
- Type
- string
- Access
- Read only
Method Details
- AddComponent (table table)
- Create an protected component from a table defining the properties.
- Input Parameters
- table(table)
- A table of properties defining the new protected component.
- Return
- ProtectedModel
- Returns a ProtectedModel object.
- AddComponentFromFile (Filename string)
- Create an protected component from the given file.
- Input Parameters
- Filename(string)
- The file to be imported as a protected component.
- Return
- ProtectedModel
- Returns a ProtectedModel object.
- Delete ()
- Deletes the entity.
- DeleteEntities ( List of Object)
- Delete the given list of entities from the collection.
- 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.
- Item (index number)
- Returns the ProtectedModel for the given index in the collection.
- Input Parameters
- index(number)
- The index of the ProtectedModel.
- Return
- ProtectedModel
- The item in the collection
- Item (label string)
- Returns the ProtectedModel for the given label in the collection.
- Input Parameters
- label(string)
- The label of the ProtectedModel.
- Return
- ProtectedModel
- The item in the collection
- Items ()
- Returns a table of ProtectedModel items.
- Return
- UnsupportedType(List of ProtectedModel)
- The list of items in the collection
- 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.
Static Function Details
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object.
- Return
- table
- A table containing the default properties.