MaintenancePanelComponent Definition

From Space Engineers Wiki
Jump to navigation Jump to search

Requires an xsi:type attribute:

<EntityComponent xsi:type="MyObjectBuilder_MaintenancePanelComponentDefinition">

This is part of an entity component, see EntityComponents for usage details.
An entity component that provides an interactive no-collision door.

Elements

SubpartName

<SubpartName>
Type: StringDefaultnull
The subpart to animate, enter name without the subpart_ prefix, case-insensitive.
If nothing entered it uses the first subpart_ prefixed empty it finds.

DetectorName

<DetectorName>
Type: StringDefaultnull
Dummy name in the main model to use for the interaction area.
If nothing entered it uses the first detector_maintenance empty it finds.

IsRotation

<IsRotation>
Type: BooleanDefaulttrue
Determines the subpart motion type, where true is rotation and false is translation (linear motion).
(Added in SE v1.208)

OpenDirection

<OpenDirection>
Type: Int32Default0
Direction or axis depending on what <IsRotation> is set to:

Rotation

  • 0 - AxisX
  • 1 - AxisY
  • 2 - AxisZ
  • 3 - CustomAxis

Translation

  • 0 - Forward
  • 1 - Backward
  • 2 - Left
  • 3 - Right
  • 4 - Up
  • 5 - Down

DefaultOpeningDirectionRevert

<DefaultOpeningDirectionRevert>
Type: BooleanDefaultfalse

MinPosition

<MinPosition>
Type: SingleDefault0
Unit depends on the motion type defined by <IsRotation>:
  • Rotation: degrees
  • Translation: meters

MaxPosition

<MaxPosition>
Type: SingleDefault0
Unit depends on the motion type defined by <IsRotation>:
  • Rotation: degrees
  • Translation: meters

OpenSpeed

<OpenSpeed>
Type: SingleDefault1
Unit depends on the motion type defined by <IsRotation>:
  • Rotation: degrees per second
  • Translation: meters per second

CloseSpeed

<CloseSpeed>
Type: SingleDefault1
Unit depends on the motion type defined by <IsRotation>:
  • Rotation: degrees per second
  • Translation: meters per second

SpinUpSpeed

<SpinUpSpeed>
Type: SingleDefault0
Acceleration only for speeding up.

Unit depends on the motion type defined by <IsRotation>:

  • Rotation: degrees per second squared
  • Translation: meters per second squared

HingePosition

<HingePosition>
Type: Vector3DefaultX:0 Y:0 Z:0
Supposedly used in rotation mode by CustomAxis (<OpenDirection> set to 3), but does not seem to function.
Usage:
<HingePosition>
  <X>0.0</X>
  <Y>0.0</Y>
  <Z>0.0</Z>
</HingePosition>
X/Y/Z are Right/Up/Back for positive values, and they're in meters.

UseobjectHingePosition

<UseobjectHingePosition>
Type: Vector3DefaultX:0 Y:0 Z:0
Offsets the hinge position before applying the <UseobjectOpenDirection> rotation to the interaction area (useobject).
Usage example:
<UseobjectHingePosition>
  <X>0.0</X>
  <Y>0.0</Y>
  <Z>0.0</Z>
</UseobjectHingePosition>
(Added in SE v1.206)

UseobjectOpenDirection

<UseobjectOpenDirection>
Type: Int32Default-1
Optional. If -1 it uses the <OpenDirection>'s value.

Changes the interaction area's rotation direction:

  • 0 rotates around X (right/left) axis.
  • 1 rotates around Y (up/down) axis.
  • 2 rotates around Z (back/forward) axis.
    (Added in SE v1.206)

RemoveExistingComponentOnNewInsert

<RemoveExistingComponentOnNewInsert>
Type: BooleanDefaulttrue
Setting it to false allows this component to exist multiple times on the same entity.

(Top) | From ComponentDefinitionBase:

(Nothing)
(Top) | From DefinitionBase:

Common

Id

<Id>
Type: SerializableDefinitionIdDefault(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>Type: stringDefault(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>Type: stringDefault(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 (attribute[1])Type: stringDefault(invalid)
Same behavior as <TypeId>, do not define both.
Subtype (attribute[1])Type: stringDefault(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: StringDefaultnull
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:

Description

<Description>
Type: StringDefaultnull
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:

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: StringDefaultnull
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[]Defaultnull
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[]Defaultnull
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: BooleanDefaulttrue
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:

Public

<Public>
Type: BooleanDefaulttrue
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[1])
Type: BooleanDefaulttrue
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[1])
Type: stringDefaultnull

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.

Obsolete Elements

Elements that exist in the game code or vanilla SBC, but do nothing

Note: this list only contains root-level from this definition only, nothing from inherited ones.

<SimpleOpen>Type: BooleanDefaultfalse
False is rotation mode, true is translation mode (linear movement); true seems currently broken.
Removed in SE v208 and <IsRotation> was added instead.
<UseObjectPositionMultipliers>Type: Vector3DefaultX:0 Y:0 Z:0
No longer exists since v1.206, therefore does nothing now.