Space Engineers
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Properties | List of all members
Sandbox.Engine.Multiplayer.MyDedicatedServerBase Class Referenceabstract
Inheritance diagram for Sandbox.Engine.Multiplayer.MyDedicatedServerBase:
Sandbox.Engine.Multiplayer.MyMultiplayerServerBase Sandbox.Engine.Multiplayer.MyMultiplayerBase VRage.Replication.IReplicationServerCallback Sandbox.Engine.Multiplayer.MyDedicatedServer

Public Member Functions

override bool IsCorrectVersion ()
 
override MyDownloadWorldResult DownloadWorld ()
 
override void DisconnectClient (ulong userId)
 
override void KickClient (ulong userId)
 
override void BanClient (ulong userId, bool banned)
 
override void Tick ()
 
override void SendChatMessage (string text)
 
void SendJoinResult (ulong sendTo, JoinResult joinResult, ulong adminID=0)
 
override void Dispose ()
 
override ulong GetMemberByIndex (int memberIndex)
 
override ulong GetOwner ()
 
override bool IsAdmin (ulong steamID)
 
override void SetOwner (ulong owner)
 
override LobbyTypeEnum GetLobbyType ()
 
override void SetLobbyType (LobbyTypeEnum type)
 
override void SetMemberLimit (int limit)
 
override string GetMemberName (ulong steamUserID)
 
- Public Member Functions inherited from Sandbox.Engine.Multiplayer.MyMultiplayerServerBase
 MyMultiplayerServerBase (MySyncLayer syncLayer, EndpointId?localClientEndpoint)
 Initializes a new instance of the MyMultiplayerServerBase class. More...
 
void RaiseReplicableCreated (object obj)
 
override void Dispose ()
 
MyTimeSpan GetUpdateTime ()
 
- Public Member Functions inherited from Sandbox.Engine.Multiplayer.MyMultiplayerBase
void SendAck (ulong sendTo, int channel, int index, int head)
 
void SendHeaderAck (ulong sendTo, int channel)
 
virtual void DownloadProfiler (int index)
 
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 ()
 
void SendAllMembersDataToClient (ulong clientId)
 
virtual void OnAllMembersData (ref AllMembersDataMsg msg)
 

Static Public Member Functions

static string ConvertSteamIDFrom64 (ulong from)
 
static ulong ConvertSteamIDTo64 (string from)
 
- Static Public Member Functions inherited from Sandbox.Engine.Multiplayer.MyMultiplayerBase
static void OnSetPriorityMultiplier (float priority)
 
static void SendElapsedGameTime ()
 
static void SendScriptedChatMessage (ref ScriptedChatMsg msg)
 

Static Public Attributes

static readonly string SteamIDPrefix = "STEAM_"
 
static readonly ulong SteamIDMagicConstant = 76561197960265728ul
 

Protected Member Functions

 MyDedicatedServerBase (MySyncLayer syncLayer)
 
void Initialize (IPEndPoint serverEndpoint)
 
abstract void SendServerData ()
 
virtual void UserAccepted (ulong steamID)
 
void OnConnectedClient (ref ConnectedClientDataMsg msg, ulong steamId)
 
override void OnClientKick (ref MyControlKickClientMsg data, ulong sender)
 
override void OnClientBan (ref MyControlBanClientMsg data, ulong sender)
 
- Protected Member Functions inherited from Sandbox.Engine.Multiplayer.MyMultiplayerBase
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)
 
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 ()
 

Protected Attributes

string m_worldName
 
MyGameModeEnum m_gameMode
 
string m_hostName
 
ulong m_worldSize
 
int m_appVersion = MyFinalBuildConstants.APP_VERSION
 
int m_membersLimit
 
string m_dataHash
 
ulong m_groupId
 
List< ulong > m_members = new List<ulong>()
 
Dictionary< ulong, MyConnectedClientDatam_memberData = new Dictionary<ulong, MyConnectedClientData>()
 

Properties

override bool IsServer [get]
 
bool ServerStarted [get, set]
 
string ServerInitError [get, set]
 
bool IsService [get]
 
override string WorldName [get, set]
 
override MyGameModeEnum GameMode [get, set]
 
override string HostName [get, set]
 
override ulong WorldSize [get, set]
 
override int AppVersion [get, set]
 
override string DataHash [get, set]
 
override int MaxPlayers [get]
 
override int ModCount [get, protected set]
 
override List< MyObjectBuilder_Checkpoint.ModItemMods [get, set]
 
override int ViewDistance [get, set]
 
override MemberCollection Members [get]
 
override int MemberCount [get]
 
override ulong LobbyId [get]
 
override int MemberLimit [get, set]
 
- Properties inherited from Sandbox.Engine.Multiplayer.MyMultiplayerServerBase
new MyReplicationServer ReplicationLayer [get]
 
- Properties inherited from Sandbox.Engine.Multiplayer.MyMultiplayerBase
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]
 

Additional Inherited Members

- Public Attributes inherited from Sandbox.Engine.Multiplayer.MyMultiplayerBase
readonly MySyncLayer SyncLayer
 
- Static Protected Member Functions inherited from Sandbox.Engine.Multiplayer.MyMultiplayerBase
static void SendChatMessage (ref ChatMsg msg)
 
- Events inherited from Sandbox.Engine.Multiplayer.MyMultiplayerBase
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 31 of file MyDedicatedServerBase.cs.

Constructor & Destructor Documentation

Sandbox.Engine.Multiplayer.MyDedicatedServerBase.MyDedicatedServerBase ( MySyncLayer  syncLayer)
inlineprotected

Definition at line 169 of file MyDedicatedServerBase.cs.

Member Function Documentation

override void Sandbox.Engine.Multiplayer.MyDedicatedServerBase.BanClient ( ulong  userId,
bool  banned 
)
inlinevirtual
static string Sandbox.Engine.Multiplayer.MyDedicatedServerBase.ConvertSteamIDFrom64 ( ulong  from)
inlinestatic

Definition at line 154 of file MyDedicatedServerBase.cs.

static ulong Sandbox.Engine.Multiplayer.MyDedicatedServerBase.ConvertSteamIDTo64 ( string  from)
inlinestatic

Definition at line 160 of file MyDedicatedServerBase.cs.

override void Sandbox.Engine.Multiplayer.MyDedicatedServerBase.DisconnectClient ( ulong  userId)
inlinevirtual
override void Sandbox.Engine.Multiplayer.MyDedicatedServerBase.Dispose ( )
inlinevirtual

Reimplemented from Sandbox.Engine.Multiplayer.MyMultiplayerBase.

Definition at line 572 of file MyDedicatedServerBase.cs.

override MyDownloadWorldResult Sandbox.Engine.Multiplayer.MyDedicatedServerBase.DownloadWorld ( )
inlinevirtual

Reimplemented from Sandbox.Engine.Multiplayer.MyMultiplayerBase.

Definition at line 479 of file MyDedicatedServerBase.cs.

override LobbyTypeEnum Sandbox.Engine.Multiplayer.MyDedicatedServerBase.GetLobbyType ( )
inlinevirtual
override ulong Sandbox.Engine.Multiplayer.MyDedicatedServerBase.GetMemberByIndex ( int  memberIndex)
inlinevirtual
override string Sandbox.Engine.Multiplayer.MyDedicatedServerBase.GetMemberName ( ulong  steamUserID)
inlinevirtual
override ulong Sandbox.Engine.Multiplayer.MyDedicatedServerBase.GetOwner ( )
inlinevirtual
void Sandbox.Engine.Multiplayer.MyDedicatedServerBase.Initialize ( IPEndPoint  serverEndpoint)
inlineprotected

Definition at line 175 of file MyDedicatedServerBase.cs.

override bool Sandbox.Engine.Multiplayer.MyDedicatedServerBase.IsAdmin ( ulong  steamID)
inlinevirtual
override bool Sandbox.Engine.Multiplayer.MyDedicatedServerBase.IsCorrectVersion ( )
inlinevirtual
override void Sandbox.Engine.Multiplayer.MyDedicatedServerBase.KickClient ( ulong  userId)
inlinevirtual
override void Sandbox.Engine.Multiplayer.MyDedicatedServerBase.OnClientBan ( ref MyControlBanClientMsg  data,
ulong  sender 
)
inlineprotectedvirtual
override void Sandbox.Engine.Multiplayer.MyDedicatedServerBase.OnClientKick ( ref MyControlKickClientMsg  data,
ulong  sender 
)
inlineprotectedvirtual
void Sandbox.Engine.Multiplayer.MyDedicatedServerBase.OnConnectedClient ( ref ConnectedClientDataMsg  msg,
ulong  steamId 
)
inlineprotected

Definition at line 678 of file MyDedicatedServerBase.cs.

override void Sandbox.Engine.Multiplayer.MyDedicatedServerBase.SendChatMessage ( string  text)
inlinevirtual
void Sandbox.Engine.Multiplayer.MyDedicatedServerBase.SendJoinResult ( ulong  sendTo,
JoinResult  joinResult,
ulong  adminID = 0 
)
inline

Definition at line 563 of file MyDedicatedServerBase.cs.

abstract void Sandbox.Engine.Multiplayer.MyDedicatedServerBase.SendServerData ( )
protectedpure virtual
override void Sandbox.Engine.Multiplayer.MyDedicatedServerBase.SetLobbyType ( LobbyTypeEnum  type)
inlinevirtual
override void Sandbox.Engine.Multiplayer.MyDedicatedServerBase.SetMemberLimit ( int  limit)
inlinevirtual
override void Sandbox.Engine.Multiplayer.MyDedicatedServerBase.SetOwner ( ulong  owner)
inlinevirtual
override void Sandbox.Engine.Multiplayer.MyDedicatedServerBase.Tick ( )
inlinevirtual

Reimplemented from Sandbox.Engine.Multiplayer.MyMultiplayerBase.

Definition at line 534 of file MyDedicatedServerBase.cs.

virtual void Sandbox.Engine.Multiplayer.MyDedicatedServerBase.UserAccepted ( ulong  steamID)
inlineprotectedvirtual

Definition at line 445 of file MyDedicatedServerBase.cs.

Member Data Documentation

int Sandbox.Engine.Multiplayer.MyDedicatedServerBase.m_appVersion = MyFinalBuildConstants.APP_VERSION
protected

Definition at line 39 of file MyDedicatedServerBase.cs.

string Sandbox.Engine.Multiplayer.MyDedicatedServerBase.m_dataHash
protected

Definition at line 41 of file MyDedicatedServerBase.cs.

MyGameModeEnum Sandbox.Engine.Multiplayer.MyDedicatedServerBase.m_gameMode
protected

Definition at line 36 of file MyDedicatedServerBase.cs.

ulong Sandbox.Engine.Multiplayer.MyDedicatedServerBase.m_groupId
protected

Definition at line 42 of file MyDedicatedServerBase.cs.

string Sandbox.Engine.Multiplayer.MyDedicatedServerBase.m_hostName
protected

Definition at line 37 of file MyDedicatedServerBase.cs.

Dictionary<ulong, MyConnectedClientData> Sandbox.Engine.Multiplayer.MyDedicatedServerBase.m_memberData = new Dictionary<ulong, MyConnectedClientData>()
protected

Definition at line 47 of file MyDedicatedServerBase.cs.

List<ulong> Sandbox.Engine.Multiplayer.MyDedicatedServerBase.m_members = new List<ulong>()
protected

Definition at line 44 of file MyDedicatedServerBase.cs.

int Sandbox.Engine.Multiplayer.MyDedicatedServerBase.m_membersLimit
protected

Definition at line 40 of file MyDedicatedServerBase.cs.

string Sandbox.Engine.Multiplayer.MyDedicatedServerBase.m_worldName
protected

Definition at line 35 of file MyDedicatedServerBase.cs.

ulong Sandbox.Engine.Multiplayer.MyDedicatedServerBase.m_worldSize
protected

Definition at line 38 of file MyDedicatedServerBase.cs.

readonly ulong Sandbox.Engine.Multiplayer.MyDedicatedServerBase.SteamIDMagicConstant = 76561197960265728ul
static

Definition at line 152 of file MyDedicatedServerBase.cs.

readonly string Sandbox.Engine.Multiplayer.MyDedicatedServerBase.SteamIDPrefix = "STEAM_"
static

Definition at line 151 of file MyDedicatedServerBase.cs.

Property Documentation

override int Sandbox.Engine.Multiplayer.MyDedicatedServerBase.AppVersion
getset

Definition at line 99 of file MyDedicatedServerBase.cs.

override string Sandbox.Engine.Multiplayer.MyDedicatedServerBase.DataHash
getset

Definition at line 105 of file MyDedicatedServerBase.cs.

override MyGameModeEnum Sandbox.Engine.Multiplayer.MyDedicatedServerBase.GameMode
getset

Definition at line 81 of file MyDedicatedServerBase.cs.

override string Sandbox.Engine.Multiplayer.MyDedicatedServerBase.HostName
getset

Definition at line 87 of file MyDedicatedServerBase.cs.

override bool Sandbox.Engine.Multiplayer.MyDedicatedServerBase.IsServer
get

Definition at line 56 of file MyDedicatedServerBase.cs.

bool Sandbox.Engine.Multiplayer.MyDedicatedServerBase.IsService
get

Definition at line 61 of file MyDedicatedServerBase.cs.

override ulong Sandbox.Engine.Multiplayer.MyDedicatedServerBase.LobbyId
get

Definition at line 631 of file MyDedicatedServerBase.cs.

override int Sandbox.Engine.Multiplayer.MyDedicatedServerBase.MaxPlayers
get

Definition at line 111 of file MyDedicatedServerBase.cs.

override int Sandbox.Engine.Multiplayer.MyDedicatedServerBase.MemberCount
get

Definition at line 621 of file MyDedicatedServerBase.cs.

override int Sandbox.Engine.Multiplayer.MyDedicatedServerBase.MemberLimit
getset

Definition at line 636 of file MyDedicatedServerBase.cs.

override MemberCollection Sandbox.Engine.Multiplayer.MyDedicatedServerBase.Members
get

Definition at line 616 of file MyDedicatedServerBase.cs.

override int Sandbox.Engine.Multiplayer.MyDedicatedServerBase.ModCount
getprotected set

Definition at line 117 of file MyDedicatedServerBase.cs.

override List<MyObjectBuilder_Checkpoint.ModItem> Sandbox.Engine.Multiplayer.MyDedicatedServerBase.Mods
getset

Definition at line 128 of file MyDedicatedServerBase.cs.

string Sandbox.Engine.Multiplayer.MyDedicatedServerBase.ServerInitError
getset

Definition at line 59 of file MyDedicatedServerBase.cs.

bool Sandbox.Engine.Multiplayer.MyDedicatedServerBase.ServerStarted
getset

Definition at line 58 of file MyDedicatedServerBase.cs.

override int Sandbox.Engine.Multiplayer.MyDedicatedServerBase.ViewDistance
getset

Definition at line 144 of file MyDedicatedServerBase.cs.

override string Sandbox.Engine.Multiplayer.MyDedicatedServerBase.WorldName
getset

Definition at line 64 of file MyDedicatedServerBase.cs.

override ulong Sandbox.Engine.Multiplayer.MyDedicatedServerBase.WorldSize
getset

Definition at line 93 of file MyDedicatedServerBase.cs.


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