Space Engineers
Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Properties | List of all members
Sandbox.Engine.Multiplayer.MyClientState Class Referenceabstract

Client state, can be defined per-game. More...

Inheritance diagram for Sandbox.Engine.Multiplayer.MyClientState:
VRage.Network.MyClientStateBase Multiplayer.MySpaceClientState

Public Types

enum  MyContextKind {
  MyContextKind.None = 0, MyContextKind.Terminal = 1, MyContextKind.Inventory = 2, MyContextKind.Production = 3,
  MyContextKind.Building = 4
}
 

Public Member Functions

override void Serialize (BitStream stream, bool outOfOrder)
 Serializes state into/from bit stream. EndpointId should be ignored. More...
 
override void Update ()
 

Public Attributes

readonly Dictionary< long, HashSet< long > > KnownSectors = new Dictionary<long, HashSet<long>>()
 
- Public Attributes inherited from VRage.Network.MyClientStateBase
MyTimeSpan ClientTimeStamp
 

Protected Member Functions

virtual void GetControlledEntity (out MyEntity controlledEntity, out bool hasControl)
 
abstract void WriteInternal (BitStream stream, MyEntity controlledEntity)
 
abstract void ReadInternal (BitStream stream, MyNetworkClient sender, MyEntity controlledEntity)
 
void WritePlanetSectors (BitStream stream)
 
void ReadPlanetSectors (BitStream stream)
 

Properties

MyContextKind Context [get, protected set]
 Client point of interest, used on server to replicate nearby entities More...
 
MyEntity ContextEntity [get, protected set]
 
override Vector3D Position [get, protected set]
 
override IMyReplicable ControlledReplicable [get]
 
- Properties inherited from VRage.Network.MyClientStateBase
EndpointId EndpointId [get, set]
 Client endpoint, don't serialize it in Serialize() More...
 
long SupportId [get, protected set]
 
virtual Vector3D Position [get, protected set]
 
abstract IMyReplicable ControlledReplicable [get]
 

Detailed Description

Client state, can be defined per-game.

Definition at line 27 of file MyClientState.cs.

Member Enumeration Documentation

Enumerator
None 
Terminal 
Inventory 
Production 
Building 

Definition at line 31 of file MyClientState.cs.

Member Function Documentation

virtual void Sandbox.Engine.Multiplayer.MyClientState.GetControlledEntity ( out MyEntity  controlledEntity,
out bool  hasControl 
)
inlineprotectedvirtual

Definition at line 76 of file MyClientState.cs.

abstract void Sandbox.Engine.Multiplayer.MyClientState.ReadInternal ( BitStream  stream,
MyNetworkClient  sender,
MyEntity  controlledEntity 
)
protectedpure virtual
void Sandbox.Engine.Multiplayer.MyClientState.ReadPlanetSectors ( BitStream  stream)
inlineprotected

Definition at line 228 of file MyClientState.cs.

override void Sandbox.Engine.Multiplayer.MyClientState.Serialize ( BitStream  stream,
bool  outOfOrder 
)
inlinevirtual

Serializes state into/from bit stream. EndpointId should be ignored.

Implements VRage.Network.MyClientStateBase.

Definition at line 59 of file MyClientState.cs.

override void Sandbox.Engine.Multiplayer.MyClientState.Update ( )
inlinevirtual

Implements VRage.Network.MyClientStateBase.

Definition at line 67 of file MyClientState.cs.

abstract void Sandbox.Engine.Multiplayer.MyClientState.WriteInternal ( BitStream  stream,
MyEntity  controlledEntity 
)
protectedpure virtual
void Sandbox.Engine.Multiplayer.MyClientState.WritePlanetSectors ( BitStream  stream)
inlineprotected

Definition at line 191 of file MyClientState.cs.

Member Data Documentation

readonly Dictionary<long, HashSet<long> > Sandbox.Engine.Multiplayer.MyClientState.KnownSectors = new Dictionary<long, HashSet<long>>()

Definition at line 29 of file MyClientState.cs.

Property Documentation

MyContextKind Sandbox.Engine.Multiplayer.MyClientState.Context
getprotected set

Client point of interest, used on server to replicate nearby entities

Definition at line 43 of file MyClientState.cs.

MyEntity Sandbox.Engine.Multiplayer.MyClientState.ContextEntity
getprotected set

Definition at line 44 of file MyClientState.cs.

override IMyReplicable Sandbox.Engine.Multiplayer.MyClientState.ControlledReplicable
get

Definition at line 262 of file MyClientState.cs.

override Vector3D Sandbox.Engine.Multiplayer.MyClientState.Position
getprotected set

Definition at line 51 of file MyClientState.cs.


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