Class InputAnnotation

The authoring notes attached to any element of an input action asset.

Inheritance

object

InputAnnotation

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Scylla.Input

Assembly: ScyllaInput.dll

Syntax

[Serializable]
public class InputAnnotation

Remarks

Composed by value into each record type rather than inherited, so Unity serializes it inline and the resulting YAML stays readable. Neither Unity's own editor nor the established third-party alternative offers a free-form notes field, which makes this one of the cheaper places to be better than both.

Fields

Category

Author-defined grouping used by editor tooling.

Declaration

[Tooltip("Author-defined grouping used by editor tooling.")]
public string Category

Field Value

Type	Description
string

DisplayNameOverride

Player-facing label shown instead of the element's raw name.

Declaration

[Tooltip("Player-facing label shown instead of the element's raw name.")]
public string DisplayNameOverride

Field Value

Type	Description
string

Note

Free-form authoring note. Reaches IntelliSense as a doc comment when code is generated.

Declaration

[Tooltip("Free-form authoring note. Reaches IntelliSense as a doc comment when code is generated.")]
[TextArea(2, 6)]
public string Note

Field Value

Type	Description
string

Tags

Author-defined tags for filtering and search.

Declaration

[Tooltip("Author-defined tags for filtering and search.")]
public List<string> Tags

Field Value

Type	Description
List<string>

Properties

IsEmpty

Gets whether nothing has been authored here. Used to decide whether a record is worth quarantining when its element disappears, or is just noise.

Declaration

public bool IsEmpty { get; }

Property Value

Type	Description
bool