Sandbox.Definitions.MyScenarioDefinition Class Reference

Inheritance diagram for Sandbox.Definitions.MyScenarioDefinition:

Classes
struct	StartingItem
struct	StartingPhysicalItem

Public Member Functions
override MyObjectBuilder_DefinitionBase	GetObjectBuilder ()
Public Member Functions inherited from VRage.Game.MyDefinitionBase
void	Init (MyObjectBuilder_DefinitionBase builder, MyModContext modContext)
virtual void	Postprocess ()
	Override this in case you want to do some postprocessing of the definition before the game starts. More...
void	Save (string filepath)
override string	ToString ()

Public Attributes
MyDefinitionId	GameDefinition
MyDefinitionId	Environment
BoundingBoxD	WorldBoundaries
MyWorldGeneratorStartingStateBase[]	PossiblePlayerStarts
MyWorldGeneratorOperationBase[]	WorldGeneratorOperations
bool	AsteroidClustersEnabled
float	AsteroidClustersOffset
bool	CentralClusterEnabled
MyEnvironmentHostilityEnum	DefaultEnvironment
MyStringId[]	CreativeModeWeapons
MyStringId[]	SurvivalModeWeapons
StartingItem[]	CreativeModeComponents
StartingItem[]	SurvivalModeComponents
StartingPhysicalItem[]	CreativeModePhysicalItems
StartingPhysicalItem[]	SurvivalModePhysicalItems
StartingItem[]	CreativeModeAmmoItems
StartingItem[]	SurvivalModeAmmoItems
MyObjectBuilder_InventoryItem[]	CreativeInventoryItems
MyObjectBuilder_InventoryItem[]	SurvivalInventoryItems
MyObjectBuilder_Toolbar	CreativeDefaultToolbar
MyObjectBuilder_Toolbar	SurvivalDefaultToolbar
MyStringId	MainCharacterModel
DateTime	GameDate
Vector3	SunDirection
Public Attributes inherited from VRage.Game.MyDefinitionBase
MyDefinitionId	Id
MyStringId	DisplayNameEnum
	Enum used for localization of display name. Null for player created definitions. More...
MyStringId	DescriptionEnum
	Enum used for localization of description. Null for player created definitions. More...
String	DisplayNameString
	String name used for user created definitions which do not have localization support. More...
String	DescriptionString
	String used for user created description which do not have localization support. More...
string[]	Icons
	Icons for the definition, they are used from top to bottom. More...
bool	Enabled = true
	Definition can be disabled by mod, then it will be removed from definition manager More...
bool	Public = true
	Indicates if definition should be offered in Cube builder More...
bool	AvailableInSurvival
MyModContext	Context

Protected Member Functions
override void	Init (MyObjectBuilder_DefinitionBase builder)

Properties
bool	HasPlanets [get]
MyObjectBuilder_Toolbar	DefaultToolbar [get]
Properties inherited from VRage.Game.MyDefinitionBase
virtual String	DisplayNameText [get]
	Use this property when showing name in GUI instead of DisplayName. This takes into account more complex name construction. More...
virtual String	DescriptionText [get]
	Use this property when showing description in GUI, as it takes into account more complex description construction. More...

Detailed Description

Definition at line 19 of file MyScenarioDefinition.cs.

Member Function Documentation

override MyObjectBuilder_DefinitionBase Sandbox.Definitions.MyScenarioDefinition.GetObjectBuilder ( )

inlinevirtual

Reimplemented from VRage.Game.MyDefinitionBase.

Definition at line 206 of file MyScenarioDefinition.cs.

override void Sandbox.Definitions.MyScenarioDefinition.Init ( MyObjectBuilder_DefinitionBase  builder )

inlineprotectedvirtual

Reimplemented from VRage.Game.MyDefinitionBase.

Definition at line 81 of file MyScenarioDefinition.cs.

Member Data Documentation

bool Sandbox.Definitions.MyScenarioDefinition.AsteroidClustersEnabled

Definition at line 28 of file MyScenarioDefinition.cs.

float Sandbox.Definitions.MyScenarioDefinition.AsteroidClustersOffset

Definition at line 29 of file MyScenarioDefinition.cs.

bool Sandbox.Definitions.MyScenarioDefinition.CentralClusterEnabled

Definition at line 30 of file MyScenarioDefinition.cs.

MyObjectBuilder_Toolbar Sandbox.Definitions.MyScenarioDefinition.CreativeDefaultToolbar

Definition at line 44 of file MyScenarioDefinition.cs.

MyObjectBuilder_InventoryItem [] Sandbox.Definitions.MyScenarioDefinition.CreativeInventoryItems

Definition at line 41 of file MyScenarioDefinition.cs.

StartingItem [] Sandbox.Definitions.MyScenarioDefinition.CreativeModeAmmoItems

Definition at line 38 of file MyScenarioDefinition.cs.

StartingItem [] Sandbox.Definitions.MyScenarioDefinition.CreativeModeComponents

Definition at line 34 of file MyScenarioDefinition.cs.

StartingPhysicalItem [] Sandbox.Definitions.MyScenarioDefinition.CreativeModePhysicalItems

Definition at line 36 of file MyScenarioDefinition.cs.

MyStringId [] Sandbox.Definitions.MyScenarioDefinition.CreativeModeWeapons

Definition at line 32 of file MyScenarioDefinition.cs.

MyEnvironmentHostilityEnum Sandbox.Definitions.MyScenarioDefinition.DefaultEnvironment

Definition at line 31 of file MyScenarioDefinition.cs.

MyDefinitionId Sandbox.Definitions.MyScenarioDefinition.Environment

Definition at line 23 of file MyScenarioDefinition.cs.

DateTime Sandbox.Definitions.MyScenarioDefinition.GameDate

Definition at line 64 of file MyScenarioDefinition.cs.

MyDefinitionId Sandbox.Definitions.MyScenarioDefinition.GameDefinition

Definition at line 21 of file MyScenarioDefinition.cs.

MyStringId Sandbox.Definitions.MyScenarioDefinition.MainCharacterModel

Definition at line 46 of file MyScenarioDefinition.cs.

MyWorldGeneratorStartingStateBase [] Sandbox.Definitions.MyScenarioDefinition.PossiblePlayerStarts

Definition at line 26 of file MyScenarioDefinition.cs.

Vector3 Sandbox.Definitions.MyScenarioDefinition.SunDirection

Definition at line 66 of file MyScenarioDefinition.cs.

MyObjectBuilder_Toolbar Sandbox.Definitions.MyScenarioDefinition.SurvivalDefaultToolbar

Definition at line 45 of file MyScenarioDefinition.cs.

MyObjectBuilder_InventoryItem [] Sandbox.Definitions.MyScenarioDefinition.SurvivalInventoryItems

Definition at line 42 of file MyScenarioDefinition.cs.

StartingItem [] Sandbox.Definitions.MyScenarioDefinition.SurvivalModeAmmoItems

Definition at line 39 of file MyScenarioDefinition.cs.

StartingItem [] Sandbox.Definitions.MyScenarioDefinition.SurvivalModeComponents

Definition at line 35 of file MyScenarioDefinition.cs.

StartingPhysicalItem [] Sandbox.Definitions.MyScenarioDefinition.SurvivalModePhysicalItems

Definition at line 37 of file MyScenarioDefinition.cs.

MyStringId [] Sandbox.Definitions.MyScenarioDefinition.SurvivalModeWeapons

Definition at line 33 of file MyScenarioDefinition.cs.

BoundingBoxD Sandbox.Definitions.MyScenarioDefinition.WorldBoundaries

Definition at line 25 of file MyScenarioDefinition.cs.

MyWorldGeneratorOperationBase [] Sandbox.Definitions.MyScenarioDefinition.WorldGeneratorOperations

Definition at line 27 of file MyScenarioDefinition.cs.

Property Documentation

MyObjectBuilder_Toolbar Sandbox.Definitions.MyScenarioDefinition.DefaultToolbar

get

Definition at line 77 of file MyScenarioDefinition.cs.

bool Sandbox.Definitions.MyScenarioDefinition.HasPlanets

get

Definition at line 69 of file MyScenarioDefinition.cs.

---

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

• Sources/Sandbox.Game/Definitions/MyScenarioDefinition.cs