Public Member Functions | |
| 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) |
| virtual MyObjectBuilder_DefinitionBase | GetObjectBuilder () |
| override string | ToString () |
Public Attributes | |
| 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 | |
| virtual void | Init (MyObjectBuilder_DefinitionBase builder) |
Properties | |
| 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 9 of file MyDefinitionBase.cs.
Member Function Documentation
|
inlinevirtual |
Reimplemented in Sandbox.Definitions.MyCubeBlockDefinition, Sandbox.Definitions.MyCharacterDefinition, Sandbox.Definitions.MyScenarioDefinition, Sandbox.Definitions.MyHandItemDefinition, Sandbox.Definitions.MySpawnGroupDefinition, Sandbox.Definitions.MyEnvironmentDefinition, Medieval.Definitions.MyDx11VoxelMaterialDefinition, Sandbox.Definitions.MyVoxelMaterialDefinition, Sandbox.Definitions.MyEntityStatDefinition, Sandbox.Game.EntityComponents.MyInventoryComponentDefinition, Sandbox.Definitions.MyBarbarianWaveEventDefinition, VRage.Game.MyVisualSettingsDefinition, Sandbox.Definitions.MyRopeDefinition, VRage.Game.Definitions.Animation.MyAnimationControllerDefinition, Sandbox.Definitions.MyAreaMarkerDefinition, Sandbox.Game.EntityComponents.MyEntityStatComponentDefinition, VRage.Game.MyPhysicsComponentDefinitionBase, Sandbox.Game.EntityComponents.MyModelComponentDefinition, VRage.Game.MyAudioDefinition, VRage.Game.MyContainerDefinition, VRage.Game.Definitions.MyModStorageComponentDefinition, Sandbox.Game.EntityComponents.MyPhysicsBodyComponentDefinition, Sandbox.Game.EntityComponents.MyTimerComponentDefinition, Sandbox.Definitions.MyGasProperties, and VRage.Game.MyComponentDefinitionBase.
Definition at line 135 of file MyDefinitionBase.cs.
|
inline |
Definition at line 80 of file MyDefinitionBase.cs.
|
inlineprotectedvirtual |
Reimplemented in Sandbox.Definitions.MyCubeBlockDefinition, Sandbox.Definitions.MyPlanetGeneratorDefinition, Sandbox.Game.WorldEnvironment.Definitions.MyProceduralEnvironmentDefinition, Sandbox.Definitions.MyCharacterDefinition, Sandbox.Game.AI.Pathfinding.MyBlockNavigationDefinition, Sandbox.Definitions.MyWeaponDefinition, Sandbox.Definitions.MyProjectileAmmoDefinition, Sandbox.Definitions.MyEnvironmentDefinition, Sandbox.Definitions.MyScenarioDefinition, Sandbox.Definitions.MyVoxelMaterialDefinition, Sandbox.Definitions.MyHandItemDefinition, Sandbox.Definitions.GUI.MyGuiSkinDefinition, Sandbox.Definitions.MySpawnGroupDefinition, Sandbox.Definitions.MyToolItemDefinition, Sandbox.Game.WorldEnvironment.Definitions.MyGrowableEnvironmentItemDefinition, VRage.Game.MyContainerDefinition, Medieval.Definitions.MyDx11VoxelMaterialDefinition, Sandbox.Definitions.MyPhysicalMaterialDefinition, Sandbox.Definitions.MyMissileAmmoDefinition, Sandbox.Definitions.MyPhysicalItemDefinition, Sandbox.Definitions.MyFloraElementDefinition, Sandbox.Definitions.MyPrefabDefinition, Sandbox.Definitions.MyShipSoundsDefinition, Sandbox.Definitions.MyThrustDefinition, Sandbox.Definitions.MySoundCategoryDefinition, Sandbox.Definitions.MyEnvironmentItemsDefinition, Sandbox.Definitions.MyBarbarianWaveEventDefinition, Sandbox.Definitions.MyEntityStatDefinition, Sandbox.Definitions.MyGuiBlockCategoryDefinition, Sandbox.Definitions.MyTransparentMaterialDefinition, Sandbox.Definitions.MyComponentGroupDefinition, Sandbox.Definitions.MyContainerTypeDefinition, Sandbox.Definitions.MyScriptedGroupDefinition, Sandbox.Definitions.MyMultiBlockDefinition, Sandbox.Definitions.MyGpsCollectionDefinition, Sandbox.Definitions.MyBlueprintClassDefinition, Sandbox.Definitions.MyCompoundBlockTemplateDefinition, Sandbox.Definitions.MyShipSoundSystemDefinition, VRage.Game.MyVisualSettingsDefinition, Sandbox.Definitions.MyPirateAntennaDefinition, Sandbox.Definitions.MyReactorDefinition, VRage.Game.Definitions.Animation.MyAnimationDefinition, Sandbox.Definitions.MyAmmoDefinition, Sandbox.Definitions.MyConsumableItemDefinition, Sandbox.Definitions.MyProductionBlockDefinition, Sandbox.Definitions.MyAgentDefinition, Sandbox.Definitions.MyDestructionDefinition, Sandbox.Definitions.MyComponentDefinition, Sandbox.Definitions.MyLaserAntennaDefinition, Sandbox.Definitions.MyMedicalRoomDefinition, Sandbox.Definitions.MyOxygenGeneratorDefinition, Sandbox.Definitions.MyRopeDefinition, Sandbox.Definitions.MyTreeDefinition, Sandbox.Game.EntityComponents.MyInventoryComponentDefinition, Sandbox.Game.WorldEnvironment.Definitions.MyWorldEnvironmentDefinition, Sandbox.Definitions.MyControllerSchemaDefinition, Sandbox.Definitions.MyFactionDefinition, Sandbox.Definitions.MyShipControllerDefinition, Sandbox.Definitions.MyAreaMarkerDefinition, Sandbox.Definitions.MyLightingBlockDefinition, Sandbox.Game.EntityComponents.MyCraftingComponentBasicDefinition, Sandbox.Game.EntityComponents.MyCraftingComponentBlockDefinition, Sandbox.Game.EntityComponents.MyCraftingComponentInteractiveDefinition, Sandbox.Game.Definitions.MyCubeBlockStackSizeDefinition, Sandbox.Definitions.MyRefineryDefinition, Sandbox.Definitions.MyVoxelMaterialModifierDefinition, VRage.Game.Definitions.Animation.MyAnimationControllerDefinition, VRage.Game.Definitions.SessionComponents.MyCubeBuilderDefinition, Sandbox.Definitions.MyAirVentDefinition, Sandbox.Definitions.MyCameraBlockDefinition, Sandbox.Definitions.MyLargeTurretBaseDefinition, Sandbox.Definitions.MyOxygenFarmDefinition, Sandbox.Definitions.MyPhysicalModelDefinition, Sandbox.Definitions.MyPrefabThrowerDefinition, VRage.Game.Definitions.MyGameDefinition, Sandbox.Definitions.MyAssemblerDefinition, Sandbox.Definitions.MyCompositeBlueprintDefinition, Sandbox.Definitions.MyAudioEffectDefinition, Sandbox.Definitions.MyHumanoidBotDefinition, Sandbox.Definitions.MyMotorSuspensionDefinition, Sandbox.Game.EntityComponents.MyModelComponentDefinition, Sandbox.Definitions.MyBattleDefinition, Sandbox.Definitions.MyBotDefinition, Sandbox.Definitions.MyComponentSubstitutionDefinition, Sandbox.Definitions.MyGlobalEventDefinition, Sandbox.Definitions.MySolarPanelDefinition, Sandbox.Game.EntityComponents.MyEntityStatComponentDefinition, SpaceEngineers.Game.Definitions.MyDemoComponentDefinition, Sandbox.Definitions.MyAirtightDoorGenericDefinition, Sandbox.Definitions.MyAmmoMagazineDefinition, Sandbox.Definitions.MyCryoChamberDefinition, Sandbox.Definitions.MyEquivalencyGroupDefinition, Sandbox.Definitions.MyGhostCharacterDefinition, Sandbox.Definitions.MyGravityGeneratorSphereDefinition, Sandbox.Definitions.MyJumpDriveDefinition, Sandbox.Definitions.MyLandingGearDefinition, Sandbox.Definitions.MyMergeBlockDefinition, Sandbox.Definitions.MySessionComponentResearchDefinition, Sandbox.Definitions.MySpaceBallDefinition, Sandbox.Definitions.MyWeaponItemDefinition, Sandbox.Game.WorldEnvironment.Definitions.MyVoxelMapCollectionDefinition, VRage.Game.Definitions.MyModStorageComponentDefinition, VRage.Game.Definitions.SessionComponents.MyCoordinateSystemDefinition, VRage.Game.MyPhysicsComponentDefinitionBase, Sandbox.Definitions.MyAdvancedDoorDefinition, Sandbox.Definitions.MyBatteryBlockDefinition, Sandbox.Definitions.MyButtonPanelDefinition, Sandbox.Definitions.MyCockpitDefinition, Sandbox.Definitions.MyMechanicalConnectionBlockBaseDefinition, Sandbox.Definitions.MyMotorStatorDefinition, Sandbox.Definitions.MyPhysicalModelCollectionDefinition, Sandbox.Definitions.MyReflectorBlockDefinition, Sandbox.Definitions.MyResearchDefinition, Sandbox.Definitions.MySchematicItemDefinition, Sandbox.Definitions.MyShipDrillDefinition, Sandbox.Definitions.MyVoxelMapStorageDefinition, Sandbox.Definitions.MyWeaponBlockDefinition, Sandbox.Game.EntityComponents.MyEntityInventorySpawnComponent_Definition, Sandbox.Game.EntityComponents.MyPhysicsBodyComponentDefinition, Sandbox.Game.EntityComponents.MyUseObjectsComponentDefinition, Sandbox.Definitions.MyBehaviorDefinition, Sandbox.Definitions.MyAiCommandBehaviorDefinition, Sandbox.Definitions.MyConveyorSorterDefinition, Sandbox.Definitions.MyDoorDefinition, Sandbox.Definitions.MyEngineerToolBaseDefinition, Sandbox.Definitions.MyGasTankDefinition, Sandbox.Definitions.MyMissileLauncherDefinition, Sandbox.Definitions.MyPistonBaseDefinition, Sandbox.Definitions.MyRespawnShipDefinition, Sandbox.Definitions.MyTimerBlockDefinition, Sandbox.Game.EntityComponents.MyTimerComponentDefinition, Sandbox.Game.WorldEnvironment.Definitions.MyBotCollectionDefinition, Sandbox.Definitions.MyDebrisDefinition, Sandbox.Definitions.MyEdgesDefinition, Sandbox.Definitions.MyGravityGeneratorBaseDefinition, Sandbox.Definitions.MyGravityGeneratorDefinition, Sandbox.Definitions.MyHandDrillDefinition, Sandbox.Definitions.MyLCDTextureDefinition, Sandbox.Definitions.MyPlanetPrefabDefinition, Sandbox.Definitions.MyProjectorDefinition, Sandbox.Definitions.MyRepairBlueprintDefinition, Sandbox.Definitions.MySensorBlockDefinition, Sandbox.Definitions.MyTextPanelDefinition, Sandbox.Definitions.MyVirtualMassDefinition, Sandbox.Game.WorldEnvironment.Definitions.MyEnvironmentModuleProxyDefinition, Sandbox.Definitions.GUI.MyButtonListStyleDefinition, Sandbox.Definitions.MyBlockBlueprintDefinition, Sandbox.Definitions.MyGyroDefinition, Sandbox.Definitions.MyMotorAdvancedStatorDefinition, Sandbox.Definitions.MyPowerProducerDefinition, Sandbox.Definitions.MyResourceDistributionGroupDefinition, Sandbox.Definitions.MyWarheadDefinition, Sandbox.Game.WorldEnvironment.Definitions.MyProceduralEnvironmentModuleDefinition, Sandbox.Definitions.MyAiCommandDefinition, Sandbox.Definitions.MyCargoContainerDefinition, Sandbox.Definitions.MyFontDefinition, Sandbox.Definitions.MyOreDetectorDefinition, Sandbox.Definitions.MyOxygenContainerDefinition, Sandbox.Definitions.MyPoweredCargoContainerDefinition, Sandbox.Definitions.MyProgrammableBlockDefinition, Sandbox.Definitions.MyRadioAntennaDefinition, Sandbox.Definitions.MyRemoteControlDefinition, Sandbox.Definitions.MySoundBlockDefinition, VRage.Game.Definitions.SessionComponents.MyClipboardDefinition, Sandbox.Definitions.MyBeaconDefinition, Sandbox.Definitions.MyEnvironmentItemDefinition, Sandbox.Definitions.MyGasProperties, Sandbox.Definitions.MyGridCreateToolDefinition, SpaceEngineers.Definitions.MyUpgradeModuleDefinition, VRage.Game.MyAudioDefinition, Sandbox.Definitions.MyUsableItemDefinition, Sandbox.Definitions.MyVoxelHandDefinition, VRage.Game.MyCurveDefinition, and VRage.Game.MyComponentDefinitionBase.
Definition at line 86 of file MyDefinitionBase.cs.
|
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 in Sandbox.Definitions.MyBlueprintDefinitionBase, Sandbox.Definitions.MyPirateAntennaDefinition, Sandbox.Definitions.MyBlueprintDefinition, Sandbox.Definitions.MyComponentGroupDefinition, Sandbox.Definitions.MyFactionDefinition, Sandbox.Definitions.MyCompositeBlueprintDefinition, and Sandbox.Definitions.MyBlockBlueprintDefinition.
Definition at line 128 of file MyDefinitionBase.cs.
|
inline |
Definition at line 130 of file MyDefinitionBase.cs.
|
inline |
Definition at line 151 of file MyDefinitionBase.cs.
Member Data Documentation
| bool VRage.Game.MyDefinitionBase.AvailableInSurvival |
Definition at line 48 of file MyDefinitionBase.cs.
| MyModContext VRage.Game.MyDefinitionBase.Context |
Definition at line 50 of file MyDefinitionBase.cs.
| MyStringId VRage.Game.MyDefinitionBase.DescriptionEnum |
Enum used for localization of description. Null for player created definitions.
Definition at line 21 of file MyDefinitionBase.cs.
| String VRage.Game.MyDefinitionBase.DescriptionString |
String used for user created description which do not have localization support.
Definition at line 31 of file MyDefinitionBase.cs.
| MyStringId VRage.Game.MyDefinitionBase.DisplayNameEnum |
Enum used for localization of display name. Null for player created definitions.
Definition at line 16 of file MyDefinitionBase.cs.
| String VRage.Game.MyDefinitionBase.DisplayNameString |
String name used for user created definitions which do not have localization support.
Definition at line 26 of file MyDefinitionBase.cs.
| bool VRage.Game.MyDefinitionBase.Enabled = true |
Definition can be disabled by mod, then it will be removed from definition manager
Definition at line 41 of file MyDefinitionBase.cs.
| string [] VRage.Game.MyDefinitionBase.Icons |
Icons for the definition, they are used from top to bottom.
Definition at line 36 of file MyDefinitionBase.cs.
| MyDefinitionId VRage.Game.MyDefinitionBase.Id |
Definition at line 11 of file MyDefinitionBase.cs.
| bool VRage.Game.MyDefinitionBase.Public = true |
Indicates if definition should be offered in Cube builder
Definition at line 46 of file MyDefinitionBase.cs.
Property Documentation
|
get |
Use this property when showing description in GUI, as it takes into account more complex description construction.
Definition at line 71 of file MyDefinitionBase.cs.
|
get |
Use this property when showing name in GUI instead of DisplayName. This takes into account more complex name construction.
Definition at line 57 of file MyDefinitionBase.cs.
The documentation for this class was generated from the following file:
- Sources/VRage.Game/Definitions/MyDefinitionBase.cs
