Space Engineers
Classes | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Static Protected Member Functions | Properties | Events | List of all members
Sandbox.Engine.Multiplayer.MyMultiplayerBase Class Referenceabstract
Inheritance diagram for Sandbox.Engine.Multiplayer.MyMultiplayerBase:
Sandbox.Engine.Multiplayer.MyMultiplayerClientBase Sandbox.Engine.Multiplayer.MyMultiplayerServerBase Sandbox.Engine.Multiplayer.MyMultiplayerClient Sandbox.Engine.Multiplayer.MyMultiplayerLobbyClient Sandbox.Engine.Multiplayer.MyDedicatedServerBase Sandbox.Engine.Multiplayer.MyMultiplayerLobby Sandbox.Engine.Multiplayer.MyDedicatedServer

Classes

struct  MyConnectedClientData
 

Public Member Functions

abstract bool IsCorrectVersion ()
 
void SendAck (ulong sendTo, int channel, int index, int head)
 
void SendHeaderAck (ulong sendTo, int channel)
 
virtual MyDownloadWorldResult DownloadWorld ()
 
virtual void DownloadProfiler (int index)
 
abstract void DisconnectClient (ulong userId)
 
abstract void KickClient (ulong userId)
 
abstract void BanClient (ulong userId, bool banned)
 
MyObjectBuilder_World ProcessWorldDownloadResult (MyDownloadWorldResult result)
 
void StartProcessingClientMessages ()
 Call when downloaded world is loaded More...
 
virtual void StartProcessingClientMessagesWithEmptyWorld ()
 Call when empty world is created (battle lobby) More...
 
void MarkPhysicsDirty (MySyncEntity entity)
 
void ReportReplicatedObjects ()
 
virtual void Tick ()
 
abstract void SendChatMessage (string text)
 
virtual void Dispose ()
 
abstract ulong GetMemberByIndex (int memberIndex)
 
abstract string GetMemberName (ulong steamUserID)
 
abstract ulong GetOwner ()
 
abstract bool IsAdmin (ulong steamID)
 
abstract void SetOwner (ulong owner)
 
abstract LobbyTypeEnum GetLobbyType ()
 
abstract void SetLobbyType (LobbyTypeEnum type)
 
abstract void SetMemberLimit (int limit)
 
void SendAllMembersDataToClient (ulong clientId)
 
virtual void OnAllMembersData (ref AllMembersDataMsg msg)
 

Static Public Member Functions

static void OnSetPriorityMultiplier (float priority)
 
static void SendElapsedGameTime ()
 
static void SendScriptedChatMessage (ref ScriptedChatMsg msg)
 

Public Attributes

readonly MySyncLayer SyncLayer
 

Protected Member Functions

virtual void SetReplicationLayer (MyReplicationLayer layer)
 
void SendControlMessage< T > (ulong user, ref T message, bool reliable=true)
 
void OnAck (ref MyControlAckMessageMsg msg, ulong send)
 
void OnHeaderAck (ref MyControlAckHeaderMessageMsg msg, ulong send)
 
void OnWorldRequest (ref MyControlWorldRequestMsg data, ulong sender)
 
abstract void OnClientKick (ref MyControlKickClientMsg data, ulong sender)
 
abstract void OnClientBan (ref MyControlBanClientMsg data, ulong sender)
 
void OnProfilerRequest (ref MyControlProfilerMsg data, ulong sender)
 
virtual void OnChatMessage (ref ChatMsg msg)
 
virtual void OnScriptedChatMessage (ref ScriptedChatMsg msg)
 
void AddKickedClient (ulong userId)
 
void AddBannedClient (ulong userId)
 
void RemoveBannedClient (ulong userId)
 
bool IsClientKickedOrBanned (ulong userId)
 
void RaiseChatMessageReceived (ulong steamUserID, string messageText, ChatEntryTypeEnum chatEntryType)
 
void RaiseScriptedChatMessageReceived (string author, string messageText, string font)
 
void RaiseHostLeft ()
 
void RaiseClientLeft (ulong changedUser, ChatMemberStateChangeEnum stateChange)
 
void RaiseClientJoined (ulong changedUser)
 
void RaiseClientKicked (ulong user)
 
void CloseMemberSessions ()
 
void ProcessAllMembersData (ref AllMembersDataMsg msg)
 
MyClientState CreateClientState ()
 

Static Protected Member Functions

static void SendChatMessage (ref ChatMsg msg)
 

Properties

MyReplicationLayer ReplicationLayer [get]
 
ulong ServerId [get, protected set]
 
abstract bool IsServer [get]
 
float ServerSimulationRatio [get, set]
 
DictionaryReader< string, byte[]> VoxelMapData [get]
 
uint FrameCounter [get]
 
abstract string WorldName [get, set]
 
abstract MyGameModeEnum GameMode [get, set]
 
abstract float InventoryMultiplier [get, set]
 
abstract float AssemblerMultiplier [get, set]
 
abstract float RefineryMultiplier [get, set]
 
abstract float WelderMultiplier [get, set]
 
abstract float GrinderMultiplier [get, set]
 
abstract string HostName [get, set]
 
abstract ulong WorldSize [get, set]
 
abstract int AppVersion [get, set]
 
abstract string DataHash [get, set]
 
abstract int MaxPlayers [get]
 
abstract int ModCount [get, protected set]
 
abstract List< MyObjectBuilder_Checkpoint.ModItemMods [get, set]
 
abstract int ViewDistance [get, set]
 
abstract bool Scenario [get, set]
 
abstract string ScenarioBriefing [get, set]
 
abstract DateTime ScenarioStartTime [get, set]
 
bool IsConnectionDirect [get]
 
bool IsConnectionAlive [get]
 
DateTime LastMessageReceived [get]
 
abstract MemberCollection Members [get]
 
abstract int MemberCount [get]
 
abstract ulong LobbyId [get]
 
abstract int MemberLimit [get, set]
 

Events

Action< ulong > ClientJoined
 
Action< ulong, ChatMemberStateChangeEnum > ClientLeft
 
Action HostLeft
 
Action< ulong, string, ChatEntryTypeEnum > ChatMessageReceived
 
Action< string, string, string > ScriptedChatMessageReceived
 
Action< ulong > ClientKicked
 

Detailed Description

Definition at line 156 of file MyMultiplayerBase.cs.

Member Function Documentation

void Sandbox.Engine.Multiplayer.MyMultiplayerBase.AddBannedClient ( ulong  userId)
inlineprotected

Definition at line 559 of file MyMultiplayerBase.cs.

void Sandbox.Engine.Multiplayer.MyMultiplayerBase.AddKickedClient ( ulong  userId)
inlineprotected

Definition at line 546 of file MyMultiplayerBase.cs.

abstract void Sandbox.Engine.Multiplayer.MyMultiplayerBase.BanClient ( ulong  userId,
bool  banned 
)
pure virtual
void Sandbox.Engine.Multiplayer.MyMultiplayerBase.CloseMemberSessions ( )
inlineprotected

Definition at line 813 of file MyMultiplayerBase.cs.

MyClientState Sandbox.Engine.Multiplayer.MyMultiplayerBase.CreateClientState ( )
inlineprotected

Definition at line 864 of file MyMultiplayerBase.cs.

abstract void Sandbox.Engine.Multiplayer.MyMultiplayerBase.DisconnectClient ( ulong  userId)
pure virtual
virtual void Sandbox.Engine.Multiplayer.MyMultiplayerBase.Dispose ( )
inlinevirtual
virtual void Sandbox.Engine.Multiplayer.MyMultiplayerBase.DownloadProfiler ( int  index)
inlinevirtual

Reimplemented in Sandbox.Engine.Multiplayer.MyMultiplayerClient.

Definition at line 537 of file MyMultiplayerBase.cs.

virtual MyDownloadWorldResult Sandbox.Engine.Multiplayer.MyMultiplayerBase.DownloadWorld ( )
inlinevirtual
abstract LobbyTypeEnum Sandbox.Engine.Multiplayer.MyMultiplayerBase.GetLobbyType ( )
pure virtual
abstract ulong Sandbox.Engine.Multiplayer.MyMultiplayerBase.GetMemberByIndex ( int  memberIndex)
pure virtual
abstract string Sandbox.Engine.Multiplayer.MyMultiplayerBase.GetMemberName ( ulong  steamUserID)
pure virtual
abstract ulong Sandbox.Engine.Multiplayer.MyMultiplayerBase.GetOwner ( )
pure virtual
abstract bool Sandbox.Engine.Multiplayer.MyMultiplayerBase.IsAdmin ( ulong  steamID)
pure virtual
bool Sandbox.Engine.Multiplayer.MyMultiplayerBase.IsClientKickedOrBanned ( ulong  userId)
inlineprotected

Definition at line 577 of file MyMultiplayerBase.cs.

abstract bool Sandbox.Engine.Multiplayer.MyMultiplayerBase.IsCorrectVersion ( )
pure virtual
abstract void Sandbox.Engine.Multiplayer.MyMultiplayerBase.KickClient ( ulong  userId)
pure virtual
void Sandbox.Engine.Multiplayer.MyMultiplayerBase.MarkPhysicsDirty ( MySyncEntity  entity)
inline

Definition at line 619 of file MyMultiplayerBase.cs.

void Sandbox.Engine.Multiplayer.MyMultiplayerBase.OnAck ( ref MyControlAckMessageMsg  msg,
ulong  send 
)
inlineprotected

Definition at line 412 of file MyMultiplayerBase.cs.

virtual void Sandbox.Engine.Multiplayer.MyMultiplayerBase.OnAllMembersData ( ref AllMembersDataMsg  msg)
inlinevirtual
virtual void Sandbox.Engine.Multiplayer.MyMultiplayerBase.OnChatMessage ( ref ChatMsg  msg)
inlineprotectedvirtual
abstract void Sandbox.Engine.Multiplayer.MyMultiplayerBase.OnClientBan ( ref MyControlBanClientMsg  data,
ulong  sender 
)
protectedpure virtual
abstract void Sandbox.Engine.Multiplayer.MyMultiplayerBase.OnClientKick ( ref MyControlKickClientMsg  data,
ulong  sender 
)
protectedpure virtual
void Sandbox.Engine.Multiplayer.MyMultiplayerBase.OnHeaderAck ( ref MyControlAckHeaderMessageMsg  msg,
ulong  send 
)
inlineprotected

Definition at line 428 of file MyMultiplayerBase.cs.

void Sandbox.Engine.Multiplayer.MyMultiplayerBase.OnProfilerRequest ( ref MyControlProfilerMsg  data,
ulong  sender 
)
inlineprotected

Definition at line 496 of file MyMultiplayerBase.cs.

virtual void Sandbox.Engine.Multiplayer.MyMultiplayerBase.OnScriptedChatMessage ( ref ScriptedChatMsg  msg)
inlineprotectedvirtual

Definition at line 516 of file MyMultiplayerBase.cs.

static void Sandbox.Engine.Multiplayer.MyMultiplayerBase.OnSetPriorityMultiplier ( float  priority)
inlinestatic

Definition at line 231 of file MyMultiplayerBase.cs.

void Sandbox.Engine.Multiplayer.MyMultiplayerBase.OnWorldRequest ( ref MyControlWorldRequestMsg  data,
ulong  sender 
)
inlineprotected

Definition at line 450 of file MyMultiplayerBase.cs.

void Sandbox.Engine.Multiplayer.MyMultiplayerBase.ProcessAllMembersData ( ref AllMembersDataMsg  msg)
inlineprotected

Definition at line 849 of file MyMultiplayerBase.cs.

MyObjectBuilder_World Sandbox.Engine.Multiplayer.MyMultiplayerBase.ProcessWorldDownloadResult ( MyDownloadWorldResult  result)
inline

Definition at line 582 of file MyMultiplayerBase.cs.

void Sandbox.Engine.Multiplayer.MyMultiplayerBase.RaiseChatMessageReceived ( ulong  steamUserID,
string  messageText,
ChatEntryTypeEnum  chatEntryType 
)
inlineprotected

Definition at line 753 of file MyMultiplayerBase.cs.

void Sandbox.Engine.Multiplayer.MyMultiplayerBase.RaiseClientJoined ( ulong  changedUser)
inlineprotected

Definition at line 781 of file MyMultiplayerBase.cs.

void Sandbox.Engine.Multiplayer.MyMultiplayerBase.RaiseClientKicked ( ulong  user)
inlineprotected

Definition at line 788 of file MyMultiplayerBase.cs.

void Sandbox.Engine.Multiplayer.MyMultiplayerBase.RaiseClientLeft ( ulong  changedUser,
ChatMemberStateChangeEnum  stateChange 
)
inlineprotected

Definition at line 774 of file MyMultiplayerBase.cs.

void Sandbox.Engine.Multiplayer.MyMultiplayerBase.RaiseHostLeft ( )
inlineprotected

Definition at line 767 of file MyMultiplayerBase.cs.

void Sandbox.Engine.Multiplayer.MyMultiplayerBase.RaiseScriptedChatMessageReceived ( string  author,
string  messageText,
string  font 
)
inlineprotected

Definition at line 760 of file MyMultiplayerBase.cs.

void Sandbox.Engine.Multiplayer.MyMultiplayerBase.RemoveBannedClient ( ulong  userId)
inlineprotected

Definition at line 572 of file MyMultiplayerBase.cs.

void Sandbox.Engine.Multiplayer.MyMultiplayerBase.ReportReplicatedObjects ( )
inline

Definition at line 629 of file MyMultiplayerBase.cs.

void Sandbox.Engine.Multiplayer.MyMultiplayerBase.SendAck ( ulong  sendTo,
int  channel,
int  index,
int  head 
)
inline

Definition at line 364 of file MyMultiplayerBase.cs.

void Sandbox.Engine.Multiplayer.MyMultiplayerBase.SendAllMembersDataToClient ( ulong  clientId)
inline

Definition at line 825 of file MyMultiplayerBase.cs.

abstract void Sandbox.Engine.Multiplayer.MyMultiplayerBase.SendChatMessage ( string  text)
pure virtual
static void Sandbox.Engine.Multiplayer.MyMultiplayerBase.SendChatMessage ( ref ChatMsg  msg)
inlinestaticprotected

Definition at line 883 of file MyMultiplayerBase.cs.

void Sandbox.Engine.Multiplayer.MyMultiplayerBase.SendControlMessage< T > ( ulong  user,
ref T  message,
bool  reliable = true 
)
inlineprotected
Type Constraints
T :struct 

Definition at line 376 of file MyMultiplayerBase.cs.

static void Sandbox.Engine.Multiplayer.MyMultiplayerBase.SendElapsedGameTime ( )
inlinestatic

Definition at line 869 of file MyMultiplayerBase.cs.

void Sandbox.Engine.Multiplayer.MyMultiplayerBase.SendHeaderAck ( ulong  sendTo,
int  channel 
)
inline

Definition at line 370 of file MyMultiplayerBase.cs.

static void Sandbox.Engine.Multiplayer.MyMultiplayerBase.SendScriptedChatMessage ( ref ScriptedChatMsg  msg)
inlinestatic

Definition at line 888 of file MyMultiplayerBase.cs.

abstract void Sandbox.Engine.Multiplayer.MyMultiplayerBase.SetLobbyType ( LobbyTypeEnum  type)
pure virtual
abstract void Sandbox.Engine.Multiplayer.MyMultiplayerBase.SetMemberLimit ( int  limit)
pure virtual
abstract void Sandbox.Engine.Multiplayer.MyMultiplayerBase.SetOwner ( ulong  owner)
pure virtual
virtual void Sandbox.Engine.Multiplayer.MyMultiplayerBase.SetReplicationLayer ( MyReplicationLayer  layer)
inlineprotectedvirtual

Definition at line 298 of file MyMultiplayerBase.cs.

void Sandbox.Engine.Multiplayer.MyMultiplayerBase.StartProcessingClientMessages ( )
inline

Call when downloaded world is loaded

Definition at line 599 of file MyMultiplayerBase.cs.

virtual void Sandbox.Engine.Multiplayer.MyMultiplayerBase.StartProcessingClientMessagesWithEmptyWorld ( )
inlinevirtual

Call when empty world is created (battle lobby)

Reimplemented in Sandbox.Engine.Multiplayer.MyMultiplayerClient.

Definition at line 609 of file MyMultiplayerBase.cs.

virtual void Sandbox.Engine.Multiplayer.MyMultiplayerBase.Tick ( )
inlinevirtual

Member Data Documentation

readonly MySyncLayer Sandbox.Engine.Multiplayer.MyMultiplayerBase.SyncLayer

Definition at line 164 of file MyMultiplayerBase.cs.

Property Documentation

abstract int Sandbox.Engine.Multiplayer.MyMultiplayerBase.AppVersion
getset

Definition at line 248 of file MyMultiplayerBase.cs.

abstract float Sandbox.Engine.Multiplayer.MyMultiplayerBase.AssemblerMultiplier
getset

Definition at line 242 of file MyMultiplayerBase.cs.

abstract string Sandbox.Engine.Multiplayer.MyMultiplayerBase.DataHash
getset

Definition at line 249 of file MyMultiplayerBase.cs.

uint Sandbox.Engine.Multiplayer.MyMultiplayerBase.FrameCounter
get

Definition at line 237 of file MyMultiplayerBase.cs.

abstract MyGameModeEnum Sandbox.Engine.Multiplayer.MyMultiplayerBase.GameMode
getset

Definition at line 240 of file MyMultiplayerBase.cs.

abstract float Sandbox.Engine.Multiplayer.MyMultiplayerBase.GrinderMultiplier
getset

Definition at line 245 of file MyMultiplayerBase.cs.

abstract string Sandbox.Engine.Multiplayer.MyMultiplayerBase.HostName
getset

Definition at line 246 of file MyMultiplayerBase.cs.

abstract float Sandbox.Engine.Multiplayer.MyMultiplayerBase.InventoryMultiplier
getset

Definition at line 241 of file MyMultiplayerBase.cs.

bool Sandbox.Engine.Multiplayer.MyMultiplayerBase.IsConnectionAlive
get

Definition at line 320 of file MyMultiplayerBase.cs.

bool Sandbox.Engine.Multiplayer.MyMultiplayerBase.IsConnectionDirect
get

Definition at line 307 of file MyMultiplayerBase.cs.

abstract bool Sandbox.Engine.Multiplayer.MyMultiplayerBase.IsServer
get

Definition at line 215 of file MyMultiplayerBase.cs.

DateTime Sandbox.Engine.Multiplayer.MyMultiplayerBase.LastMessageReceived
get

Definition at line 333 of file MyMultiplayerBase.cs.

abstract ulong Sandbox.Engine.Multiplayer.MyMultiplayerBase.LobbyId
get

Definition at line 796 of file MyMultiplayerBase.cs.

abstract int Sandbox.Engine.Multiplayer.MyMultiplayerBase.MaxPlayers
get

Definition at line 250 of file MyMultiplayerBase.cs.

abstract int Sandbox.Engine.Multiplayer.MyMultiplayerBase.MemberCount
get

Definition at line 745 of file MyMultiplayerBase.cs.

abstract int Sandbox.Engine.Multiplayer.MyMultiplayerBase.MemberLimit
getset

Definition at line 805 of file MyMultiplayerBase.cs.

abstract MemberCollection Sandbox.Engine.Multiplayer.MyMultiplayerBase.Members
get

Definition at line 740 of file MyMultiplayerBase.cs.

abstract int Sandbox.Engine.Multiplayer.MyMultiplayerBase.ModCount
getprotected set

Definition at line 251 of file MyMultiplayerBase.cs.

abstract List<MyObjectBuilder_Checkpoint.ModItem> Sandbox.Engine.Multiplayer.MyMultiplayerBase.Mods
getset

Definition at line 252 of file MyMultiplayerBase.cs.

abstract float Sandbox.Engine.Multiplayer.MyMultiplayerBase.RefineryMultiplier
getset

Definition at line 243 of file MyMultiplayerBase.cs.

MyReplicationLayer Sandbox.Engine.Multiplayer.MyMultiplayerBase.ReplicationLayer
get

Definition at line 165 of file MyMultiplayerBase.cs.

abstract bool Sandbox.Engine.Multiplayer.MyMultiplayerBase.Scenario
getset

Definition at line 254 of file MyMultiplayerBase.cs.

abstract string Sandbox.Engine.Multiplayer.MyMultiplayerBase.ScenarioBriefing
getset

Definition at line 255 of file MyMultiplayerBase.cs.

abstract DateTime Sandbox.Engine.Multiplayer.MyMultiplayerBase.ScenarioStartTime
getset

Definition at line 256 of file MyMultiplayerBase.cs.

ulong Sandbox.Engine.Multiplayer.MyMultiplayerBase.ServerId
getprotected set

Definition at line 207 of file MyMultiplayerBase.cs.

float Sandbox.Engine.Multiplayer.MyMultiplayerBase.ServerSimulationRatio
getset

Definition at line 219 of file MyMultiplayerBase.cs.

abstract int Sandbox.Engine.Multiplayer.MyMultiplayerBase.ViewDistance
getset

Definition at line 253 of file MyMultiplayerBase.cs.

DictionaryReader<string, byte[]> Sandbox.Engine.Multiplayer.MyMultiplayerBase.VoxelMapData
get

Definition at line 236 of file MyMultiplayerBase.cs.

abstract float Sandbox.Engine.Multiplayer.MyMultiplayerBase.WelderMultiplier
getset

Definition at line 244 of file MyMultiplayerBase.cs.

abstract string Sandbox.Engine.Multiplayer.MyMultiplayerBase.WorldName
getset

Definition at line 239 of file MyMultiplayerBase.cs.

abstract ulong Sandbox.Engine.Multiplayer.MyMultiplayerBase.WorldSize
getset

Definition at line 247 of file MyMultiplayerBase.cs.

Event Documentation

Action<ulong, string, ChatEntryTypeEnum> Sandbox.Engine.Multiplayer.MyMultiplayerBase.ChatMessageReceived

Definition at line 265 of file MyMultiplayerBase.cs.

Action<ulong> Sandbox.Engine.Multiplayer.MyMultiplayerBase.ClientJoined

Definition at line 262 of file MyMultiplayerBase.cs.

Action<ulong> Sandbox.Engine.Multiplayer.MyMultiplayerBase.ClientKicked

Definition at line 267 of file MyMultiplayerBase.cs.

Action<ulong, ChatMemberStateChangeEnum> Sandbox.Engine.Multiplayer.MyMultiplayerBase.ClientLeft

Definition at line 263 of file MyMultiplayerBase.cs.

Action Sandbox.Engine.Multiplayer.MyMultiplayerBase.HostLeft

Definition at line 264 of file MyMultiplayerBase.cs.

Action<string, string, string> Sandbox.Engine.Multiplayer.MyMultiplayerBase.ScriptedChatMessageReceived

Definition at line 266 of file MyMultiplayerBase.cs.


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