HippoNet contains all the pins and components of Hippotizer. Use this API to find components, host names and pin paths.
| HippoNet | ||||
|---|---|---|---|---|
| Properties | ||||
| Property Name | Return Data Type | Description | Example Syntax | |
| LocalHost | Host Object | Returns the host object that this Macro Manager is running on | HippoNet.LocalHost |
|
| HostNames | Lua Table [Number,String] | Returns a table of all the HippoNet hosts found on the network, indexed by an integer | HippoNet.HostNames |
|
| Functions | ||||
| Function Name | Parameters | Return Data Type | Description | Example Syntax |
| FindHost | (String HostName) | Host Object or Nil | Returns the host object called or Nil if it cannot find it | HippoNet:FindHost('AMBA-240041') |
| SearchHostNames | (String Pattern) | Lua Table [Number, String] | Returns a table of all the Host names that contain the indexed by a number. | HippoNet:SearchHostNames('AMBA') |
| FindComponent | (String HostName, String ComponentName) | Component Object or Nil | Returns the Component object called running on Host called or Nil if it cannot be found | HippoNet:FindComponent('AMBA-240041', 'Engine') |
| FindPin | (String HostName, String ComponentName, String PathFromRootPin) | Pin Object or Nil | Returns the Pin object at path on component running on Host or Nil if it is not found | HippoNet:FindPin('AMBA-240041', 'Engine', 'Mix1\Layer1\Colour\Brightness') |
Post your comment on this topic.