=====Highlight=====

====Summary====

This function will highlight an asset within the Virtual Environment. Child assets will also be highlighted by default, however this feature is optional (see //Children//).

Assets will remain highlighted until an [[unhighlight]] function call is made to the highlighted asset, or [[cleanup]] is called.


====Parameters====

===Target===

//Type: Text
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.

===Colour===

//Type: [[Colour|Colour]]
Default: 1,1,0//

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

===Children===

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

If //true//, the all child objects of this part will be highlighted as well.

If //false//, only the component itself is highlighted - any parts within it are ignored.

===Keep===

Allow this effect to remain after the script completes.

====See Also====

[[unhighlight]] \\
[[cleanup]]

====Examples====

<code>
<highlight Target="SomeObject" />
</code>

> This function call will find the asset named **SomeObject** and highlight it.

<code>
<highlight Target="SomeObject" AndChildren="False" Colour="1,0,0"/>
</code>

> This function call will find the asset named **SomeObject** and highlight //only// it, and leave all child assets un-highlighted. The highlight colour will be red.