Component Definition

HomeModdingReferenceSBCItemsComponent Def

Overview

Inherits

• PhysicalItem Definition
• DefinitionBase

Defines an item that can be used as building material for blocks.

Component items require a blueprint that results in said component, otherwise the game might crash in some cases.

However, the blueprint does not need to be added to any blueprint classes. Refer to vanilla blueprints for ZoneChip, PrototechFrame, plushies, etc for examples.

Also if the blueprint has the same item in both (like the above examples), make sure <MinimalPricePerUnit> is 0 or higher.

Elements

 ↑   🔗 

MaxIntegrity <MaxIntegrity>	Type: Int32	Default: 0
The hit points given to the block using this component as building material (defined in block's <Components>).
DeconstructionEfficiency <DeconstructionEfficiency>	Type: Single	Default: 1
Speed multiplier for grinding this component off a block, lower than 1 will take proportionally longer to grind.
DropProbability <DropProbability>	Type: Single	Default: 0
Multiple behaviors: When a floating object and gets destroyed, DropProbability is the chance it will drop Ore/Scrap (otherwise nothing). Amount of scrap is 80% of the original item amount in the stack. When this is grinded from a damaged block, DropProbability is the chance it will give Ore/Scrap (otherwise nothing). Amount of scrap is 80% of the item's mass. When a block gets destroyed while having this item in its inventory (not built with it), DropProbability is the ratio of the stack amount that survives and drops, rounded down.

(Top) | From PhysicalItem Definition:

Model <Model>	Type: String	Default: Models\Components\Sphere.mwm
Shown for this item when it's a floating object, unless <Models> is defined in which case this is ignored. Path to a .mwm file relative to current mod's folder. Falls back to game folder if not found in current mod. Referencing assets in other mods
Models <Models>	Type: String[]	Default: null
A list of paths to .mwm files where the game will pick one randomly when the item spawns as a floating object. Relative path to current mod's folder. Falls back to game folder if not found in current mod. The <Model>...</Model> inside this can be declared multiple times to have more models. <Models> <Model>Models\SomeModel1.mwm</Model> <!-- ... --> </Models> If this is defined it also replaces the use of DebrisModels.sbc, see <VoxelMaterial> section for details.
Volume <Volume>	Type: Nullable<Single>	Default: null
How much space it occupies in an inventory, in liters. For ore types, this is a factor on how much they're mined, for details see VoxelMaterial's <MinedOreRatio>. If undefined, uses <Size>'s volume ($x*y*z$).
Size <Size>	Type: Vector3	Default: {X:0 Y:0 Z:0}
Used in a few places: If any of the axes are higher than 0.25 then this item cannot be conveyored through small ports. Exceptions are PhysicalGunObject types which are always allowed. ShipConnector uses this to know how far ahead to place the item when ejecting it, uses half of the largest number. As fallback if <Volume> is not defined, where the axes are multiplied with eachother (x*y*z). Usage: <Size> <X>0.5</X> <Y>0.5</Y> <Z>0.01</Z> </Size>
Health <Health>	Type: Int32	Default: 100
Hit points when this item is a floating item. It also takes 10x the damage therefore this should be 10 times larger than it needs to be. Note: not used for Ore or Ingot item types, those will instead lose amount from the stack equal to the damage taken. Hardcoded to spawn Smoke_Construction particle when it's destroyed (on all types).
Mass <Mass>	Type: Single	Default: 0
In kg, the mass of the item. Note: if this is an Ore type you should leave this to 1 to avoid problems, volume can vary however. Affects mass of cargo it's placed in, and if it's a Component type used for building a block it affects the block's base mass (unless <HasPhysics> is false on the block).
IconSymbol <IconSymbol>	Type: String	Default: null
Text shown top-right in the item's icon.
MaxStackAmount <MaxStackAmount>	Type: MyFixedPoint	Default: 9223372036854.775807
Max number of items that can be stacked into one inventory slot.
DepositAllEnabled <DepositAllEnabled>	Type: Boolean	Default: true
Whether this item is put away when the player uses quick deposit hotkey. Set to false for items that the engineer must keep on themselves, like tools, weapons, ammo for said weapons, bottles, consumables, etc. (Added in SE v1.208)
CanSpawnFromScreen <CanSpawnFromScreen>	Type: Boolean	Default: true
Whether this item appears in the admin spawn menu and in the conveyor sorter's filter list. The <Public> being set to false overrules this and prevents the item from being shown in all the above cases.
RotateOnSpawnX <RotateOnSpawnX>	Type: Boolean	Default: false
Whether to spawn the item facing 90deg up.
RotateOnSpawnY <RotateOnSpawnY>	Type: Boolean	Default: false
Whether to spawn the item facing 90deg right. It rotates after <RotateOnSpawnX>'s rotation.
RotateOnSpawnZ <RotateOnSpawnZ>	Type: Boolean	Default: false
Whether to spawn the item rolled 90deg left. It should not be used with <RotateOnSpawnY> enabled.
DestroyedPieceId <DestroyedPieceId>	Type: SerializableDefinitionId?	Default: null
Optional. When this item is destroyed as a floating object, it spawns the given Id, with <DestroyedPieces> amount. This does nothing if this item's SubtypeId is Scrap (case-sensitive), of any TypeId. Usage: <DestroyedPieceId Type="Ore" Subtype="Stone" />
DestroyedPieces <DestroyedPieces>	Type: Int32	Default: 0
How many of <DestroyedPieceId> to spawn.
DestroySound <DestroySound>	Type: String	Default: null
Only used if the item explodes, for the explosion sound. See Explosive Items for details.
ExtraInventoryTooltipLine <ExtraInventoryTooltipLine>	Type: String	Default: null
Raw text to be shown in the item's tooltip seen in inventory screens. If <ExtraInventoryTooltipLineId> is declared then this element is ignored.
ExtraInventoryTooltipLineId <ExtraInventoryTooltipLineId>	Type: String	Default: null
Raw text or localization key to be shown in the item's tooltip. This overrides the <ExtraInventoryTooltipLine>. Since SE v208, when using this on a ConsumableItem item type, you now have the option to get the values from its <Stats> in the text (either raw or the localized version), by using {0} for the first, {1} for the second and etc. These arguments are optional, but if you define them make sure they're not more than the number of entries in <Stats> (e.g. for 2 stats, the highest should be {1}), otherwise you will get errors/crashing. This behavior does not work on <ExtraInventoryTooltipLine>.
CanPlayerOrder <CanPlayerOrder>	Type: Boolean	Default: false
Whether this item can be used in player's StoreBlocks. Economy trade stations do not use this, instead what they sell and buy are declared in FactionType's <OffersList> and <OrdersList>.
MinimalPricePerUnit <MinimalPricePerUnit>	Type: Int32	Default: -1
The base amount of Space Credits that this item should cost, which affects the price of other things that require this item through blueprints, blocks/grids, etc. If set to -1 then the price is calculated from the first blueprint that results in this item, using its requisite items' own <MinimalPricePerUnit> or their blueprint too, and this goes deeper and deeper until raw materials have to have a value for this. The price calculation also includes the blueprint crafting time divided by the world's refinery speed multiplier if the resulting item is an Ingot type, or assembler speed multiplier for anything else. For more details on price calculations and how they're used: Deep Overview of NPC Economy
MinimumOfferAmount <MinimumOfferAmount>	Type: Int32	Default: 0
See <MaximumOfferAmount>.
MaximumOfferAmount <MaximumOfferAmount>	Type: Int32	Default: 0
For Economy trade stations sold items (FactionTypes.sbc), picks a random number between <MinimumOfferAmount> and this when the trade station refreshes its stock. More details in: Deep Overview of NPC Economy
MinimumOrderAmount <MinimumOrderAmount>	Type: Int32	Default: 0
See <MaximumOrderAmount>.
MaximumOrderAmount <MaximumOrderAmount>	Type: Int32	Default: 0
For Economy trade stations buy requests (FactionTypes.sbc), picks a random number between <MinimumOrderAmount> and this when the trade station refreshes its stock. More details in: Deep Overview of NPC Economy
MinimumAcquisitionAmount <MinimumAcquisitionAmount>	Type: Int32	Default: 10
See <MaximumAcquisitionAmount>.
MaximumAcquisitionAmount <MaximumAcquisitionAmount>	Type: Int32	Default: 100
Only if this item is used in an obtain and deliver's <AvailableItems>. Random amount between <MinimumAcquisitionAmount> and this (both included) would be required for the contract if this item is picked.
PhysicalMaterial <PhysicalMaterial>	Type: String	Default: null
SubtypeId of a PhysicalMaterial Definition (PhysicalMaterials.sbc). Visit Collision Effects for more details on what it's used for in general. If <VoxelMaterial> is assigned (can self-assign, see there for details) this will be ignored and will use Rock for the floating object instead.
VoxelMaterial <VoxelMaterial>	Type: String	Default: null
A subtypeId for a voxel material (VoxelMaterials*.sbc). Note: If undefined it can still get a material assigned automatically if the item type is Ore and any voxel material's <MinedOre> points to this item's SubtypeId. If this has a material assigned, changes a few things: If this is an Ore type, the visual model used for the floating object will be automatically picked from Debris definition (DebrisModels.sbc; only <Type>Voxel</Type> ones) based on amount stacked. Each dropped floating object will have a random color multiplier between 0 and 2. Floating object's physical collider is a sphere the size of the radius of a sphere encasing the model's boundingbox, normally it's a box using model's boundingbox. Floating object's physical material will use Rock instead of whatever is assigned to <PhysicalMaterial>. Stores the floating object internally as a "Floating Ore" instead of "Floating Item", has some consequences to how soon they vanish when the floating objects limit is reached. If using custom models, the game will crash if the model has any textures assigned to its material. See RockDebris .fbx and .xml from the SDK. The game will assign the textures from the voxel material to your textureless model.

(Top) | From DefinitionBase:

Common

 ↑   🔗 

Id <Id>	Type: SerializableDefinitionId	Default: (invalid)
The type and subtype combined make up a unique identifier for this definition. If two definitions use the same Type+Subtype (Subtypes are only unique per Type), then the last to load will override the first one(s). For more details see Things to know about SBC. TypeId <TypeId> Type: string Default: (invalid) Must be an existing type with or without the "MyObjectBuilder_" prefix. Some types require an xsi:type, refer to the vanilla files for the exact pairing. TypeId vs xsi:type SubtypeId <SubtypeId> Type: string Default: (empty) This can be invented and only needs to be unique per TypeId. Vanilla game re-uses some subtypes over multiple types (e.g. Iron is used for Ore type and Ingot type). An empty value is also a valid subtype (which vanilla also uses on at least 5 blocks). Type Type (attribute) Type: string Default: (invalid) Same behavior as <TypeId>, do not define both. Subtype Subtype (attribute) Type: string Default: (empty) Same behavior as <SubtypeId>, do not define both. Example: <Id> <TypeId>CubeBlock</TypeId> <SubtypeId>FancyTable</SubtypeId> </Id> Because it has attribute alternatives it can also be declared as: <Id Type="CubeBlock" Subtype="FancyTable" />
DisplayName <DisplayName>	Type: String	Default: null
If the object defined here is visible anywhere in the game GUI, this would be the name shown for it. In cases where it is used, it is very much required. Can be plain-text. If the text contains DisplayName_ then: A localization key (from .resx files) will be searched for. It will scan for text variables to replace.
Description <Description>	Type: String	Default: null
Optional. If the object defined here is shown with a description in the game GUI (Hotbar/G-menu, HUD, etc) then this is the place to write it. Can be plain-text. If the text contains Description_ then: A localization key (from .resx files) will be searched for. It will scan for text variables to replace. If the final text (plain, localized or variable-replaced) contains {0}, {1}, etc, then they will replaced by kb&m control binds defined in <DescriptionArgs>.
DescriptionArgs <DescriptionArgs>	Type: String	Default: null
Optional. A comma-separated list of control IDs which are referenced in <Description> by {number} tags, which then get replaced by the keyboard or mouse bind that the viewer has for those controls. Example: <Description>Press {0} to fire, {1} to change color, {2} to interact.</description> <DescriptionArgs>PRIMARY_TOOL_ACTION,CUBE_COLOR_CHANGE,USE</DescriptionArgs> And each player will see their current binds for those actions. The control IDs can be found in your %appdata%/SpaceEngineers/SpaceEngineers.cfg at the ControlsButtons section.
Icon <Icon>	Type: String[]	Default: null
Icon(s) for the definition which may or may not be used depending on the definition type. Path to a .dds or .png file relative to current mod's folder. Falls back to game folder if not found in current mod. Referencing assets in other mods Can be declared multiple times which will stack icons on top of eachother, however it will not work for all definitions. Known definitions to work or not work with multiple icons Working: Blocks, BlockVariantGroups and component items seen in G-menu, BlockInfo (HUD right side) and toolbars; Blueprints in terminal production tab; Blocks and PhysicalItems in gamepad HUD. Partial: Blocks seen in terminal. Not working: HandItems (uses PhysicalItem's icon instead); Blocks and BlockVariantGroups seen in build planner, radial menu and some economy GUIs; PhysicalItems in economy GUIs and stores; Prefabs in stores; BlueprintClass (tabs) in terminal production tab; BankingSystemDefinition (Game\BankingSystem.sbc); Emotes (both kinds of definitions) in gamepad HUD; Block skins; RespawnShips. Special cases: Economy contracts, FactionIcons Definition.
DLC <DLC>	Type: String[]	Default: null
Optional. The DLC subtypeId that this definition will require. For the IDs, refer to <SE>\Content\Data\Game\DLCs.sbc. Can be declared multiple times to require multiple DLCs. Most definition types won't check for this, the ones that do: blocks, emotes and possibly anything else that can be placed in the toolbar.
AvailableInSurvival <AvailableInSurvival>	Type: Boolean	Default: true
Depends on the definition if it uses this, and if it does then this determines whether it can be accessible in survival game mode. Currently known definitions that do use this: Blocks, BlockVariantGroups, BlockCategories and any definition that can show up in a toolbar. EntityStatComponent Definition and EntityStat Definition.
Public <Public>	Type: Boolean	Default: true
If the definition is visible or accessible in some cases. For blocks, this only hides them and they can still be built using projectors and other means.
Enabled Enabled (attribute)	Type: Boolean	Default: true
If set to false it will remove the definition after it's been loaded. Example usage: <Definition Enabled="false"> The "Definition" above is the opening element that for the entire definition, not an inner node like <DisplayName> is. The opening node can have a different name for other definitions, some examples <Component>, <Blueprint>, etc.
xsi:type xsi:type (attribute)	Type: string	Default: null
Name of an object that this definition will be deserialized as. Sometimes required, depends on the definition. The wiki page for any given definition will mention at the top what xsi:type it requires, if any. The game's sbc files are also a reference on what xsi:types are required for a given definition. This attribute is available on all elements and comes from the XML specification. This game relies on this attribute to change which sub-definition object is used to deserialize that element's contents. It's what allows, for example, a thruster to have unique elements (such as <MinPlanetaryInfluence>) that no other block definitions have. For more details on how this relates to the TypeId, and usage examples, see: Things to know about SBC - TypeId vs xsi:type.

---