Space Engineers
Public Member Functions | Static Public Attributes | Properties | List of all members
VRage.Network.NetworkId Struct Reference

Network object identifier. Similar to entity id, but on network. Also one entity can have multiple NetworkIds, one main, one for physics sync, one for terminal sync and more. Opaque struct, it should not be necessary to internal member outside VRage.Network. NetworkId is not persistent and changes with server restart, never store it in persistent storage (saves). Internally takes advantage of small numbers. More...

Inheritance diagram for VRage.Network.NetworkId:

Public Member Functions

int CompareTo (NetworkId other)
 
bool Equals (NetworkId other)
 
override string ToString ()
 

Static Public Attributes

static readonly NetworkId Invalid = new NetworkId(0)
 

Properties

bool IsInvalid [get]
 
bool IsValid [get]
 

Detailed Description

Network object identifier. Similar to entity id, but on network. Also one entity can have multiple NetworkIds, one main, one for physics sync, one for terminal sync and more. Opaque struct, it should not be necessary to internal member outside VRage.Network. NetworkId is not persistent and changes with server restart, never store it in persistent storage (saves). Internally takes advantage of small numbers.

Definition at line 15 of file NetworkId.cs.

Member Function Documentation

int VRage.Network.NetworkId.CompareTo ( NetworkId  other)
inline

Definition at line 29 of file NetworkId.cs.

bool VRage.Network.NetworkId.Equals ( NetworkId  other)
inline

Definition at line 34 of file NetworkId.cs.

override string VRage.Network.NetworkId.ToString ( )
inline

Definition at line 39 of file NetworkId.cs.

Member Data Documentation

readonly NetworkId VRage.Network.NetworkId.Invalid = new NetworkId(0)
static

Definition at line 17 of file NetworkId.cs.

Property Documentation

bool VRage.Network.NetworkId.IsInvalid
get

Definition at line 21 of file NetworkId.cs.

bool VRage.Network.NetworkId.IsValid
get

Definition at line 22 of file NetworkId.cs.


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