The Pin API is used to access and set Pin values.
| Pin (All Types) | ||||
|---|---|---|---|---|
| Properties | ||||
| Property Name | Return Data Type | Description | Example Syntax | |
| Name | String | Returns the name of this Pin Object | HippoNet.LocalHost.Engine:FindPin('Mix1/Layer1/Colour').Name |
|
| Path | String | Returns the full path of this object from the Root Pin | HippoNet.LocalHost.Engine:FindPin('Mix1/Layer1/Colour').Path |
|
| ParentName | String | Returns the name of this Pin Objects parent or an empty string if this is the Root Pin | HippoNet.LocalHost.Engine:FindPin('Mix1/Layer1/Colour').ParentName |
|
| IsRootPin | Boolean | True if this is the Root Pin or False if not | HippoNet.LocalHost.Engine:FindPin('Mix1/Layer1/Colour').IsRootPin |
|
| OwnerComponent | Component Object | The Component Object that hosts this Pin Objects pin tree | HippoNet.LocalHost.Engine:FindPin('Mix1/Layer1/Colour').OwnerComponent |
|
| ChildPinNames | Lua Table [Number,String] | Returns a table containing all the names of the direct children of this Pin Object indexed by increasing integer | HippoNet.LocalHost.Engine:FindPin('Mix1/Layer1/Colour').ChildPinNames |
|
| ChildPinPaths | Lua Table [Number,String] | Returns a table of all the paths of the direct children of this Pin Object indexed by increasing integer | HippoNet.LocalHost.Engine:FindPin('Mix1/Layer1/Colour').ChildPinPaths |
|
| 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 | HippoNet.LocalHost.Engine:FindPin('Mix1/Layer1/Colour').DescendentPinPaths |
|
| Functions | ||||
| Function Name | Parameters | Return Data Type | Description | Example Syntax |
| 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 | HippoNet.LocalHost.Engine:FindPin('Mix1/Layer1/Colour'):SearchChildNames('Brightness') |
| 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 | HippoNet.LocalHost.Engine:FindPin('Mix1/Layer1/Colour'):SearchChildPinPaths('RGB') |
| 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 | HippoNet.LocalHost.Engine:FindPin('Mix1/Layer1/Colour'):SearchDescendentPinPaths('Low') |
| Pin (Value Pins – Boolean,String,Float and Integer) | ||||
|---|---|---|---|---|
| Properties | ||||
| Property Name | Return Data Type | Description | Example Syntax | |
| PinType | String | Returns the type description of this PinObject eg. | HippoNet.LocalHost.Engine:FindPin('Mix1/Layer1/Colour/Brightness').PinType |
|
| 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 | HippoNet.LocalHost.Engine:FindPin('Mix1/Layer1/Colour/Brightness').Value |
|
| DefaultValue | Object(String,Number,Boolean) | The default value of this Pin Object | HippoNet.LocalHost.Engine:FindPin('Mix1/Layer1/Colour/Brightness').DefaultValue |
|
| 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) |
HippoNet.LocalHost.Engine:FindPin('Mix1/Layer1/Colour/Brightness').Info |
|
| Functions | ||||
| Function Name | Parameters | Return Data Type | Description | Example Syntax |
| Reset | () | Nothing | Attempts to set this pin to it’s default value | HippoNet.LocalHost.Engine:FindPin('Mix1/Layer1/Colour/Brightness') |
| Pin (Floats) | ||||
|---|---|---|---|---|
| Functions | ||||
| Function Name | Parameters | Return Data Type | Description | Example Syntax |
| FadeLevel | (Number From(Optional),Number To,Number FadeTime) | Nothing | Fades the value of a float pin in the background from a value (either given or current) to the value given, over FadeTime Seconds, does not halt script execution | HippoNet.LocalHost.Engine:FindMix(1).Layers[1]:FindPin('FX1/Level'):FadeValue(0, 1, 8) |
| FadeLevelWait | (Number From(Optional),Number To,Number FadeTime) | Nothing | Fades the value of a float pin from a value (either given or current) to the value given, over FadeTime Seconds, does halt script execution while in progress | HippoNet.LocalHost.Engine:FindMix(1).Layers[1]:FindPin('FX1/Level'):FadeLevelWait(1, 0, 15) |
| SnapEndLevel | (Number From(Optional),Number To,Number FadeTime) | Nothing | Snaps the float pin from a value (either given or current) to the value give after the FadeTime Seconds has passed. This does not halt the script | HippoNet.LocalHost.Engine:FindMix(1).Layers[1]:FindPin('FX1/Level'):SnapEndLevel(0, 1, 10) |
| SnapEndLevelWait | (Number From(Optional),Number To,Number FadeTime) | Nothing | Snaps the float pin from a value (either given or current) to the value give after the FadeTime Seconds has passed. This does halt the script | HippoNet.LocalHost.Engine:FindMix(1).Layers[1]:FindPin('FX1/Level'):SnapEndLevelWait(1, 0, 15) |
| EasingCubicLevel | (Number From(Optional),Number To,Number FadeTime) | Nothing | Fades float pin from a value (either given or current) to the value give after the FadeTime Seconds has passed using a Easing Cubic curve. This does not halt the script | HippoNet.LocalHost.Engine:FindMix(1).Layers[1]:FindPin('FX1/Level'):EasingCubicLevel(0, 1, 10) |
| EasingCubicLevelWait | (Number From(Optional),Number To,Number FadeTime) | Nothing | Fades float pin from a value (either given or current) to the value give after the FadeTime Seconds has passed using a Easing Cubic curve. This does halt the script | HippoNet.LocalHost.Engine:FindMix(1).Layers[1]:FindPin('FX1/Level'):EasingCubicLevelWait(1, 0, 15) |
| EasingSineLevel | (Number From(Optional),Number To,Number FadeTime) | Nothing | Fades float pin from a value (either given or current) to the value given after the FadeTime Seconds has passed using a Easing Sine curve. This does not halt the script | HippoNet.LocalHost.Engine:FindMix(1).Layers[1]:FindPin('FX1/Level'):EasingSineLevel(0, 1, 10) |
| EasingSineLevelWait | (Number From(Optional),Number To,Number FadeTime) | Nothing | Fades float pin from a value (either given or current) to the value given after the FadeTime Seconds has passed using a Easing Sine curve. This does halt the script | HippoNet.LocalHost.Engine:FindMix(1).Layers[1]:FindPin('FX1/Level'):EasingSineLevelWait(1, 0, 15) |
| EasingQuadraticLevel | (Number From(Optional),Number To,Number FadeTime) | Nothing | Fades float pin from a value (either given or current) to the value given after the FadeTime Seconds has passed using a Easing Quadratic curve. This does not halt the script | HippoNet.LocalHost.Engine:FindMix(1).Layers[1]:FindPin('FX1/Level'):EasingQuadraticLevel(0, 1, 10) |
| EasingQuadraticLevelWait | (Number From(Optional),Number To,Number FadeTime) | Nothing | Fades float pin from a value (either given or current) to the value given after the FadeTime Seconds has passed using a Easing Quadratic curve. This does halt the script | HippoNet.LocalHost.Engine:FindMix(1).Layers[1]:FindPin('FX1/Level'):EasingQuadraticLevelWait(1, 0, 15) |
Post your comment on this topic.