Class ArchetypeProjection

Namespace

Typhon.Engine

Assembly

Typhon.Engine.dll

Everything one archetype declared: its position, its public fields, its owner fields and the change groups they fall into.

public sealed class ArchetypeProjection

Inheritance

object

ArchetypeProjection

Inherited Members

object.GetType()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Fields

DefaultGroup

The change group a field falls into when its declaration names none.

public const string DefaultGroup = "state"

Field Value

string

DefaultOwnerGroup

The change group an owner field falls into when its declaration names none.

public const string DefaultOwnerGroup = "owner"

Field Value

string

Properties

ArchetypeType

The archetype type this projection was declared for.

public Type ArchetypeType { get; }

Property Value

Type

Fields

The public fields, in declaration order. Canonical wire order is computed when the plan is compiled.

public IReadOnlyList<ProjectedField> Fields { get; }

Property Value

IReadOnlyList<ProjectedField>

Groups

The public change groups, in first-declared order.

public IReadOnlyList<string> Groups { get; }

Property Value

IReadOnlyList<string>

Index

The order this archetype was declared in. Not the wire index, which is canonical and assigned when the catalog is built.

public int Index { get; }

Property Value

int

IsStatic

Whether the archetype was declared static: sent once on enter, never updated.

public bool IsStatic { get; }

Property Value

bool

Name

The archetype's name, which is the name it travels under.

public string Name { get; }

Property Value

string

OwnerFields

The owner fields, in declaration order.

public IReadOnlyList<ProjectedField> OwnerFields { get; }

Property Value

IReadOnlyList<ProjectedField>

OwnerGroups

The owner change groups, in first-declared order.

public IReadOnlyList<string> OwnerGroups { get; }

Property Value

IReadOnlyList<string>

Position

How the position travels, or null when the archetype declared none.

public PositionProjection Position { get; }

Property Value

PositionProjection

Methods

ToString()

public override string ToString()

Returns

string