FlatIndicator
Summary
Creates a large 'billboard' (a sign that floats in the air and orients itself towards your camera). This is used to point out specific items of interest in the scene, or to display text information related to an asset.
Parameters
Text
Type: Text Bindable Default: HERE
The content of the text.
Because this is bindable, you can display any asset property here as well as any fixed value.
Offset
Type: Vector3 Default: 1,0,0
The distance away from the object that the flat indicator should appear. Note that these are specified world coordinates, relative to the object.
Scale
Type: Float Default: 0.5
The size of the flat indicator. As a rule, the indicator matches the size of the object its attached to. This number acts as a multiplier on that scale.
If you are placing an indicator on a very small item, you might choose a scale of 2 or 3 (double or triple the size of the object), while indicating an extremely large item may involve using a scale of 0.5 or 0.25.
Colour
Type: Colour Default: 0,1,0,1
The primary colour of the indicator.
Note that you should keep your TextColour in mind when making any changes to your indicator colour. Very dark colours should use white text (1,1,1,1) while very dark colours should use black text (0,0,0,0).
TextColour
Type: Colour Default: 0,0,0,1
The colour of the text that appears on the indicator.
Note that you should keep your Colour in mind when making any changes to your indicator colour. Very dark colours should use white text (1,1,1,1) while very dark colours should use black text (0,0,0,1).
LockToCamera
Type: Boolean Default: 1
Indicates if the indicator should stay stationary (0/false), or rotate to face the camera (1/true).
Style
Type: Text Default: Large 2D
There are several styles of indicator available.
Style Code | Apperance |
---|---|
Large | A large indicator that points downwards |
Small Top | A sideways-pointing indicator with an arrow located at the top |
Small Mid | A sideways-pointing indicator with an arrow at the center |
Speech Mid | A 'speech balloon' with the arrow at the bottom center |
Examples
<flatindicator text="Push Here" offset="0,1,0" colour="0,0,1,1"/>
A blue indicator with the text 'Push Here' appears 1m above the asset.