MySessionComponentDefinition Class

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

[Missing <summary> documentation for "T:VRage.Game.Components.Session.MySessionComponentDefinition"]

Inheritance Hierarchy

Namespace: VRage.Game.Components.Session
Assembly: VRage.Game (in VRage.Game.dll) Version: 1.0.0.0

Syntax

public class MySessionComponentDefinition : MyDefinitionBase

The MySessionComponentDefinition type exposes the following members.

Constructors

	Name	Description
	MySessionComponentDefinition	Initializes a new instance of the MySessionComponentDefinition class

Properties

	Name	Description
	DescriptionText	Use this property when showing description in GUI, as it takes into account more complex description construction. (Inherited from MyDefinitionBase.)
	DisplayNameText	Use this property when showing name in GUI instead of DisplayName. This takes into account more complex name construction. (Inherited from MyDefinitionBase.)

Methods

	Name	Description
	GetObjectBuilder	(Inherited from MyDefinitionBase.)
	Init	(Inherited from MyDefinitionBase.)
	Postprocess	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. (Inherited from MyDefinitionBase.)
	ToString	(Inherited from MyDefinitionBase.)

Fields

	Name	Description
	AvailableInSurvival	(Inherited from MyDefinitionBase.)
	Context	(Inherited from MyDefinitionBase.)
	DescriptionEnum	Enum used for localization of description. Null for player created definitions. (Inherited from MyDefinitionBase.)
	DescriptionString	String used for user created description which do not have localization support. (Inherited from MyDefinitionBase.)
	DisplayNameEnum	Enum used for localization of display name. Null for player created definitions. (Inherited from MyDefinitionBase.)
	DisplayNameString	String name used for user created definitions which do not have localization support. (Inherited from MyDefinitionBase.)
	Enabled	Definition can be disabled by mod, then it will be removed from definition manager (Inherited from MyDefinitionBase.)
	Icons	Icons for the definition, they are used from top to bottom. (Inherited from MyDefinitionBase.)
	Id	(Inherited from MyDefinitionBase.)
	Public	Indicates if definition should be offered in Cube builder (Inherited from MyDefinitionBase.)