Class HudElementDetailGui

The fields of one HUD element, split into the four groups an author actually thinks in: where it sits, what it reads, how it looks, and when it re-reads.

Inheritance

object

HudElementDetailGui

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: Serenity.GameUi.Infrastructure.Editor.Builder

Assembly: Serenity.UnityGameUi.Infrastructure.Editor.dll

Syntax

public static class HudElementDetailGui

Remarks

An element has around twenty fields. Shown at once, in seven boxes nested inside each other, they read as a wall rather than as choices — and a list of several elements multiplies that by the number of them. Behind tabs the author sees five fields at a time and can find the one they came for.

The tab names are the scanner's own section names, so a finding maps to the tab holding its cause with no parsing and no lookup table. That mapping is what makes a finding a link.

Methods

Draw(SerializedProperty, int, IReadOnlyList<AuthoringIssue>, ref int)

Draws the element's identity, its findings, and whichever group of fields is showing.

Declaration

public static void Draw(SerializedProperty elements, int index, IReadOnlyList<AuthoringIssue> issues, ref int activeTab)

Parameters

Type	Name	Description
SerializedProperty	elements	The serialized element list this element belongs to — the Layout tab's Parent picker needs its siblings to offer as candidates.
int	index	This element's position within elements.
IReadOnlyList<AuthoringIssue>	issues	Findings about this element; may be empty.
int	activeTab	Which group is showing; updated in place when the author switches.

TabForSection(string)

The tab a section's findings belong to, or -1 when the section has no tab of its own.

Declaration

public static int TabForSection(string section)

Parameters

Type	Name	Description
string	section	A section name produced by HudDefinitionScanner.

Returns

Type	Description
int	The tab index.

WorstSeverity(IReadOnlyList<AuthoringIssue>)

The worst finding anywhere on the element, for its row in the list.

Declaration

public static AuthoringSeverity? WorstSeverity(IReadOnlyList<AuthoringIssue> issues)

Parameters

Type	Name	Description
IReadOnlyList<AuthoringIssue>	issues	Findings about the element.

Returns

Type	Description
AuthoringSeverity?	The worst severity, or null when there is nothing to report.