BehaviorTree Definition

From Space Engineers Wiki
Jump to navigation Jump to search
HomeModdingReferenceSBCBehaviorTree Def
Overview
Inherits

Found in AIBehavior.sbc and used by bots.

This definition is not designed to be edited by hand, use the BehaviorTree VRageEditor instead.

Elements

FirstNode

<FirstNode>		Type: BehaviorTreeNodeDefault: null
The root of this behavior tree.
Syntax example: 
<FirstNode xsi:type="MyObjectBuilder_BehaviorTreeSequenceNode">
  <!-- elements depend on the chosen xsi:type -->
</FirstNode>
Where the xsi:type="..." can be one of the Node Types.

Behavior

<Behavior>		Type: StringDefault: Barbarian
Does nothing in the game, it's only info for readers to know what Bot <BehaviorType> this tree was designed for, because that logic dictates what actions are available.

(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 What are XML attributes?

Node Types

Types that can be entered in xsi:type="..." of elements of BehaviorTreeNode type such as <FirstNode>, but not only.

MyObjectBuilder_BehaviorTreeDecoratorNode
MyObjectBuilder_BehaviorTreeDecoratorNode
Exact function is unknown.
<DecoratorLogic>Type: LogicDefault: null
Syntax example: 
<DecoratorLogic xsi:type="CounterLogic">
  <!-- elements depend on the chosen xsi:type -->
</DecoratorLogic>
Where the xsi:type="..."> can be one of the Logic Types.
<DefaultReturnValue>Type: MyDecoratorDefaultReturnValuesDefault: SUCCESS
Available values:
  • SUCCESS
  • FAILURE
  • RUNNING
<BTNode>Type: BehaviorTreeNodeDefault: null
Syntax example: 
<BTNode xsi:type="MyObjectBuilder_BehaviorTreeActionNode">
  <!-- elements depend on the chosen xsi:type -->
</BTNode>
Where the xsi:type="..." can be one of the Node Types.
MyObjectBuilder_BehaviorTreeActionNode
MyObjectBuilder_BehaviorTreeActionNode
Triggers an action on the bot's logic.
<ActionName>Type: StringDefault: null
The action name from the bot's logic (<BehaviorType>), this name cannot be invented.
<Parameters>Type: TypeValue[]Default: null
Optional. List of parameters for the action.

These parameters are defined inside the game code and are different for every action and logic. Visit the Bot's <BehaviorType> page for documentation and make sure to enter the parameters in the exact order and with the exact types as mentioned there.

Syntax example with every possible parameter type: 
<Parameters>
  <Parameter xsi:type="BoolType" BoolValue="true" />
  <Parameter xsi:type="FloatType" FloatValue="40.5" />
  <Parameter xsi:type="IntType" IntValue="12" />
  <Parameter xsi:type="MemType" MemName="target" />
  <Parameter xsi:type="StringType" StringValue="some text" />
</Parameters>
MyObjectBuilder_BehaviorControlBaseNode
MyObjectBuilder_BehaviorControlBaseNode
Exact function is unknown.
<Name>Type: StringDefault: null
<IsMemorable>Type: BooleanDefault: false
<BTNodes>Type: BehaviorTreeNode[]Default: null
A list of nodes.
Syntax example: 
<BTNodes>
  <BTNode xsi:type="MyObjectBuilder_BehaviorTreeActionNode">
    <!-- elements depend on the chosen xsi:type -->
  </BTNode>
  <!-- ... -->
</BTNodes>
Where the xsi:type="..." can be one of the Node Types.
MyObjectBuilder_BehaviorTreeSelectorNode
MyObjectBuilder_BehaviorTreeSelectorNode
Exact function is unknown.

Inherits MyObjectBuilder_BehaviorControlBaseNode therefore has all its elements.

This however provides no additional elements.
MyObjectBuilder_BehaviorTreeSequenceNode
MyObjectBuilder_BehaviorTreeSequenceNode
Exact function is unknown.

Inherits MyObjectBuilder_BehaviorControlBaseNode therefore has all its elements.

This however provides no additional elements.

Logic Types

Types that can be entered in xsi:type="..." for MyObjectBuilder_BehaviorTreeDecoratorNode's <DecoratorLogic>.

TimerLogic
TimerLogic
Exact function is unknown.
<TimeInMs>Type: Int64Default: 0
CounterLogic
CounterLogic
Exact function is unknown.
<Count>Type: Int32Default: 0
Retrieved from "https://spaceengineers.wiki.gg/wiki/Modding/Reference/SBC/BehaviorTree_Definition?oldid=36927"