Class ObserverDeclaration

Namespace

Typhon.Engine

Assembly

Typhon.Engine.dll

What an ObserverBuilder declared, as the interest pass reads it back.

public sealed class ObserverDeclaration

Inheritance

object

ObserverDeclaration

Inherited Members

object.GetType()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Properties

Archetypes

The archetypes this observer reaches, in declaration order.

public IReadOnlyList<Type> Archetypes { get; }

Property Value

IReadOnlyList<Type>

BoundEntity

The entity a sphere is bound to, or Null when it is not bound to one.

public EntityId BoundEntity { get; }

Property Value

EntityId

ByteBudget

The observer's byte budget; 0 when none was declared.

public int ByteBudget { get; }

Property Value

int

FarMaxHz

The far tier's refresh rate in hertz; 0 when there is no far tier.

public double FarMaxHz { get; }

Property Value

double

FarTileM

The far tier's tile edge in metres; 0 when there is no far tier.

public double FarTileM { get; }

Property Value

double

FollowsControlled

Whether the observer follows the session's controlled entity.

public bool FollowsControlled { get; }

Property Value

bool

Kind

The region's shape.

public ObserverKind Kind { get; }

Property Value

ObserverKind

LeaveRadius

A sphere's leave radius, in metres; 0 when the declaration left the hysteresis band to the engine.

public double LeaveRadius { get; }

Property Value

double

MaxEdgeM

A client region's longest accepted edge, in metres.

public double MaxEdgeM { get; }

Property Value

double

NearBudget

The near tier's entity budget; 0 when none was declared.

public int NearBudget { get; }

Property Value

int

Placement

A fixed placement, or null when the observer is bound or follows the controlled entity.

public Vector3D? Placement { get; }

Property Value

Vector3D?

Radius

A sphere's enter radius, in metres.

public double Radius { get; }

Property Value

double

RateHz

An aggregate observer's refresh rate, in hertz.

public double RateHz { get; }

Property Value

double

TileM

An aggregate observer's tile edge, in metres.

public double TileM { get; }

Property Value

double

Methods

ToString()

public override string ToString()

Returns

string