AiOverlayStyle

Remarks

⚠ default is a quiet style, not the usual one, and it is the trap ConstraintGizmoStyle paid for first: a struct's property initialisers do not run for default, so a zeroed style has no categories, no range and no size. That is a real style somebody would want — the overlay off — which is the only reason it is allowed to be the zero one. Default is the usual one and it is new().

⚠ Range is what stops the overlay being useless in a crowd. Forty agents each labelled with their active path is a screen of text; drawing only what is near the viewpoint is the difference between a tool and a screenshot of one. Zero means everything, which is what a headless test wants.

Fields and properties (19)

• public const float DefaultRange

  How far from the viewpoint an agent is still drawn, in metres.

• public const float DefaultTextSize

  How tall a line of text is, in world units.

• public const int DefaultMaximumAgents

  How many agents are drawn at most, however near they are.

• public static AiOverlayStyle Default

  The usual style: where and what, plus the sense shapes, out to forty metres.

• public static AiOverlayStyle Everything

  Everything, out to any distance — what a test uses, and what a close-up wants.

• public AiDebugCategory Categories

  Which categories are drawn.

• public float Range

  How far from the viewpoint to draw, in metres. Zero is everywhere.

• public int MaximumAgents

  How many agents to draw at most. Zero means the usual.

• public float TextSize

  How tall a line of text is, in world units. Zero means the usual.

• public float Headroom

  How high above an agent its readout starts, in metres.

• public int RowsPerSection

  How many rows of one section to draw before it is cut short.

• public Color4 Running

  The colour of an agent that is running normally.

• public Color4 Succeeded

  The colour of one that succeeded.

• public Color4 Failed

  The colour of one that failed.

• public Color4 Live

  The colour of the live row of a list — the active node, the chosen action.

• public Color4 Quiet

  The colour of everything that is merely being reported.

• public Color4 Attention

  The colour of the selected agent, and of anything AiDiagnosis flagged.

• public float Text

  How tall a line of text actually is, with a zeroed style answering the usual size.

• public int Agents

  How many agents are actually drawn, ditto.

Methods (3)

• public AiOverlayStyle()

  Creates the usual style.

• public bool Shows(AiDebugCategory category)

  Whether a category is on.

• public Color4 ColourOf(ActionStatus status)

  What colour a status reads as.

Used by (2)

• AiGameplayDebuggerVixen.Ai.Diagnostics
• AiOverlayExitCriteriaTestsVixen.Ai.Diagnostics.Tests