The Pin API is used to access and set Pin values.
| Pin (All Types) | |||
|---|---|---|---|
| Properties | |||
| Property Name | Return Data Type | Description | |
| Name | String | Returns the name of this Pin Object | |
| Path | String | Returns the full path of this object from the Root Pin | |
| ParentName | String | Returns the name of this Pin Objects parent or an empty string if this is the Root Pin | |
| IsRootPin | Boolean | True if this is the Root Pin or False if not | |
| OwnerComponent | Component Object | The Component Object that hosts this Pin Objects pin tree | |
| ChildPinNames | Lua Table [Number,String] | Returns a table containing all the names of the direct children of this Pin Object indexed by increasing integer | |
| ChildPinPaths | Lua Table [Number,String] | Returns a table of all the paths of the direct children of this Pin Object indexed by increasing integer | |
| DescendentPinPaths | Lua Table [Number,String] | Returns a table of all the paths of all the children and descendents of this Pin Object indexed by increasing integer | |
| Functions | |||
| Function Name | Parameters | Return Data Type | Description |
| SearchChildNames | (String Pattern) | Lua Table [Number,String] | Returns a table of all the pin names of all the direct children of this Pin Object that contain in their name indexed by increasing integer |
| SearchChildPinPaths | (String Pattern) | Lua Table [Number,String] | Returns a table of all the pin paths of all the direct children of this Pin Object that contain in their path indexed by increasing integer |
| SearchDescendentPinPaths | (String Pattern) | Lua Table [Number,String] | Returns a table of all the pin paths of all the children of this Pin Object and their descendents that contain in their path indexed by increasing integer |
| Pin (Value Pins – Boolean,String,Float and Integer) | |||
| Properties | |||
| Property Name | Return Data Type | Description | |
| PinType | String | Returns the type description of this PinObject eg. | |
| Value | Object (String,Number,Boolean) | Returns the current value of this Pin Object, this value can be set which will in turn set the pin to that value | |
| DefaultValue | Object(String,Number,Boolean) | The default value of this Pin Object | |
| Info | Lua Table [String,Object] | Returns a table of info parameters for this Pin object indexed by parameter name:\n“DefaultValue” – (Object)The default Value of this Pin Object “Label” – (String) The Label of this Pin Object “QuickInfo” – (String) Basic description of this pin “ValueLabels” – (Lua Table [Number,String]) table of labels and values (Integer Pin Only) “TrueLabel” – (String) Display value for a true value (Boolean Pin Only) “FalseLabel” – (String) Display value for a false value (Boolean Pin Only) “DisplayMin” – (Number)Minimum display value (Float Pin Only) “DisplayMax” – (Number)Maximum display value (Float Pin Only) |
|
| Functions | |||
| Function Name | Parameters | Return Data Type | Description |
| Reset | () | Nothing | Attempts to set this pin to it’s default value |
Post your comment on this topic.