`PlatformLibraryElement`

Inheritance

The PlatformLibraryElement object is derived from the ComponentLibraryElement object.

Property List

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

Property List (internal only)

Description: (Read/Write string)
IconLabel: (Read only string)
ImageFilePaths: (Read only string)
Keywords: (Read/Write string)
LuaScriptFilePath: (Read only string)
ModelFileReference: (Read/Write FileReference)
Path: (Read only string)
Prefix: (Read/Write string)
RequiresModelFile: (Read/Write boolean)
Tooltip: (Read/Write string)
UniqueLabel: (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)

Create (): (Returns a Geometry object.)

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)

Description

Type: string
Access: Read/Write

IconLabel

Type: string
Access: Read only

ImageFilePaths

Type: string
Access: Read only

Keywords

Type: string
Access: Read/Write

LuaScriptFilePath

Type: string
Access: Read only

ModelFileReference

Type: FileReference
Access: Read/Write

Path

Type: string
Access: Read only

Prefix

Type: string
Access: Read/Write

RequiresModelFile

Type: boolean
Access: Read/Write

Tooltip

Type: string
Access: Read/Write

UniqueLabel

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

properties(Object): A table of properties defining the new state of the object.

Method Details (internal only)

Create ()

Return

Geometry

Static Function Details

GetDefaultProperties ()

Creates a table containing the default settings to create an object.

Return

table: A table containing the default properties.