Class BuiltInCommands

Namespace

Typhon.Protocol

Assembly

Typhon.Protocol.dll

The commands the engine itself understands (W27, W28). They sit in the catalog beside the application's, at reserved indices that never move.

public static class BuiltInCommands

Inheritance

object

BuiltInCommands

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Fields

ClientRegion

The name of the client-supplied viewpoint footprint.

public const string ClientRegion = "ClientRegion"

Field Value

string

ClientRegionIdx

The reserved index of ClientRegion.

public const int ClientRegionIdx = 0

Field Value

int

MaxRegionVertices

The most footprint vertices a region may carry: a horizon-clipped frustum needs 5–8, 16 is headroom.

public const int MaxRegionVertices = 16

Field Value

int

MinRegionVertices

The fewest footprint vertices a region may carry.

public const int MinRegionVertices = 3

Field Value

int

RegionAltitudeField

The ClientRegion field carrying the viewpoint altitude, in metres.

public const string RegionAltitudeField = "altitudeM"

Field Value

string

RegionBudgetField

The ClientRegion field carrying the client's byte budget, in KiB per second.

public const string RegionBudgetField = "budgetKiBps"

Field Value

string

RegionVerticesField

The ClientRegion field carrying the convex footprint polygon.

public const string RegionVerticesField = "vertices"

Field Value

string

SubscribeRequest

The name of the source-subscription request (#204). Reserved; its shape is decided when Phase 4 opens.

public const string SubscribeRequest = "SubscribeRequest"

Field Value

string

SubscribeRequestIdx

The reserved index of SubscribeRequest.

public const int SubscribeRequestIdx = 1

Field Value

int

Methods

CreateClientRegion(CatalogCodec)

Builds the ClientRegion command for a world whose positions use position: its vertices are quantized exactly like the archetypes' positions, so a decoded region can never leave the world.

public static CatalogCommand CreateClientRegion(CatalogCodec position)

Parameters

position CatalogCodec

The grid's Pos2 codec.

Returns

CatalogCommand

The command definition: latest-wins, at most 5 per second.

HasClientRegionShape(CatalogCommand)

Whether command is shaped exactly as CreateClientRegion(CatalogCodec) builds it, for whatever position codec. The engine interprets this command itself, so an application command that merely takes its name must be refused, not decoded as a region.

public static bool HasClientRegionShape(CatalogCommand command)

Parameters

command CatalogCommand

A command named ClientRegion.

Returns

bool

true when the shape matches.

ReservedIdx(string)

The reserved index of a built-in command, or −1 when name is an application command.

public static int ReservedIdx(string name)

Parameters

name string

The command name.

Returns

int

The reserved index, or −1.