Space Engineers
Public Member Functions | Properties | List of all members
Sandbox.Game.SessionComponents.MyCampaignSessionComponent Class Reference

Maintains a state machine that holds campain progress. This session component is shared with newly loaded campaign worlds and serialized on session saving. More...

Inheritance diagram for Sandbox.Game.SessionComponents.MyCampaignSessionComponent:
VRage.Game.Components.MySessionComponentBase VRage.Game.Components.Interfaces.IMyUserInputComponent

Public Member Functions

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

Properties

string CampaignLevelOutcome [get, set]
 
bool Running [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
 
- Protected Member Functions inherited from VRage.Game.Components.MySessionComponentBase
virtual void UnloadData ()
 

Detailed Description

Maintains a state machine that holds campain progress. This session component is shared with newly loaded campaign worlds and serialized on session saving.

Definition at line 32 of file MyCampaignSessionComponent.cs.

Member Function Documentation

override MyObjectBuilder_SessionComponent Sandbox.Game.SessionComponents.MyCampaignSessionComponent.GetObjectBuilder ( )
inlinevirtual

Reimplemented from VRage.Game.Components.MySessionComponentBase.

Definition at line 229 of file MyCampaignSessionComponent.cs.

override void Sandbox.Game.SessionComponents.MyCampaignSessionComponent.Init ( MyObjectBuilder_SessionComponent  sessionComponent)
inlinevirtual

Reimplemented from VRage.Game.Components.MySessionComponentBase.

Definition at line 209 of file MyCampaignSessionComponent.cs.

void Sandbox.Game.SessionComponents.MyCampaignSessionComponent.InitFromActive ( )
inline

Definition at line 200 of file MyCampaignSessionComponent.cs.

void Sandbox.Game.SessionComponents.MyCampaignSessionComponent.LoadNextCampaignMission ( )
inline

Definition at line 145 of file MyCampaignSessionComponent.cs.

Property Documentation

string Sandbox.Game.SessionComponents.MyCampaignSessionComponent.CampaignLevelOutcome
getset

Definition at line 44 of file MyCampaignSessionComponent.cs.

bool Sandbox.Game.SessionComponents.MyCampaignSessionComponent.Running
get

Definition at line 46 of file MyCampaignSessionComponent.cs.


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