Annotation

Annotations

Annotations are (generally) 2D visuals that display on top of Actors.

Note: Annotations render above the scene being drawn, but before the user interface layer.

Note: These are usually used when making quest markers or way-points.

Rectangle renders a colored rectangle based on a width and height.

Name	Explanation	Type
Height	The height of the rectangle.	Number
Width	The width of the rectangle.	Number
Color	The color of the annotation, if applicable.	Color
Effects	The effects in the annotation.	Annotation Effect
Is Recycling	Whether or not the annotation recycles and continues to run.	Toggle
Offset	The offset of the annotation, in world space.	Vector
Pixel Offset	The offset of the annotation, in pixels or screen space.	Point

Sprite renders a sprite or image with a provided width and height.

Note: This annotation is commonly used to display quest markers, way-points, and so forth.

Name	Explanation	Type
Height	The custom height of the annotation.	Number
Is Sprite Cycling	Whether or not the sprite cycles from its last frame.	Toggle
Sprite	The sprite associated with the annotation.	Sprite or Model
Stretch To Dimensions	Whether or not to stretch to the and .	Toggle
Width	The custom width of the annotation.	Number
Color	The color of the annotation, if applicable.	Color
Effects	The effects in the annotation.	Annotation Effect
Is Recycling	Whether or not the annotation recycles and continues to run.	Toggle
Offset	The offset of the annotation, in world space.	Vector
Pixel Offset	The offset of the annotation, in pixels or screen space.	Point

Text renders text with the provided font.

Note: This annotation is commonly used to display names above NPCs.

Name	Explanation	Type
Font	The font associated with the annotation.	Font
Text	The text associated with the annotation.	String
Color	The color of the annotation, if applicable.	Color
Effects	The effects in the annotation.	Annotation Effect
Is Recycling	Whether or not the annotation recycles and continues to run.	Toggle
Offset	The offset of the annotation, in world space.	Vector
Pixel Offset	The offset of the annotation, in pixels or screen space.	Point