Nebula
Protocol

FarEntityEntry

One entity of the far relevance tier (docs/interest-management.md §16, NEB-388): a large or important entity seen beyond the normal interest radius as a pose and nothing else.

generated from the sources
public struct FarEntityEntry

One entity of the far relevance tier (docs/interest-management.md §16, NEB-388): a large or important entity seen beyond the normal interest radius as a pose and nothing else. No variables, no RPCs, no sync state, no container: the position is absolute in the entity's scope, in double (the space region keys and the gateway's own positions are in, converted out of every physics frame the entity stands in), so a receiver needs no container row and no frame to place it, and a coordinate 106 m out keeps sub-millimetre resolution on the wire. Rotation is in the same space (smallest-three, 4 bytes, about 0.1 degree), velocity in half floats (m/s).

Fields

NetId

public ulong NetId;

Epoch

public uint Epoch;

Kind

public FarEntryKind Kind;

PrefabId

public ushort PrefabId;

InterestGroup

public byte InterestGroup;

Radius

public float Radius;

The far radius the entity declared (NetworkIdentity.FarRelevanceRadius), metres.

UpdateRate

public float UpdateRate;

The far updates per second it declared (NetworkIdentity.FarUpdateRate).

OwnerClientId

public ulong OwnerClientId;

InstanceId

public ulong InstanceId;

The isolation id of the entity's scope; 0 for the public world.

X, Y, Z

public double X, Y, Z;

Absolute position in the entity's scope, metres, in double.

Rotation

public Quaternion Rotation;

Velocity

public Vector3 Velocity;

StateWireSize

public const int StateWireSize = 8 + 4 + 1 + 1 + 2 + 1 + 4 + 4 + 24 + 4 + 6;

Bytes a FarEntryKind.State entry with neither owner nor scope costs on the wire.

Methods

GoneOf

public static FarEntityEntry GoneOf(ulong netId, uint epoch);

Write

public void Write(NetworkWriter w);

Read

public static FarEntityEntry Read(NetworkReader r);

SqrDistanceTo

public double SqrDistanceTo(double x, double y, double z);

Squared distance from an absolute point of the same scope, in double.

On this page