Space Engineers
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Properties | List of all members
Sandbox.Game.GameSystems.MyScenarioSystem Class Reference
Inheritance diagram for Sandbox.Game.GameSystems.MyScenarioSystem:
VRage.Game.Components.MySessionComponentBase VRage.Game.Components.Interfaces.IMyUserInputComponent

Public Types

enum  MyState {
  MyState.Loaded, MyState.JoinScreen, MyState.WaitingForClients, MyState.Running,
  MyState.Ending
}
 

Public Member Functions

 MyScenarioSystem ()
 
override void UpdateBeforeSimulation ()
 
override void LoadData ()
 
- Public Member Functions inherited from VRage.Game.Components.MySessionComponentBase
virtual bool UpdatedBeforeInit ()
 
 MySessionComponentBase ()
 
void SetUpdateOrder (MyUpdateOrder order)
 
virtual void InitFromDefinition (MySessionComponentDefinition definition)
 
virtual void Init (MyObjectBuilder_SessionComponent sessionComponent)
 
virtual MyObjectBuilder_SessionComponent GetObjectBuilder ()
 
void AfterLoadData ()
 
void UnloadDataConditional ()
 
virtual void SaveData ()
 
virtual void BeforeStart ()
 
virtual void Simulate ()
 
virtual void UpdateAfterSimulation ()
 
virtual void UpdatingStopped ()
 
virtual void Draw ()
 
virtual void HandleInput ()
 
override string ToString ()
 

Static Public Member Functions

static void LoadNextScenario (string id)
 
static void LoadMission (string sessionPath, bool multiplayer, MyOnlineModeEnum onlineMode, short maxPlayers, MyGameModeEnum gameMode=MyGameModeEnum.Survival)
 
static void LoadMission (string sessionPath, bool multiplayer, MyOnlineModeEnum onlineMode, short maxPlayers, MyGameModeEnum gameMode, MyObjectBuilder_Checkpoint checkpoint, ulong checkpointSizeInBytes)
 

Static Public Attributes

static int LoadTimeout = 120
 
static MyScenarioSystem Static
 

Protected Member Functions

override void UnloadData ()
 

Properties

MyState GameState [get, set]
 
DateTime ServerPreparationStartTime [get]
 
DateTime ServerStartGameTime [get]
 
- Properties inherited from VRage.Game.Components.MySessionComponentBase
MyUpdateOrder UpdateOrder [get]
 
MyObjectBuilderType ObjectBuilderType [get]
 
bool Loaded [get]
 
bool Initialized [get]
 
MyDefinitionId Definition [get, set]
 
virtual Type[] Dependencies [get]
 
virtual bool IsRequiredByGame [get]
 Indicates whether a session component should be used in current configuration. Example: MyDestructionData component returns true only when game uses Havok Destruction More...
 

Additional Inherited Members

- Public Attributes inherited from VRage.Game.Components.MySessionComponentBase
readonly string DebugName
 
readonly int Priority
 
readonly Type ComponentType
 
IMySession Session
 

Detailed Description

Definition at line 30 of file MyScenarioSystem.cs.

Member Enumeration Documentation

Enumerator
Loaded 
JoinScreen 
WaitingForClients 
Running 
Ending 

Definition at line 40 of file MyScenarioSystem.cs.

Constructor & Destructor Documentation

Sandbox.Game.GameSystems.MyScenarioSystem.MyScenarioSystem ( )
inline

Definition at line 80 of file MyScenarioSystem.cs.

Member Function Documentation

override void Sandbox.Game.GameSystems.MyScenarioSystem.LoadData ( )
inlinevirtual

Reimplemented from VRage.Game.Components.MySessionComponentBase.

Definition at line 226 of file MyScenarioSystem.cs.

static void Sandbox.Game.GameSystems.MyScenarioSystem.LoadMission ( string  sessionPath,
bool  multiplayer,
MyOnlineModeEnum  onlineMode,
short  maxPlayers,
MyGameModeEnum  gameMode = MyGameModeEnum.Survival 
)
inlinestatic

Definition at line 472 of file MyScenarioSystem.cs.

static void Sandbox.Game.GameSystems.MyScenarioSystem.LoadMission ( string  sessionPath,
bool  multiplayer,
MyOnlineModeEnum  onlineMode,
short  maxPlayers,
MyGameModeEnum  gameMode,
MyObjectBuilder_Checkpoint  checkpoint,
ulong  checkpointSizeInBytes 
)
inlinestatic

Definition at line 483 of file MyScenarioSystem.cs.

static void Sandbox.Game.GameSystems.MyScenarioSystem.LoadNextScenario ( string  id)
inlinestatic

Definition at line 347 of file MyScenarioSystem.cs.

override void Sandbox.Game.GameSystems.MyScenarioSystem.UnloadData ( )
inlineprotectedvirtual

Reimplemented from VRage.Game.Components.MySessionComponentBase.

Definition at line 243 of file MyScenarioSystem.cs.

override void Sandbox.Game.GameSystems.MyScenarioSystem.UpdateBeforeSimulation ( )
inlinevirtual

Reimplemented from VRage.Game.Components.MySessionComponentBase.

Definition at line 138 of file MyScenarioSystem.cs.

Member Data Documentation

int Sandbox.Game.GameSystems.MyScenarioSystem.LoadTimeout = 120
static

Definition at line 32 of file MyScenarioSystem.cs.

MyScenarioSystem Sandbox.Game.GameSystems.MyScenarioSystem.Static
static

Definition at line 33 of file MyScenarioSystem.cs.

Property Documentation

MyState Sandbox.Game.GameSystems.MyScenarioSystem.GameState
getset

Definition at line 51 of file MyScenarioSystem.cs.

DateTime Sandbox.Game.GameSystems.MyScenarioSystem.ServerPreparationStartTime
get

Definition at line 70 of file MyScenarioSystem.cs.

DateTime Sandbox.Game.GameSystems.MyScenarioSystem.ServerStartGameTime
get

Definition at line 72 of file MyScenarioSystem.cs.


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