Annotations

Annotations are a nice way to organise your work and add label specific areas of the Flow Engine Window. There are comments available for Orders and to be added onto the Flow Engine Window as well as being able to draw lines and boxes around specific areas of the Flow Engine Window.

Order Comments

A specific Order can be added to the list of Orders on any given Node:

1. Select a Node that you wish to add a comment Order to.
2. Find the Comment Order and add this to the list.

3. Fill in the comment text. This Order will not be executed but is only used for decoration purposes only - useful for collaboration and for labelling complex areas of a given experience.

Flow Engine Labels

Labels are a simple box which text can be added to and drawn onto the Flow Engine Window. Once created, these labels can be edited and then dragged around the Window. To create a label:

1. Ensure a Flow Engine Window is open and an Engine is selected.
2. Right-Click where you want to place your new label.
3. Select Add Label and then fill out your label text.

Flow Engine Lines

Whilst having labels is a useful way to comment on specific areas of the Flow Engine Window, sometimes to make things clearer we need to point to specific content. We can do this using Lines. To add a new line:

1. Ensure a Flow Engine Window is open and an Engine is selected.
2. Right-Click where you want to start your new line.
3. Select `Start Line' - this will begin drawing your line from this given point

4. Left-Click where you wish the line to end.

Lines work best when combined with Labels and Boxes to really help highlight areas of the Flow Engine Window.

Flow Engine Annotation Boxes

While Labels and Lines are useful for labelling specific areas of your Window, sometimes you wish to group a section of your Window to visualise logical flows or specific features/areas. You can draw boxes around content which does not impact the exisiting content of the Window using Annotation Boxes. To do so:

1. Ensure a Flow Engine Window is open and an Engine is selected.
2. Select the Draw Annotation Box toolbar button in the top left of the Flow Engine Window.

3. You are in 'Drawing Mode' - you can left-click and drag the mouse to begin drawing your box.
4. Let go of left-click when happy with the box size/shape - you can adjust the position at any time by dragging the box with left-click.

Such boxes work great with Labels and Lines to highlight specific areas of your Flow Engine Window and to keep things organised.

Custom Annotation Tint

You can change the tint of Labels and Lines in the Flow Engine Inspector: