Decal Definition

HomeModdingReferenceSBCDecal Def

Overview

Inherits

• DefinitionBase

Found in Decals.sbc.

Defines a dynamic decal that can be placed in world by various systems (footsteps, bullet impacts, etc).

These cannot be overwritten or removed!

This applies to scripts too because the decals are sent straight to render where they're not accessible by modAPI.

Technical details

Decal definitions cannot be overwritten because the game sends them to a different system without checking if they already exist there, and because of the way they're stored this doesn't cause errors. (from MyDefinitionManager.PostprocessDecals() ends up in a Dictionary<string, List<MyDecalMaterial>> in MyDecalMaterials)

This does make it impossible to change anything on a decal (most notably the blacklist). Mod scripts cannot mess with these either because the place they're stored in is not whitelisted.

Elements

 ↑   🔗 

Source <Source>	Type: String	Default: (empty)
Usually a subtypeId of a Physical Material of the "attacker". This combined with <Target> make up a lookup key, however it points to a list meaning if multiple definitions have the same source and target, they will both be rendered when that is requested. If null or empty it will use NULL.
Target <Target>	Type: String	Default: (empty)
Usually a subtypeId of a Physical Material of the "victim". If null or empty it will use NULL.
Blacklist <Blacklist>	Type: String[]	Default: null
Only used for decals by wheels trails, landing gears prints and character footprints, all against voxels. An optional list of SubtypeIDs of voxel materials to avoid placing this decal on. Example: <Blacklist> <VoxelMaterial>AlienIce</VoxelMaterial> <!-- ... --> </Blacklist>
Material <Material>	Type: MyDecalMaterialDesc	Default: (empty)
Textures used by this decal. Contains more elements: ColorMetalTexture <ColorMetalTexture> Type: string Default: null NormalmapTexture <NormalmapTexture> Type: string Default: null ExtensionsTexture <ExtensionsTexture> Type: string Default: null AlphamaskTexture <AlphamaskTexture> Type: string Default: null Elements that exist in the game code or vanilla SBC, but do nothing DecalType <DecalType> Type: - Default: - Exists in SBC but does not exist in game code. Each texture is optional, omit the element entirely if you wish to not define it. For the wanted ones, it expects a path to a .dds file, relative to current mod folder or falls back to game folder if not found. (Referencing assets in other mods) More info on what each texture type means: Materials. Full example: <Material> <ColorMetalTexture>Textures/Decals/Bullet_Metal_Hit_01_cm.dds</ColorMetalTexture> <NormalmapTexture>Textures/Decals/Bullet_Metal_Hit_01_ng.dds</NormalmapTexture> <ExtensionsTexture>Textures/Decals/Bullet_Metal_Hit_01_add.dds</ExtensionsTexture> <AlphamaskTexture>Textures/Decals/Bullet_Metal_Hit_01_alphamask.dds</AlphamaskTexture> </Material>
Transparent <Transparent>	Type: Boolean	Default: False
Alpha <Alpha>	Type: Single	Default: 1
MinSize <MinSize>	Type: Single	Default: 1
Decal's size in meters picked as a random number between this and <MaxSize>, per spawn.
MaxSize <MaxSize>	Type: Single	Default: 2
Decal's size in meters picked as a random number between <MinSize> and this, per spawn. Cannot be smaller than <MinSize>, gets automatically raised up to that.
Depth <Depth>	Type: Single	Default: 0.2
The depth of the decal projection, in meters.
RenderDistance <RenderDistance>	Type: Single	Default: 50
Max draw distance (in meters) for this decal on high or extreme Shader Quality. For medium it gets multiplied by 0.44444 and for low by 0.11111.
Rotation <Rotation>	Type: Single	Default: Infinity
Fixed rotation angle if defined, in degrees. Otherwise random rotation angle if left as infinity.
Spacing <Spacing>	Type: Single	Default: -1
Only used by Wheel block type for its trails. This multiplied by <MinSize> is used as a minimum meters to travel before more decals are placed.
XOffset <XOffset>	Type: Single	Default: 0
Only used by Wheel block type for its trails. Offsets the decal relative to the wheel's sides, positive values outwards and negative values inwards.
YOffset <YOffset>	Type: Single	Default: 0
Only used by Wheel block type for its trails. Possibly does nothing.

(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.

---