The component API works across all components. Some components contain additional commands that are detailed separately.
Component (All Component Types) | |||
---|---|---|---|
Properties | |||
Property Name | Return Data Type | Description | |
Name | String | Returns the name of this component | |
TypeName | String | Returns the Type of this component eg. | |
OwnerHost | Host Object | Returns the Host Object that this component is running on | |
OwnerHostName | String | Returns the name of the Host Object that this component is running on | |
AllPinPaths | Lua Table [Number,String] | Returns a table of the paths to all the pins in the pin tree of this component from the root pin indexed by increasing integer | |
RootPin | Pin Object (GroupPin) | Returns the topmost Pin Object in this components pin tree which is parent to all other pin objects | |
Functions | |||
Function Name | Parameters | Return Data Type | Description |
FindPin | (String PathFromRoot) | Pin Object or Nil | Returns the Pin Object with a path of from the component Root Pin or Nil if it cannot be found |
SearchAllPinPaths | (String Pattern) | Lua Table [Number,Pin Object] | Returns a table of all the Pin Objects with a path from Root that contains indexed by increasing integer |
Stop | () | Nothing | Attempts to stop this component |
Import | (String FilePath) | Boolean | Attempts to import a component settings file at location from disk, returns True is successful or False if it failed for any reason |
Export | (String FilePath) | Boolean | Attempts to export this components settings to location on disk, returns True is successful or False if it failed for any reason |
Hinterlasse einen Kommentar.