Tes::Net::ServerInfoMessage Struct Reference

A system control message defining some global information about the server. More...

List of all members.

Public Member Functions
bool	Read (BinaryReader reader)
	Read the message from the given reader .
bool	Write (PacketBuffer packet)
	Write this message to packet .
Public Attributes
const int	ReservedBytes = 31
	Number of bytes reserved in the stream.
ulong	TimeUnit
	Specifies the time unit in a ControlMessageID.EndFrame ControlMessage.
uint	DefaultFrameTime
	The default end of frame time delta.
CoordinateFrame	CoordinateFrame
	Specifies the coordinate frame for the server.
fixed byte	Reserved [ReservedBytes]
	Reserved for future use.
Properties
bool	IsLeftHanded [get]
	Derived property checking if the CoordinateFrame is left handled.
static ServerInfoMessage	Default [get]
	Instantiates the default server info message.

---

Detailed Description

A system control message defining some global information about the server.

---

Member Function Documentation

bool Tes::Net::ServerInfoMessage::Read

(

BinaryReader

reader

)

[inline]

Read the message from the given reader .

Parameters:

reader

The reader to read from.

Returns:

True

bool Tes::Net::ServerInfoMessage::Write

(

PacketBuffer

packet

)

[inline]

Write this message to packet .

Parameters:

packet

The packet to write to.

Returns:

True

---

Member Data Documentation

CoordinateFrame Tes::Net::ServerInfoMessage::CoordinateFrame

Specifies the coordinate frame for the server.

Written as a single byte.

uint Tes::Net::ServerInfoMessage::DefaultFrameTime

The default end of frame time delta.

This value is used for any ControlMessageID.EndFrame message which has a zero time delta. The value is used as if it were the value specified in the ControlMessageID.EndFrame message, thus it must be multiplied by the TimeUnit.

fixed byte Tes::Net::ServerInfoMessage::Reserved[ReservedBytes]

Reserved for future use.

The reserved byte count is set in ReservedBytes.

ulong Tes::Net::ServerInfoMessage::TimeUnit

Specifies the time unit in a ControlMessageID.EndFrame ControlMessage.

This value specifies the number of milliseconds microseconds associated with each time value in a ControlMessageID.EndFrame message. For example, consider a TimeUnit of 1000us, and a ControlMessageID.EndFrame value of 33. This means that the frame represents 33 TimeUnit increments of time, or 33 * 1000us = 33000ms = 33ms.

The default TimeUnit is 1000us (1 millisecond).

---

Property Documentation

ServerInfoMessage Tes::Net::ServerInfoMessage::Default [static, get]

Instantiates the default server info message.

Uses the following defaults:

Datum	Value
TimeUnit	1000 microseconds
DefaultFrameTime	33 (milliseconds)
CoordinateFrame	XYZ
Reserved	0

bool Tes::Net::ServerInfoMessage::IsLeftHanded [get]

Derived property checking if the CoordinateFrame is left handled.

true the coordinate frame is left handed; otherwise, false.

---

The documentation for this struct was generated from the following file:

• ServerInfoMessage.cs