ConveyorEndpointComponent Definition

From Space Engineers Wiki
Jump to navigation Jump to search
HomeModdingReferenceSBCEntityCompsConveyorEndpointComp.Def
Overview
Inherits

Requires an xsi:type attribute: 

<EntityComponent xsi:type="MyObjectBuilder_ConveyorEndpointComponentDefinition">

This is part of an entity component, see EntityComponents for usage details.


Adds conveyor network support to the given block, and configures push/pull constraints too.

The block's model still needs the conveyor dummies in order to know where the ports are.
The below information is also available on block TypeId pages for ones that have inherent conveyor support.

Conveyor port dummies for the model

Supports detector_conveyor* to connect to the conveyor network and provides an interactive area to open inventory/terminal.
Then the * can be various suffixes (if multiple are wanted, add them in this order):

  • line suffix to prevent this from being an interactive port.
  • _small suffix to be a small port (can only transfer items small enough, see item's <Size>), otherwise it's a large port.
  • _in or _out suffix can be used to make it directional, however it does not work for gases.

Past that they can have another _ followed by numbers (or really anything) to declare more than one with the same name.

Example of a directional small non-interactive port: detector_conveyorline_small_out_001

Elements

AllowSelfPulling

<AllowSelfPulling>		Type: BooleanDefault: false
Whether to allow pulling items from this entity's other inventories, only relevant if it has 2+ inventories.

PullConstraint

<PullConstraint>		Type: InventoryConstraintDefinitionDefault: null
Optional. Limits for pulling items from the conveyor network.

Undefined or null will allow all items.
Contains more elements:

Whitelist (attribute[1])Type: BooleanDefault: true
Determines if the list of entries is the only things that are allowed (true) or the things that are not allowed (false).
Description (attribute[1])Type: StringDefault: null
Does not seem to be used anywhere visible to the player.
Icon (attribute[1])Type: StringDefault: null
Does not seem to be used anywhere visible to the player.
<Entry>Type: SerializableDefinitionIdDefault: (invalid)
This element can be repeated to define more than one.
Type (attribute[1])Type: StringDefault: (invalid)
An item's <TypeId>, required.
Subtype (attribute[1])Type: StringDefault: null
Optional, <SubtypeId> of an item if you wish to be specific.
If empty or undeclared it will whitelist/blacklist the entire type.
Usage and examples: 
<PullConstraint Whitelist="true" Description="Tooltip here" Icon="Texture\SomeIcon.dds">
  <Entry Type="ItemTypeHere" Subtype="OptionalSubtypeHere" />
  <Entry Type="AmmoMagazine" /> <!-- all magazine items -->
  <Entry Type="Component" Subtype="SteelPlate" /> <!-- only steel plate item -->
  <!-- ... -->
</PullConstraint>

PushConstraint

<PushConstraint>		Type: InventoryConstraintDefinitionDefault: null
Optional. Limits for pushing items to the conveyor network.

Undefined or null will allow all items.

Similar syntax to <PullConstraint>.

(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: StringDefault: 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:

Description

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

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: StringDefault: 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: BooleanDefault: 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:

Public

<Public>		Type: BooleanDefault: 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[1])		Type: BooleanDefault: 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[1])		Type: stringDefault: 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.


  1. ↑ 1.0 1.1 1.2 1.3 1.4 1.5 1.6 1.7 1.8 What are XML attributes?
Retrieved from "https://spaceengineers.wiki.gg/wiki/Modding/Reference/SBC/EntityComponents/ConveyorEndpointComponent_Definition?oldid=38324"