Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
ardiscript:indicator_ar [2019/08/14 23:25] optrix created |
ardiscript:indicator_ar [2019/09/18 02:42] (current) optrix [Examples] |
||
|---|---|---|---|
| Line 7: | Line 7: | ||
| ====Parameters==== | ====Parameters==== | ||
| - | ===Target=== | + | ===Name=== |
| //Type: Text | //Type: Text | ||
| Default: None// | Default: None// | ||
| - | Specifies the name or ARDI ID of the asset you would like to attach the indicator to. If using an asset ID, begin the target with the '#' character. | + | Specifies the name of the object to be added to the marker. This name can be referred to later by other scripts in order to modify and/or interact with it in some way, such as with the [[remove_ar]] function. |
| + | |||
| + | If an object of the same type has the same name, this script will modify the existing object instead of creating a new one. | ||
| ===Text=== | ===Text=== | ||
| Line 47: | Line 49: | ||
| Default: **Large 2D**// | Default: **Large 2D**// | ||
| + | This parameter allows you to specify the style of the indicator. | ||
| + | These are the main styles that are available: | ||
| + | |||
| + | ^**Style**^**Effect**^ | ||
| + | |Large 2D| A large styled indicator with a tapering effect. | | ||
| + | |Small Top 2D| A smaller indicator with an indentation pointing from the top of its side. | | ||
| + | |Small Mid 2D| A smaller indicator with an indentation pointing from the middle of its side. | | ||
| + | |Speech Mid| A speech bubble effect. | | ||
| ===Color=== | ===Color=== | ||
| Line 57: | Line 67: | ||
| For example: A value of "0.5,0,1" will create a color with 50% red, 0% green and 100% blue applied to it. | For example: A value of "0.5,0,1" will create a color with 50% red, 0% green and 100% blue applied to it. | ||
| + | ====See Also==== | ||
| + | [[addmesh_ar]] [[addshape_ar]] [[imagelabel]] [[remove_ar]] | ||
| + | ====Examples==== | ||
| - | ===LockToCamera=== | + | <code> |
| + | <indicator Text="Device A" Offset="10,20,-10" Scale="0.5" Colour="1,0,0" /> | ||
| + | </code> | ||
| - | //Type: [[Bool]] | + | > The above code will create an indicator labeled **Device A**. It will be positioned at the x,y,z co-ordinates **10,20,-10** offset from the marker position. With a scale of **0.5** it will be shrunk to half the size and have a colour value of **1,0,0** which will make it appear red. |
| - | Default: **True**// | + | |
| - | + | ||
| - | If true, this parameter will force the indicator to lock itself to the facing direction of the camera, making it so that the indicator always appears fully visible. | + | |
| - | ====See Also==== | + | |
| - | + | ||
| - | ====Examples==== | + | |