Space Engineers
Public Member Functions | Protected Member Functions | Properties | List of all members
Sandbox.Definitions.MyComponentGroupDefinition Class Reference
Inheritance diagram for Sandbox.Definitions.MyComponentGroupDefinition:
VRage.Game.MyDefinitionBase

Public Member Functions

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

Protected Member Functions

override void Init (MyObjectBuilder_DefinitionBase builder)
 

Properties

bool IsValid [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...
 

Additional Inherited Members

- 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
 

Detailed Description

Definition at line 16 of file MyComponentGroupDefinition.cs.

Constructor & Destructor Documentation

Sandbox.Definitions.MyComponentGroupDefinition.MyComponentGroupDefinition ( )
inline

Definition at line 30 of file MyComponentGroupDefinition.cs.

Member Function Documentation

MyComponentDefinition Sandbox.Definitions.MyComponentGroupDefinition.GetComponentDefinition ( int  amount)
inline

Definition at line 95 of file MyComponentGroupDefinition.cs.

int Sandbox.Definitions.MyComponentGroupDefinition.GetComponentNumber ( )
inline

Definition at line 104 of file MyComponentGroupDefinition.cs.

override void Sandbox.Definitions.MyComponentGroupDefinition.Init ( MyObjectBuilder_DefinitionBase  builder)
inlineprotectedvirtual

Reimplemented from VRage.Game.MyDefinitionBase.

Definition at line 35 of file MyComponentGroupDefinition.cs.

void Sandbox.Definitions.MyComponentGroupDefinition.Postprocess ( )
inlinevirtual

Override this in case you want to do some postprocessing of the definition before the game starts.

TODO: Obsolete me

Postprocess is useful if you want to process the definition before the game begins,

but you only want to do it when all the definitions are loaded and merged.

Reimplemented from VRage.Game.MyDefinitionBase.

Definition at line 43 of file MyComponentGroupDefinition.cs.

void Sandbox.Definitions.MyComponentGroupDefinition.SetComponentDefinition ( int  amount,
MyComponentDefinition  definition 
)
inline

Definition at line 84 of file MyComponentGroupDefinition.cs.

Property Documentation

bool Sandbox.Definitions.MyComponentGroupDefinition.IsValid
get

Definition at line 21 of file MyComponentGroupDefinition.cs.


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