Class FieldDef¶
Namespace: Apogee.Reflection
Assembly: Apogee.Reflection.dll
One field of a component: where it is, how it is stored, and what an inspector needs to show it.
public sealed record FieldDef : IEquatable<FieldDef>
Inheritance¶
Implements¶
Inherited Members¶
object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()
Constructors¶
FieldDef(string, FieldKind, int, string?, InspectorMeta?, string?)¶
One field of a component: where it is, how it is stored, and what an inspector needs to show it.
public FieldDef(string Name, FieldKind Kind, int Offset, string? Doc = null, InspectorMeta? Meta = null, string? AssetType = null)
Parameters¶
Name string
The field name.
Kind FieldKind
How the field is stored.
Offset int
The byte offset from the start of the component.
Doc string?
The /// summary of the field, or null.
Meta InspectorMeta?
Hints for an inspector, or null.
AssetType string?
For model), as the host registered it; null for every other kind.
Properties¶
AssetType¶
For model), as the host registered it; null for every other kind.
public string? AssetType { get; init; }
Property Value¶
Doc¶
The /// summary of the field, or null.
public string? Doc { get; init; }
Property Value¶
Kind¶
How the field is stored.
public FieldKind Kind { get; init; }
Property Value¶
Meta¶
Hints for an inspector, or null.
public InspectorMeta? Meta { get; init; }
Property Value¶
Name¶
The field name.
public string Name { get; init; }
Property Value¶
Offset¶
The byte offset from the start of the component.
public int Offset { get; init; }