=====HighlightConnection=====

====Summary====

This function draws bright lines //inside// existing connections to help highlight flow routes.

These will remain in the scene until [[cleanup]] is called, or they are destroyed by name with [[remove]].

====Parameters====

===From===

//Type: Asset
Default: None//

Specifies the name or ARDI ID of the asset you wish to highlight. If using an asset ID, begin the target with the '#' character.

===To===

//Type: Asset
Default: None//

Specifies the name or ARDI ID of the asset you wish to highlight. If using an asset ID, begin the target with the '#' character.

===Relationship===

//Type: Relationship (Name or Number)
Default: None//

Specifies the name of the relationship you want to highlight. Each asset may have several different relationship connections - this helps ensure that the right one is used.

===PathColour===

//Type: Colour
Default: 1,1,0//

Specifies the red, green and blue components of the colour used in the highlight.

===Reverse===

//Type: [[Bool]]
Default: **true**//

Changing this between 'true' and 'false' will reverse the direction of the animation.

===Name===

//Type: Text
Default: **LinkedPath**//

Changes the name of the created object in the scene. This is primarily used if you wish to delete it with [[remove]].

====See Also====

[[cleanup]] \\
[[remove]]

====Examples====

<code>
  <highlightconnection From="Natural Gas Reserve Storage" To="Stove #3 Natural Gas Flowmeter" Relationship="Natural Gas" PathColour="1,1,0.2"/>
</code>

> This function will create a yellow line that shows the flow direction through .