Class SelfDescription

Namespace

Pinwheel.Vista

Assembly

Pinwheel.Vista.Runtime.dll

Human-readable self description for a Vista asset: a title, a short description, a longer usage guide, and a preview screenshot. Deliberately a single shared, serializable type so the same shape powers both a graph's self description and a BiomeTemplate's gallery entry (one definition, one drawer). See the 3.2 template-gallery / graph-system design.

[Serializable]
public class SelfDescription

Inheritance

object

SelfDescription

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

IsEmpty

True when every field is empty, so a caller can fall back to another source (e.g. a graph's own description). The documentation link is deliberately not counted, a bare URL with no title, summary, guide, or screenshot is not a usable description and should still trigger the fallback.

description

A one or two line summary of what this produces.

documentationUrl

Optional link to a full online guide for this template. The inline usage guide stays the primary source, this is the supplementary go deeper affordance. Empty means no link is shown.

screenshot

A preview image of the result, used as a thumbnail and a larger preview.

title

A short, human-readable title shown in lists and headers.

usageGuide

A longer note on how to use it and what to tweak first.