Click or drag to resize
MyDefinitionBase Class

[This is preliminary documentation and is subject to change.]

[Missing <summary> documentation for "T:VRage.Game.MyDefinitionBase"]

Inheritance Hierarchy

Namespace: VRage.Game
Assembly: VRage.Game (in VRage.Game.dll) Version: 1.0.0.0
Syntax
C#
public class MyDefinitionBase

The MyDefinitionBase type exposes the following members.

Constructors
  NameDescription
Public methodMyDefinitionBase
Initializes a new instance of the MyDefinitionBase class
Top
Properties
  NameDescription
Public propertyDescriptionText
Use this property when showing description in GUI, as it takes into account more complex description construction.
Public propertyDisplayNameText
Use this property when showing name in GUI instead of DisplayName. This takes into account more complex name construction.
Top
Methods
  NameDescription
Public methodGetObjectBuilder
Public methodInit
Public methodPostprocess
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.

Public methodToString (Overrides ObjectToString.)
Top
Fields
  NameDescription
Public fieldAvailableInSurvival
Public fieldContext
Public fieldDescriptionEnum
Enum used for localization of description. Null for player created definitions.
Public fieldDescriptionString
String used for user created description which do not have localization support.
Public fieldDisplayNameEnum
Enum used for localization of display name. Null for player created definitions.
Public fieldDisplayNameString
String name used for user created definitions which do not have localization support.
Public fieldEnabled
Definition can be disabled by mod, then it will be removed from definition manager
Public fieldIcons
Icons for the definition, they are used from top to bottom.
Public fieldId
Public fieldPublic
Indicates if definition should be offered in Cube builder
Top
See Also