Action.md

Action Profiles in Rival AI are used in conjunction with Trigger Profiles. These profile are what execute specified actions when the conditions in a Trigger Profile are satisfied. It is important that you use a unique SubtypeId for each Action Profile you create, otherwise they may not work correctly.

Here is an example of how an Action Profile definition is setup:

<?xml version="1.0"?>
<Definitions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <EntityComponents>

    <EntityComponent xsi:type="MyObjectBuilder_InventoryComponentDefinition">
      <Id>
          <TypeId>Inventory</TypeId>
          <SubtypeId>RAI-ExampleActionProfile</SubtypeId>
      </Id>
      <Description>

      [RivalAI Action]

      [UseChatBroadcast:true]
      [ChatData:RAI-ExampleChatProfile]

      [CreateKnownPlayerArea:true]
      [KnownPlayerAreaRadius:15000]
      [KnownPlayerAreaTimer:30]

      </Description>

    </EntityComponent>

  </EntityComponents>
</Definitions>

Below are the tags you are able to use in your Action Profiles. They are divided into several categories based on what they affect.

Abilities
Behavior
Blocks
Communication
Damage
Effects
General
Grid
Inventory
PlayerTags
Reputation
Spawning
Targeting
Trigger
Variables
Zone

Abilities

This section contains actions that enable/disable special abilities for the behavior.

Tag:                                UseJetpackInhibitorEffect
Tag Format: [UseJetpackInhibitorEffect:Value]
Description: This tag specifies if the behavior should enable or disable an internalized Jetpack Inhibitor effect. Since this effect only lasts for the session, it's recommended to use it in combination with a Session Trigger when possible. true enables the effect, while false disables it.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                UseDrillInhibitorEffect
Tag Format: [UseDrillInhibitorEffect:Value]
Description: This tag specifies if the behavior should enable or disable an internalized Hand Drill Inhibitor effect. Since this effect only lasts for the session, it's recommended to use it in combination with a Session Trigger when possible. true enables the effect, while false disables it.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                UseNanobotInhibitorEffect
Tag Format: [UseNanobotInhibitorEffect:Value]
Description: This tag specifies if the behavior should enable or disable an internalized Nanobot Inhibitor effect. Since this effect only lasts for the session, it's recommended to use it in combination with a Session Trigger when possible. true enables the effect, while false disables it.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                UseJumpInhibitorEffect
Tag Format: [UseJumpInhibitorEffect:Value]
Description: This tag specifies if the behavior should enable or disable an internalized Jump Drive Inhibitor effect. Since this effect only lasts for the session, it's recommended to use it in combination with a Session Trigger when possible. true enables the effect, while false disables it.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                UsePlayerInhibitorEffect
Tag Format: [UsePlayerInhibitorEffect:Value]
Description: This tag specifies if the behavior should enable or disable an internalized Player Inhibitor effect. Since this effect only lasts for the session, it's recommended to use it in combination with a Session Trigger when possible. true enables the effect, while false disables it.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                JumpToTarget
Tag Format: [JumpToTarget:Value]
Description: This tag allows you to activate the NPC Jump Drive (if present / ready) and jump to the current target.
Allowed Value(s): true
false
Multiple Tags Allowed: No
Tag:                                JumpToJumpedEntity
Tag Format: [JumpToJumpedEntity:Value]
Description: This tag allows you to activate the NPC Jump Drive (if present / ready) and jump to a grid that recently jumped away. This needs to be used with a JumpCompleted trigger
Allowed Value(s): true
false
Multiple Tags Allowed: No
Tag:                                JumpedEntityMustBeTarget
Tag Format: [JumpedEntityMustBeTarget:Value]
Description: This tag specifies whether or not an entity that jumps away (detected by JumpCompleted trigger) must also be the current target of the NPC in order to Jump / Follow it.
Allowed Value(s): true
false
Multiple Tags Allowed: No
Tag:                                JumpToWaypoint
Tag Format: [JumpToWaypoint:Value]
Description: Specifies if a ship should jump to a provided waypoint profile location.
Allowed Value(s): true
false
Multiple Tags Allowed: No
Tag:                                JumpWaypoint
Tag Format: [JumpWaypoint:Value]
Description: Specifies the waypoint profile id that the ship will use to calculate jump location while using the JumpToWaypoint tag.
Allowed Value(s): Any String Value
Multiple Tags Allowed: No

Behavior

This section contains actions that relate to changes that can be made to the behavior and auto-pilot.

Tag:                                ChangeBehaviorSubclass
Tag Format: [ChangeBehaviorSubclass:Value]
Description: This tag specifies if the Sub-Class of the behavior should be switched to another (eg: change from Fighter to Strike).
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                NewBehaviorSubclass
Tag Format: [NewBehaviorSubclass:Value]
Description: This tag specifies the new Behavior Sub-Class that is used if ChangeBehaviorSubclass is set to true.
Allowed Values: Any Behavior Type
Click Here For Eligible Types
Multiple Tag Allowed: No
Tag:                                ChangeAutopilotSpeed
Tag Format: [ChangeAutopilotSpeed:Value]
Description: This tag specifies if the AutoPilot speed of the current NPC should be changed to a new value.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                NewAutopilotSpeed
Tag Format: [NewAutopilotSpeed:Value]
Description: Specifies the new AutoPilot speed if ChangeAutopilotSpeed was set to true.
Allowed Values: Any number equal/higher than 0
Multiple Tag Allowed: No
Tag:                                ChangeInertiaDampeners
Tag Format: [ChangeInertiaDampeners:Value]
Description: This tag specifies if the AutoPilot should enable or disable the Inertia Dampeners (may only work with some behaviors / modes).
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                InertiaDampenersEnable
Tag Format: [InertiaDampenersEnable:Value]
Description: Specifies the new Inertia Dampeners mode if ChangeInertiaDampeners was set to true.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                BarrelRoll
Tag Format: [BarrelRoll:Value]
Description: This tag specifies if the NPC should perform a roll for a short time. Barrel Roll controls can be found in the Autopilot Profile tags section.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                Ramming
Tag Format: [Ramming:Value]
Description: This tag specifies if the NPC should attempt to ram a target for a short time. Ramming controls can be found in the Autopilot Profile tags section.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                Retreat
Tag Format: [Retreat:Value]
Description: This tag specifies if the Retreat function should be activated in the current behavior.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                RecalculateDespawnCoords
Tag Format: [RecalculateDespawnCoords:Value]
Description: This tag specifies if the NPC should recalculate its Despawn Coordinates if it is using coordinates retrieved from MES or generated within RivalAI. The newly generated coordinates will be created from data in the Active Autopilot Profile of the behavior.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                ForceDespawn
Tag Format: [ForceDespawn:Value]
Description: This tag specifies if the NPC grid should immediately be despawned.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                TerminateBehavior
Tag Format: [TerminateBehavior:Value]
Description: This tag specifies if the current NPC Behavior should be terminated (meaning no more AI processing from that behavior).
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                ChangeRotationDirection
Tag Format: [ChangeRotationDirection:Value]
Description: This tag specifies if the ship should use a different direction when rotating towards a target. Specify direction using the RotationDirection tag
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                RotationDirection
Tag Format: [RotationDirection:Value]
Description: This tag specifies the direction a ship should use when rotating towards a target if ChangeRotationDirection is true.
Allowed Values: Forward
Backward
Up
Down
Left
Right
Multiple Tag Allowed: No
Tag:                                ChangeAutopilotProfile
Tag Format: [ChangeAutopilotProfile:Value]
Description: This tag specifies if the Autopilot Profile should be switched to another mode, using another attached Autopilot Profile.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                AutopilotProfile
Tag Format: [AutopilotProfile:Value]
Description: This tag specifies the Autopilot Profile Mode that should be switched to.
Allowed Values: Primary
Secondary
Tertiary
Multiple Tag Allowed: No
Tag:                                StopAllRotation
Tag Format: [StopAllRotation:Value]
Description: This tag will set all Gyroscope Overrides to 0 on the NPC. This is useful when paired with a Compromised trigger to stop any gyros that may be stuck rotating when a RivalAI Remote Control is disabled.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                StopAllThrust
Tag Format: [StopAllThrust:Value]
Description: This tag will set all Thruster Overrides to 0 on the NPC. This is useful when paired with a Compromised trigger to stop any thrusters that may be stuck in override when a RivalAI Remote Control is disabled.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                RandomGyroRotation
Tag Format: [RandomGyroRotation:Value]
Description: This tag will set a random Gyroscopic rotation and apply it to the NPC grid. This is useful when paired with a Compromised trigger.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                RandomThrustDirection
Tag Format: [RandomThrustDirection:Value]
Description: This tag will set a random Thruster Override Strength and Direction, and apply it to the NPC grid. This is useful when paired with a Compromised trigger.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                UseCurrentPositionAsPatrolReference
Tag Format: [UseCurrentPositionAsPatrolReference:Value]
Description: This tag sets the current position of the NPC as its Patrol Reference so it will calculate offsets starting from that position instead of using its initial spawn coordinates.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                ClearCustomPatrolReference
Tag Format: [ClearCustomPatrolReference:Value]
Description: This tag removes any saved coordinates that may have been set using UseCurrentPositionAsPatrolReference so behaviors using patrol will revert to using their initial spawn coordinates to calculate patrol offsets.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                ClearAllWaypoints
Tag Format: [ClearAllWaypoints:Value]
Description: Specifies if all current waypoints should be erased when using the CargoShip behavior subclass. This will result in the behavior travelling to its generated despawn coordinates.
Allowed Value(s): true
false
Multiple Tags Allowed: No
Tag:                                AddWaypoints
Tag Format: [AddWaypoints:Value]
Description: Specifies if one or more Waypoints should be created and added to a behavior if they are using the CargoShip subclass.
Allowed Value(s): true
false
Multiple Tags Allowed: No
Tag:                                WaypointsToAdd
Tag Format: [WaypointsToAdd:Value]
Description: Specifies the name(s) of the waypoint profiles you want to add to a CargoShip subclass behavior if using the AddWaypoints tag
Allowed Value(s): Waypoint Profile SubtypeId
Multiple Tags Allowed: Yes
Tag:                                CancelWaitingAtWaypoint
Tag Format: [CancelWaitingAtWaypoint:Value]
Description: Specifies if a CargoShip subclass behavior should stop waiting at a waypoint it reached and begin travelling to the next eligible waypoint.
Allowed Value(s): true
false
Multiple Tags Allowed: No
Tag:                                SwitchToNextWaypoint
Tag Format: [SwitchToNextWaypoint:Value]
Description: Specifies if a CargoShip subclass behavior should have its current waypoint that is being travelled to cancelled so it can move onto the next eligible waypoint.
Allowed Value(s): true
false
Multiple Tags Allowed: No

Blocks

This section contains actions that affect the state of blocks on the NPC grid.

Tag:                                EnableBlocks
Tag Format: [EnableBlocks:Value]
Description: This tag specifies if certain blocks should be turned On or Off.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                EnableBlockNames
Tag Format: [EnableBlockNames:Value]
Description: This tag specifies the name(s) of blocks that you want to toggle on or off.
Allowed Values: Any Block Name
Multiple Tag Allowed: Yes
Tag:                                EnableBlockStates
Tag Format: [EnableBlockStates:Value]
Description: This tag specifies the On/Off state of blocks that you want to toggle on or off.
Allowed Values: Off
On
Toggle
Multiple Tag Allowed: Yes
Tag:                                ChangeAntennaRanges
Tag Format: [ChangeAntennaRanges:Value]
Description: This tag specifies if attached antennas should have their range changed.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                AntennaNamesForRangeChange
Tag Format: [AntennaNamesForRangeChange:Value]
Description: This tag specifies the name of the antenna(s) that should have their ranges changed. If this tag is not provided, then all antennas will be affected
Allowed Values: Any Antenna Name
Multiple Tag Allowed: Yes
Tag:                                AntennaRangeChangeType
Tag Format: [AntennaRangeChangeType:Value]
Description: This tag specifies how the antenna range should be changed by using this value with the value of AntennaRangeChangeAmount.
Allowed Values: Set
Increase
Decrease
Multiple Tag Allowed: No
Tag:                                AntennaRangeChangeAmount
Tag Format: [AntennaRangeChangeAmount:Value]
Description: This tag specifies how much the antenna range should be changed by.
Allowed Values: Any Number Greater Than 0
Multiple Tag Allowed: No
Tag:                                ChangeAntennaOwnership
Tag Format: [ChangeAntennaOwnership:Value]
Description: This tag specifies if Antenna Blocks on the current NPC grid should have their ownership changed.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                AntennaFactionOwner
Tag Format: [AntennaFactionOwner:Value]
Description: Specifies the faction (by faction tag) that antenna blocks get changed to if ChangeAntennaOwnership is true.
Allowed Values: Any Faction Tag
Multiple Tag Allowed: No
Tag:                                ChangeBlockNames
Tag Format: [ChangeBlockNames:Value]
Description: This tag specifies if blocks on the NPC grid should have their names changed.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                ChangeBlockNamesFrom
Tag Format: [ChangeBlockNamesFrom:Value]
Description: This tag specifies a name of a Block that will have its name changed. Ideally you should place this tag before the ChangeBlockNamesTo tag, keeping them in pairs in your Action Profile.
Allowed Values: Any text/string excluding :, [, ]
Multiple Tag Allowed: Yes
Tag:                                ChangeBlockNamesTo
Tag Format: [ChangeBlockNamesTo:Value]
Description: This tag specifies the name that a Block specified in ChangeBlockNamesFrom will be changed to. Ideally you should place this tag after the ChangeBlockNamesFrom tag, keeping them in pairs in your Action Profile.
Allowed Values: Any text/string excluding :, [, ]
Multiple Tag Allowed: Yes
Tag:                                TriggerTimerBlocks
Tag Format: [TriggerTimerBlocks:Value]
Description: This tag specifies if select Timer Blocks on the current NPC grid should be Triggered.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                TimerBlockNames
Tag Format: [TimerBlockNames:Value]
Description: This tag specifies a name of a Timer Block on the current NPC grid should be Triggered.
Allowed Values: Any text/string excluding :, [, ]
Multiple Tag Allowed: Yes
Tag:                                SelfDestruct
Tag Format: [SelfDestruct:Value]
Description: This tag specifies if all Warhead Blocks on the current NPC grid should be detonated.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                StaggerWarheadDetonation
Tag Format: [StaggerWarheadDetonation:Value]
Description: This tag specifies if warheads should be detonated in 1 second intervals instead of all at once.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                SelfDestructTimerPadding
Tag Format: [SelfDestructTimerPadding:Value]
Description: This tag specifies the minimum time that all warheads will start at if countdown is initiated.
Allowed Values: Any number greater or equal to 0
Multiple Tag Allowed: No
Tag:                                SelfDestructTimeBetweenBlasts
Tag Format: [SelfDestructTimeBetweenBlasts:Value]
Description: This tag specifies the time between detonations that is applied to warheads if StaggerWarheadDetonation is used.
Allowed Values: Any number greater or equal to 0
Multiple Tag Allowed: No
Tag:                                ChangeBlockOwnership
Tag Format: [ChangeBlockOwnership:Value]
Description: This tag specifies if some blocks should have their ownership changed. Block names and Faction Tags should be provided in the OwnershipBlockNames and OwnershipBlockFactions tags together.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                OwnershipBlockNames
Tag Format: [OwnershipBlockNames:Value]
Description: This tag specifies a name of a Block that gets it's ownership changed.
Allowed Values: Any text/string excluding :, [, ]
Multiple Tag Allowed: Yes
Tag:                                OwnershipBlockFactions
Tag Format: [OwnershipBlockFactions:Value]
Description: This tag specifies a name of a faction that a block ownership should be changed to.
Allowed Values: Any Faction Tag
Multiple Tag Allowed: Yes
Tag:                                RazeBlocksWithNames
Tag Format: [RazeBlocksWithNames:Value]
Description: This tag specifies if some blocks should be destroyed on the NPC grid.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                RazeBlocksNames
Tag Format: [RazeBlocksNames:Value]
Description: This tag specifies names of blocks that are destroyed when the action is executed.
Allowed Values: Any Block Name
Multiple Tag Allowed: Yes
Tag:                                RazeBlocksOfType
Tag Format: [RazeBlocksOfType:Value]
Description: This tag specifies if some block types should be destroyed on the NPC grid.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                RazeBlocksTypes
Tag Format: [RazeBlocksTypes:Value]
Description: This tag specifies types of blocks that are destroyed when the action is executed.
Allowed Values: Any Block Type (eg MyObjectBuilder_CubeBlock/SomeBlockSubtypeId)
Multiple Tag Allowed: Yes
Tag:                                ToggleBlocksOfType
Tag Format: [ToggleBlocksOfType:Value]
Description: This tag specifies if blocks of a matching type should be set to on, off, or toggled from existing state.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                BlockTypesToToggle
Tag Format: [BlockTypesToToggle:Value]
Description: This tag specifies the types of block that will be toggled. This tag needs to be paired with a BlockTypeToggles tag.
Allowed Values: Any Block DefinitionID
Eg: MyObjectBuilder_Parachute/LgParachute
Multiple Tag Allowed: Yes
Tag:                                BlockTypeToggles
Tag Format: [BlockTypeToggles:Value]
Description: This tag specifies the toggle action that will be applied to a block type. This tag needs to be paired with a BlockTypesToToggle tag.
Allowed Values: Off
On
Toggle
Multiple Tag Allowed: Yes
Tag:                                BuildProjectedBlocks
Tag Format: [BuildProjectedBlocks:Value]
Description: This tag specifies if a number of blocks currently being projected from the NPC Grid should be built instantly. The projection must already be active at the time this Action is activated (enabling the projector and using this action in the same profile may not work since there is a minor delay when the projection is being created in game).
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                MaxProjectedBlocksToBuild
Tag Format: [MaxProjectedBlocksToBuild:Value]
Description: Specifies the maximum number of blocks that are built if BuildProjectedBlocks is true. If this value is not defined, or the value is set to -1, then all currently eligible blocks will be built on the projection.
Allowed Values: Any Integer higher than -1
Multiple Tag Allowed: No
Tag:                                SetWeaponsToMinRange
Tag Format: [SetWeaponsToMinRange:Value]
Description: This tag specifies if all auto-firing weapons (turrets, weapon core homing weapons, etc) should be limited to 800m.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                SetWeaponsToMaxRange
Tag Format: [SetWeaponsToMaxRange:Value]
Description: This tag specifies if all auto-firing weapons (turrets, weapon core homing weapons, etc) should be set to their maximum range.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                EnableHighestRangeAntennas
Tag Format: [EnableHighestRangeAntennas:Value]
Description: This tag specifies if all antennas on the current grid that have the highest range should be turned on.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                DisableHighestRangeAntennas
Tag Format: [DisableHighestRangeAntennas:Value]
Description: This tag specifies if all antennas on the current grid that have the highest range should be turned off.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                ApplyLcdChanges
Tag Format: [ApplyLcdChanges:Value]
Description: This tag allows you to specify if one or more blocks should have their LCD contents changed.
Allowed Value(s): true
false
Multiple Tags Allowed: No
Tag:                                LcdTextTemplateFile
Tag Format: [LcdTextTemplateFile:Value]
Description: This tag allows you to specify the name of the TextTemplate file that is used for populating LCD content if using the ApplyLcdChanges tag
Allowed Value(s): Any String Value
Multiple Tags Allowed: No
Tag:                                LcdBlockNames
Tag Format: [LcdBlockNames:Value]
Description: This tag allows you to specify one or more block name that will have LCD contents changed if using the ApplyLcdChanges tag. Each instance of this tag should be paired with the LcdTemplateIndexes tag as well.
Allowed Value(s): Any String Value
Multiple Tags Allowed: Yes
Tag:                                LcdTemplateIndexes
Tag Format: [LcdTemplateIndexes:Value]
Description: This tag allows you to specify one or more index that is used to select an Lcd Entry in the TextTemplate file if using the ApplyLcdChanges tag. Each instance of this tag should be paired with the LcdBlockNames tag as well.
Allowed Value(s): Any Integer Greater/Equal To 0
Multiple Tags Allowed: Yes

Communication

This section contains actions for NPC to NPC communication.

Tag:                                UseChatBroadcast
Tag Format: [UseChatBroadcast:Value]
Description: This tag specifies if an attached Chat Profile should be activated.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                ChatData
Tag Format: [ChatData:Value]
Description: This tag specifies which Chat Profile should be activated if UseChatBroadcast is true.
Allowed Values: Any Chat Profile SubtypeId
Multiple Tag Allowed: Yes
Tag:                                BroadcastCommandProfiles
Tag Format: [BroadcastCommandProfiles:Value]
Description: This tag specifies if the Behavior should broadcast one or more Command Profile to other nearby NPCs.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                CommandProfileIds
Tag Format: [CommandProfileIds:Value]
Description: This tag specifies the SubtypeId of a Command Profile that you want to use in your broadcast to other nearby NPCs.
Allowed Values: Any Command Profile SubtypeId
Multiple Tag Allowed: Yes
Tag:                                AddWaypointFromCommand
Tag Format: [AddWaypointFromCommand:Value]
Description: This tag specifies if the Behavior should add a waypoint received by a command to its list of waypoints. This is mostly for use by the CargoShip behavior, but others may use it in the future.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                SwitchToReceivedTarget
Tag Format: [SwitchToReceivedTarget:Value]
Description: This tag specifies if the Behavior should switch to a new target provided by either the damage or broadcast system.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                InheritLastAttackerFromCommand
Tag Format: [InheritLastAttackerFromCommand:Value]
Description: This tag specifies if the Behavior should consider the received target from a command as an entity that attacked it as well. Required for some behavior specific actions.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                AssignEscortFromCommand
Tag Format: [AssignEscortFromCommand:Value]
Description: This tag allows you to assign any potential Escort Requests to an empty escort slot (if available) for this NPC. The Escort Requests are received by Command Profile related Triggers.
Allowed Value(s): true
false
Multiple Tags Allowed: No

Damage

This section contains actions for damaging other entities.

Tag:                                DamageToolAttacker
Tag Format: [DamageToolAttacker:Value]
Description: This tag specifies if a player or block attacking the current NPC with a Grinder/Drill should receive damage. This tag only works if called from a Trigger Profile that uses Damage as a Trigger Type.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                DamageToolAttackerAmount
Tag Format: [DamageToolAttackerAmount:Value]
Description: Specifies the amount of damage a target receives if DamageToolAttacker is true.
Allowed Values: Any Number higher than 0
Multiple Tag Allowed: No
Tag:                                DamageToolAttackerParticle
Tag Format: [DamageToolAttackerParticle:Value]
Description: Specifies a particle effect that will display over the attacker if DamageToolAttacker is true.
Allowed Values: Any Particle Effect SubtypeId
Multiple Tag Allowed: No
Tag:                                DamageToolAttackerSound
Tag Format: [DamageToolAttackerSound:Value]
Description: Specifies a sound effect that will display over the attacker if DamageToolAttacker is true.
Allowed Values: Any Audio SubtypeId
Multiple Tag Allowed: No
Tag:                                GenerateExplosion
Tag Format: [GenerateExplosion:Value]
Description: This tag specifies if an Explosion should be generated at the coordinates of the Remote Control.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                ExplosionOffsetFromRemote
Tag Format: [ExplosionOffsetFromRemote:Value]
Description: This tag specifies the Offset from the Remote Control Position that the explosion should be created at if GenerateExplosion is true.
Allowed Values: A Vector3D Value in the following format:
{X:# Y:# Z:#}
X: Right
Y: Up
Z: Forward
Replace # with values in meters.
Multiple Tag Allowed: No
Tag:                                ExplosionRange
Tag Format: [ExplosionRange:Value]
Description: Specifies the radius of the Explosion if GenerateExplosion is true. The particle effect used for the explosion changes depending on this value:
0-1: Tiny
2-14: Small
15-29: Medium
30+: Large
Allowed Values: Any Number Greater Than 0
Multiple Tag Allowed: No
Tag:                                ExplosionDamage
Tag Format: [ExplosionDamage:Value]
Description: Specifies the damage of the Explosion if GenerateExplosion is true.
Allowed Values: Any Number Greater Than 0
Multiple Tag Allowed: No
Tag:                                ExplosionIgnoresVoxels
Tag Format: [ExplosionIgnoresVoxels:Value]
Description: This tag specifies if an Explosion should skip damage to voxels if GenerateExplosion is true.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                CreateRandomLightning
Tag Format: [CreateRandomLightning:Value]
Description: This tag specifies if a bolt of lightning should be generated near the NPC. Only works on planets that have atmosphere.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                CreateLightningAtAttacker
Tag Format: [CreateLightningAtAttacker:Value]
Description: This tag specifies if a bolt of lightning should be generated at the position of the entity that caused damage to the NPC. Only works on planets that have atmosphere.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                CreateLightningAtTarget
Tag Format: [CreateLightningAtTarget:Value]
Description: This tag specifies if a bolt of lightning should be generated at the position of current target. Only works on planets that have atmosphere.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                LightningDamage
Tag Format: [LightningDamage:Value]
Description: Specifies the damage of lightning bolts created by an Action.
Allowed Values: Any Number Greater Than 0
Multiple Tag Allowed: No
Tag:                                LightningExplosionRadius
Tag Format: [LightningExplosionRadius:Value]
Description: Specifies the explosion radius of lightning bolts created by an Action.
Allowed Values: Any Number Greater Than 0
Multiple Tag Allowed: No
Tag:                                LightningColor
Tag Format: [LightningColor:Value]
Description: Specifies the color of lightning bolts created by an Action.
Allowed Values: {X:0 Y:0 Z:0}
X 0 - 100 (Red)
Y 0 - 100 (Green)
Z 0 - 100 (Blue)
Multiple Tag Allowed: No
Tag:                                LightningMinDistance
Tag Format: [LightningMinDistance:Value]
Description: Specifies the minimum distance from the NPC that lightning will be created at if CreateRandomLightning is true.
Allowed Values: Any Number Greater Than 0
Must be lower than LightningMaxDistance
Multiple Tag Allowed: No
Tag:                                LightningMaxDistance
Tag Format: [LightningMaxDistance:Value]
Description: Specifies the maximum distance from the NPC that lightning will be created at if CreateRandomLightning is true.
Allowed Values: Any Number Greater Than 0
Must be higher than LightningMinDistance
Multiple Tag Allowed: No

Effects

This section contains actions for playing audio and visual effects.

Tag:                                PlaySoundAtPosition
Tag Format: [PlaySoundAtPosition:Value]
Description: This tag specifies if a single sound effect should be played at the NPC current position. This does not require a sound block, or any additional grid configuration.
Allowed Value(s): true
false
Multiple Tags Allowed: No
Tag:                                SoundAtPosition
Tag Format: [SoundAtPosition:Value]
Description: This tag specifies the name of the sound effect you want to play if using PlaySoundAtPosition
Allowed Value(s):
Multiple Tags Allowed: No

General

This section contains actions that don't quite fit the other sections.

Tag:                                Chance
Tag Format: [Chance:Value]
Description: Specifies the Chance (out of 100) that this action will be run.
Allowed Values: Any Number 0 to 100
Multiple Tag Allowed: No
Tag:                                SetGridCleanupExempt
Tag Format: [SetGridCleanupExempt:Value]
Description: This tag specifies if the NPC grid should be temporarily exempt from MES cleanup processes.
Allowed Value(s): true
false
Multiple Tags Allowed: No
Tag:                                GridCleanupExemptDuration
Tag Format: [GridCleanupExemptDuration:Value]
Description: This tag specifies the length of time (in seconds) that the NPC will be exempt from cleanup if used with the SetGridCleanupExempt tag
Allowed Value(s): Any Integer Greater/Equal To 0
Multiple Tags Allowed: No

Grid

This section contains actions that affect the entire grid.

Tag:                                RecolorGrid
Tag Format: [RecolorGrid:Value]
Description: This tag specifies if selected blocks on the grid should be recolored and reskinned.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                RecolorSubGrids
Tag Format: [RecolorSubGrids:Value]
Description: This tag specifies if subgrids should also be considered when using the RecolorGrid tag.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                OldBlockColors
Tag Format: [OldBlockColors:Value]
Description: This tag specifies the old colors that are targeted for replacement when using the RecolorGrid tag. You should also include NewBlockColors and NewBlockSkins tags together when using this tag.
Allowed Values: A Vector3D Value in the following format:
{X:# Y:# Z:#}
X: Right
Y: Up
Z: Forward
Replace # with matching values from ColorMaskHSV
Multiple Tag Allowed: Yes
Tag:                                NewBlockColors
Tag Format: [NewBlockColors:Value]
Description: This tag specifies the new colors that are used for replacement when using the RecolorGrid tag. Provide {X:-10 Y:-10 Z:-10} to skip replacing color if you only intend to replace skin.
Allowed Values: A Vector3D Value in the following format:
{X:# Y:# Z:#}
X: Right
Y: Up
Z: Forward
Replace # with matching values from ColorMaskHSV
Multiple Tag Allowed: Yes
Tag:                                NewBlockSkins
Tag Format: [NewBlockSkins:Value]
Description: This tag specifies the new skins that are used for replacement when using the RecolorGrid tag. Provide a single blank space to skip replacing skin if you only intend to replace color.
Allowed Values: Any Armor Skin SubtypeId
Multiple Tag Allowed: Yes
Tag:                                GridEditable
Tag Format: [GridEditable:Value]
Description: This tag specifies if the NPC Grid is able to be edited (add/remove/weld/grind blocks).
Allowed Values: Yes
No
Multiple Tag Allowed: No
Tag:                                SubGridsEditable
Tag Format: [SubGridsEditable:Value]
Description: This tag specifies if sub-grids editable state should also be changed if GridEditable tag is used.
Allowed Values: Yes
No
Multiple Tag Allowed: No
Tag:                                GridDestructible
Tag Format: [GridDestructible:Value]
Description: This tag specifies if the NPC Grid should have destructible blocks (can receive damage).
Allowed Values: Yes
No
Multiple Tag Allowed: No
Tag:                                SubGridsDestructible
Tag Format: [SubGridsDestructible:Value]
Description: This tag specifies if sub-grids destructible state should also be changed if GridDestructible tag is used.
Allowed Values: Yes
No
Multiple Tag Allowed: No

Inventory

Tag:                                ApplyContainerTypeToInventoryBlock
Tag Format: [ApplyContainerTypeToInventoryBlock:Value]
Description: This tag specifies if one or more block should have their inventories filled using a specified ContainerType definition subtypeID.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                ContainerTypeBlockNames
Tag Format: [ContainerTypeBlockNames:Value]
Description: This tag specifies one or more Block Names of blocks that will have inventory applied if using the ApplyContainerTypeToInventoryBlock tag. This tag should be paired with the ContainerTypeSubtypeIds tag.
Allowed Values: Any text/string excluding :, [, ]
Multiple Tag Allowed: Yes
Tag:                                ContainerTypeSubtypeIds
Tag Format: [ContainerTypeSubtypeIds:Value]
Description: This tag specifies one or more TextTemplate files that will be used to set block custom data if using the ApplyContainerTypeToInventoryBlock tag. This tag should be paired with the ContainerTypeBlockNames tag.
Allowed Values: ContainerType definition SubtypeId
Multiple Tag Allowed: Yes
Tag:                                AddDatapadsToSeats
Tag Format: [AddDatapadsToSeats:Value]
Description: This tag specifies if one or more Datapads should be added to seats randomly on the grid.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                DatapadNamesToAdd
Tag Format: [DatapadNamesToAdd:Value]
Description: Specifies one or more RivalAI Datapad Profiles to use when randomly adding Datapads to seats.
Allowed Values: Any RivalAI Datapad Profile
Multiple Tag Allowed: Yes
Tag:                                DatapadCountToAdd
Tag Format: [DatapadCountToAdd:Value]
Description: Specifies the number of random Datapads that get added to seats on the grid.
Allowed Values: Any Number Greater Than 0
Multiple Tag Allowed: No

PlayerTags

Tag:                                AddTagstoPlayers
Tag Format: [AddTagstoPlayers:Value]
Description: nan
Allowed Values: true
false
Multiple Tag Allowed: no
Tag:                                AddTagsPlayerConditionIds
Tag Format: [AddTagsPlayerConditionIds:Value]
Description: nan
Allowed Values: Any name string excluding :, [, ]
Multiple Tag Allowed: yes
Tag:                                AddTags
Tag Format: [AddTags:Value]
Description: nan
Allowed Values: Any name string excluding :, [, ]
Multiple Tag Allowed: yes
Tag:                                AddTagsIncludeSavedPlayerIdentity
Tag Format: [AddTagsIncludeSavedPlayerIdentity:Value]
Description: nan
Allowed Values: true
false
Multiple Tag Allowed: no
Tag:                                AddTagsOverridePositionInPlayerCondition
Tag Format: [AddTagsOverridePositionInPlayerCondition:Value]
Description: nan
Allowed Values: true
false
Multiple Tag Allowed: no
Tag:                                RemoveTagsFromPlayers
Tag Format: [RemoveTagsFromPlayers:Value]
Description: nan
Allowed Values: true
false
Multiple Tag Allowed: no
Tag:                                RemoveTagsPlayerConditionIds
Tag Format: [RemoveTagsPlayerConditionIds:Value]
Description: nan
Allowed Values: Any name string excluding :, [, ]
Multiple Tag Allowed: yes
Tag:                                RemoveTags
Tag Format: [RemoveTags:Value]
Description: nan
Allowed Values: Any name string excluding :, [, ]
Multiple Tag Allowed: yes
Tag:                                RemoveTagsIncludeSavedPlayerIdentity
Tag Format: [RemoveTagsIncludeSavedPlayerIdentity:Value]
Description: nan
Allowed Values: true
false
Multiple Tag Allowed: no
Tag:                                RemoveTagsOverridePositioninPlayerCondition
Tag Format: [RemoveTagsOverridePositioninPlayerCondition:Value]
Description: nan
Allowed Values: true
false
Multiple Tag Allowed: no

Reputation

This section contains actions that affect the reputation of players interacting with NPC grids.

Tag:                                ChangeReputationWithPlayers
Tag Format: [ChangeReputationWithPlayers:Value]
Description: This tag specifies if players within a radius near the current NPC should have their reputation changed with the NPC faction.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                ReputationChangeRadius
Tag Format: [ReputationChangeRadius:Value]
Description: Specifies the radius that players are detected for reputation change if ChangeReputationWithPlayers is true.
Allowed Values: Any Number Greater Than 0
Multiple Tag Allowed: No
Tag:                                ReputationChangeFactions
Tag Format: [ReputationChangeFactions:Value]
Description: Specifies one or more Faction Tags that player reputation is changed with. If you provide the value {Self}, the NPCs faction will be used. This tag must be paired with a ReputationChangeAmount value
Allowed Values: Any Faction Tag
Multiple Tag Allowed: Yes
Tag:                                ReputationChangeAmount
Tag Format: [ReputationChangeAmount:Value]
Description: Specifies the amount of reputation that is changed with a faction to eligible players if ChangeReputationWithPlayers is true. This tag must be paired with a ReputationChangeFactions value
Allowed Values: Any Integer between -1500 and 1500
Multiple Tag Allowed: Yes
Tag:                                ReputationChangesForAllRadiusPlayerFactionMembers
Tag Format: [ReputationChangesForAllRadiusPlayerFactionMembers:Value]
Description: This tag specifies if reputation made to a player should affect all players in that player's faction.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                ChangeAttackerReputation
Tag Format: [ChangeAttackerReputation:Value]
Description: This tag specifies if reputation should be changed if a player attacks the NPC.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                ChangeAttackerReputationFaction
Tag Format: [ChangeAttackerReputationFaction:Value]
Description: Specifies one or more Faction Tags that player reputation is changed with. If you provide the value {Self}, the NPCs faction will be used. This tag must be paired with a ChangeAttackerReputationAmount value
Allowed Values: Any Faction Tag
Multiple Tag Allowed: Yes
Tag:                                ChangeAttackerReputationAmount
Tag Format: [ChangeAttackerReputationAmount:Value]
Description: Specifies the amount of reputation that is changed with a faction to attacking players if ChangeReputationWithPlayers is true. This tag must be paired with a ChangeAttackerReputationFaction value
Allowed Values: Any Integer between -1500 and 1500
Multiple Tag Allowed: Yes
Tag:                                ReputationChangesForAllAttackPlayerFactionMembers
Tag Format: [ReputationChangesForAllAttackPlayerFactionMembers:Value]
Description: This tag specifies if reputation made to a player should affect all players in that player's faction.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                ReputationMinCap
Tag Format: [ReputationMinCap:Value]
Description: This tag allows you to specify the Minimum Reputation level that the action is able to decrease to. If the existing reputation is already lower than the cap, then no further decrease will occur.
Allowed Value(s): Any Integer Greater/Equal To 0
Multiple Tags Allowed: No
Tag:                                ReputationMaxCap
Tag Format: [ReputationMaxCap:Value]
Description: This tag allows you to specify the Maximum Reputation level that the action is able to increase to. If the existing reputation is already higher than the cap, then no further increase will occur.
Allowed Value(s): Any Integer Greater/Equal To 0
Multiple Tags Allowed: No

Spawning

This section contains actions that allow NPCs to Spawn other NPCs, along with other actions that are triggered via the Modular Encounters Spawner API.

Tag:                                SpawnEncounter
Tag Format: [SpawnEncounter:Value]
Description: This tag specifies if an attached Spawn Profile should be activated.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                Spawner
Tag Format: [Spawner:Value]
Description: This tag specifies which Spawn Profile should be activated if SpawnEncounter is true.
Allowed Values: Any Spawn Profile SubtypeId
Multiple Tag Allowed: Yes
Tag:                                CreateKnownPlayerArea
Tag Format: [CreateKnownPlayerArea:Value]
Description: This tag specifies if the area around the current NPC should be designated as a Known Player Area in the Modular Encounters Spawner mod (this tag is only functional if that mod is loaded in the game world).
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                KnownPlayerAreaRadius
Tag Format: [KnownPlayerAreaRadius:Value]
Description: Specifies the radius from the current NPC for the Known Player Area if CreateKnownPlayerArea is true.
Allowed Values: Any Number higher than 0
Multiple Tag Allowed: No
Tag:                                KnownPlayerAreaTimer
Tag Format: [KnownPlayerAreaTimer:Value]
Description: Specifies the max area time-limit (in minutes) for the Known Player Area if CreateKnownPlayerArea is true.
Allowed Values: Any Integer equal/higher than 0
Multiple Tag Allowed: No
Tag:                                KnownPlayerAreaMaxSpawns
Tag Format: [KnownPlayerAreaMaxSpawns:Value]
Description: Specifies the max amount of spawns for the Known Player Area if CreateKnownPlayerArea is true.
Allowed Values: Any Integer equal/higher than -1
Multiple Tag Allowed: No
Tag:                                RemoveKnownPlayerArea
Tag Format: [RemoveKnownPlayerArea:Value]
Description: This tag specifies if a Known Player Location at the current NPC position should be removed. This will only remove locations that match the faction of the NPC or are not designated to an NPC faction.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                RemoveAllKnownPlayerAreas
Tag Format: [RemoveAllKnownPlayerAreas:Value]
Description: This tag specifies if all Known Player Locations at the current NPC position should be removed, regardless of faction ownership. RemoveKnownPlayerArea must also be true for this tag to activate.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                AddBotsToGrid
Tag Format: [AddBotsToGrid:Value]
Description: This tag specifies if a number of AiEnabled (External Mod) Bots should be spawned onto the NPC Grid.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                BotCount
Tag Format: [BotCount:Value]
Description: This tag specifies the number of AiEnabled bots that should be spawned onto the grid.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                BotSpawnProfileNames
Tag Format: [BotSpawnProfileNames:Value]
Description: This tag specifies the name(s) of the Spawn Bot Profiles that you want to use to spawn the bots. If multiple values are provided, then each spawn will select one at random.
Allowed Values: Any Spawn Bot Profile SubtypeId
Multiple Tag Allowed: Yes
Tag:                                OnlySpawnBotsInPressurizedRooms
Tag Format: [OnlySpawnBotsInPressurizedRooms:Value]
Description: This tag specifies if AiEnabled bots should only be spawned in pressurized spaces on the NPC grid. The location cannot be directly controlled from RivalAI, since the AiEnabled mod is what calculates the safe placement nodes. If you need them to appear in a specific room, you may want to arrange it so that room is the only air-tight space on the grid at the time of spawning.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                SpawnPlanet
Tag Format: [SpawnPlanet:Value]
Description: This tag specifies if the NPC should spawn an entire freakin planet.
Allowed Value(s): true
false
Multiple Tags Allowed: No
Tag:                                PlanetName
Tag Format: [PlanetName:Value]
Description: This tag specifies the name of the planet being spawned if using SpawnPlanet
Allowed Value(s): Any Planet SubtypeId
Multiple Tags Allowed: No
Tag:                                PlanetSize
Tag Format: [PlanetSize:Value]
Description: This tag specifies the size (diameter, in meters) of the planet that will be spawned if using SpawnPlanet
Allowed Value(s): Any Number Greater/Equal To 100
Multiple Tags Allowed: No
Tag:                                PlanetWaypointProfile
Tag Format: [PlanetWaypointProfile:Value]
Description: This tag specifies the name of a Waypoint Profile that will be used to govern the spawning position of the planet if using SpawnPlanet
Allowed Value(s): Any Waypoint Profile SubtypeId
Multiple Tags Allowed: No
Tag:                                TemporaryPlanet
Tag Format: [TemporaryPlanet:Value]
Description: This tag specifies if the spawned planet should be deleted after a set amount of time if using SpawnPlanet
Allowed Value(s): true
false
Multiple Tags Allowed: No
Tag:                                PlanetTimeLimit
Tag Format: [PlanetTimeLimit:Value]
Description: This tag specifies the time (in seconds) before the planet is despawned if using SpawnPlanet and TemporaryPlanet
Allowed Value(s): Any Integer Greater/Equal To 1
Multiple Tags Allowed: No

Targeting

This section contains actions that change or affect targeting.

Tag:                                RefreshTarget
Tag Format: [RefreshTarget:Value]
Description: This tag specifies if the Behavior should refresh its current target using its own Target Profile rules.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                ChangeTargetProfile
Tag Format: [ChangeTargetProfile:Value]
Description: This tag specifies if the Current Target Profile should be replaced with another. The target evaluation is NOT immediately refreshed when this tag is used, so if you require the new targeting to be used right away, you should also use the RefreshTarget tag in your Action.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                NewTargetProfileId
Tag Format: [NewTargetProfileId:Value]
Description: This tag specifies the new Target Profile you want the behavior to use if ChangeTargetProfile is set to true.
Allowed Values: Valid Target Profile SubtypeId
Multiple Tag Allowed: No

Trigger

This section contains actions that allow you to change properties of Triggers on the current NPC.

Tag:                                ResetCooldownTimeOfTriggers
Tag Format: [ResetCooldownTimeOfTriggers:Value]
Description: This tag specifies if one or more Trigger Profiles should have their current cooldown timer reset.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                ResetTriggerCooldownNames
Tag Format: [ResetTriggerCooldownNames:Value]
Description: This tag specifies a name of a Trigger Profile that should have its cooldown timer reset.
Allowed Values: Any text/string excluding :, [, ]
Multiple Tag Allowed: Yes
Tag:                                EnableTriggers
Tag Format: [EnableTriggers:Value]
Description: This tag specifies if one or more Trigger Profiles should be enabled (ie, UseTrigger set to true).
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                EnableTriggerNames
Tag Format: [EnableTriggerNames:Value]
Description: This tag specifies a name of a Trigger Profile that should have be Enabled.
Allowed Values: Any text/string excluding :, [, ]
Multiple Tag Allowed: Yes
Tag:                                DisableTriggers
Tag Format: [DisableTriggers:Value]
Description: This tag specifies if one or more Trigger Profiles should be disabled (ie, UseTrigger set to false).
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                DisableTriggerNames
Tag Format: [DisableTriggerNames:Value]
Description: This tag specifies a name of a Trigger Profile that should have be Disabled.
Allowed Values: Any text/string excluding :, [, ]
Multiple Tag Allowed: Yes
Tag:                                ManuallyActivateTrigger
Tag Format: [ManuallyActivateTrigger:Value]
Description: This tag specifies if one or more Trigger Profiles should be manually triggered.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                ManuallyActivatedTriggerNames
Tag Format: [ManuallyActivatedTriggerNames:Value]
Description: This tag specifies a name of a Trigger Profile that should be Manually Triggered.
Allowed Values: Any text/string excluding :, [, ]
Multiple Tag Allowed: Yes
Tag:                                ForceManualTriggerActivation
Tag Format: [ForceManualTriggerActivation:Value]
Description: This tag specifies if manually activated triggers should be forcibly activated from the action, regardless of their conditions, cooldowns, etc.
Allowed Values: true
false
Multiple Tag Allowed: No

Variables

This section contains actions that change local or global variables that can be used by the behavior or spawner.

Tag:                                SetBooleansTrue
Tag Format: [SetBooleansTrue:Value]
Description: This tag specifies a name of a Boolean Variable that you want to set to true within the Behavior Profile. If a provided name does not exist in the Behavior Profile, it will be created and saved with the true value
Allowed Values: Any text/string excluding :, [, ]
Multiple Tag Allowed: Yes
Tag:                                SetBooleansFalse
Tag Format: [SetBooleansFalse:Value]
Description: This tag specifies a name of a Boolean Variable that you want to set to false within the Behavior Profile. If a provided name does not exist in the Behavior Profile, it will be created and saved with the false value
Allowed Values: Any text/string excluding :, [, ]
Multiple Tag Allowed: Yes
Tag:                                IncreaseCounters
Tag Format: [IncreaseCounters:Value]
Description: This tag specifies a name of an Integer Variable that you want to increase by 1 within the Behavior Profile. If a provided name does not exist in the Behavior Profile, it will be created and saved with a 1 value
Allowed Values: Any text/string excluding :, [, ]
Multiple Tag Allowed: Yes
Tag:                                DecreaseCounters
Tag Format: [DecreaseCounters:Value]
Description: This tag specifies a name of an Integer Variable that you want to decrease by 1 within the Behavior Profile. If a provided name does not exist in the Behavior Profile, it will be created and saved with a -1 value
Allowed Values: Any text/string excluding :, [, ]
Multiple Tag Allowed: Yes
Tag:                                SetCounters
Tag Format: [SetCounters:Value]
Description: This tag specifies a name of an Integer Variable that you want to set to a specific value within the behavior. If a provided name does not exist in the behavior, it will be created and saved with the provided value. Ensure you also provide the value you want to set the variable to using the SetCountersValues tag
Allowed Values: Any text/string excluding :, [, ]
Multiple Tag Allowed: Yes
Tag:                                SetCountersValues
Tag Format: [SetCountersValues:Value]
Description: This tag specifies the value of an Integer Variable within the behavior. Ensure you also provide the name of the variable you want to set the value of using the SetCounters tag.
Allowed Values: Any Integer Value
Multiple Tag Allowed: Yes
Tag:                                ResetCounters
Tag Format: [ResetCounters:Value]
Description: This tag specifies a name of an Integer Variable that you want to set to a value of 0 within the Behavior Profile. If a provided name does not exist in the Behavior Profile, it will be created and saved with a 0 value
Allowed Values: Any text/string excluding :, [, ]
Multiple Tag Allowed: Yes
Tag:                                SetSandboxBooleansTrue
Tag Format: [SetSandboxBooleansTrue:Value]
Description: This tag specifies a name of a Boolean Variable that you want to set to true within the Save File. If a provided name does not exist in the Save File, it will be created and saved with the true value
Allowed Values: Any text/string excluding :, [, ]
Multiple Tag Allowed: Yes
Tag:                                SetSandboxBooleansFalse
Tag Format: [SetSandboxBooleansFalse:Value]
Description: This tag specifies a name of a Boolean Variable that you want to set to false within the Save File. If a provided name does not exist in the Save File, it will be created and saved with the false value
Allowed Values: Any text/string excluding :, [, ]
Multiple Tag Allowed: Yes
Tag:                                IncreaseSandboxCounters
Tag Format: [IncreaseSandboxCounters:Value]
Description: This tag specifies a name of an Integer Variable that you want to increase by 1 within the Save File. If a provided name does not exist in the Save File, it will be created and saved with a 1 value
Allowed Values: Any text/string excluding :, [, ]
Multiple Tag Allowed: Yes
Tag:                                IncreaseSandboxCountersAmount
Tag Format: [IncreaseSandboxCountersAmount:Value]
Description: This tag specifies the amount that all sandbox counters will be increased by if also using IncreaseSandboxCounters tags.
Allowed Values: Any Integer
Multiple Tag Allowed: No
Tag:                                DecreaseSandboxCounters
Tag Format: [DecreaseSandboxCounters:Value]
Description: This tag specifies a name of an Integer Variable that you want to decrease by 1 within the Save File. If a provided name does not exist in the Save File, it will be created and saved with a -1 value
Allowed Values: Any text/string excluding :, [, ]
Multiple Tag Allowed: Yes
Tag:                                DecreaseSandboxCountersAmount
Tag Format: [DecreaseSandboxCountersAmount:Value]
Description: This tag specifies the amount that all sandbox counters will be decreased by if also using DecreaseSandboxCounters tags.
Allowed Values: Any Integer
Multiple Tag Allowed: No
Tag:                                SetSandboxCounters
Tag Format: [SetSandboxCounters:Value]
Description: This tag specifies a name of an Integer Variable that you want to set to a specific value within the Save File. If a provided name does not exist in the Save File, it will be created and saved with the provided value. Ensure you also provide the value you want to set the variable to using the SetSandboxCounters tag
Allowed Values: Any text/string excluding :, [, ]
Multiple Tag Allowed: Yes
Tag:                                SetSandboxCountersValues
Tag Format: [SetSandboxCountersValues:Value]
Description: This tag specifies the value of an Integer Variable within the Save File. Ensure you also provide the name of the variable you want to set the value of using the SetSandboxCounters tag.
Allowed Values: Any Integer Value
Multiple Tag Allowed: Yes
Tag:                                ResetSandboxCounters
Tag Format: [ResetSandboxCounters:Value]
Description: This tag specifies a name of an Integer Variable that you want to set to a value of 0 within the Save File. If a provided name does not exist in the Save File, it will be created and saved with a 0 value
Allowed Values: Any text/string excluding :, [, ]
Multiple Tag Allowed: Yes
Tag:                                AddCustomDataToBlocks
Tag Format: [AddCustomDataToBlocks:Value]
Description: This tag specifies if one or more block should have their CustomData set to a specified value using a TextTemplate xml file.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                CustomDataBlockNames
Tag Format: [CustomDataBlockNames:Value]
Description: This tag specifies one or more Block Names of blocks that will have their CustomData changed if using the AddCustomDataToBlocks tag. This tag should be paired with the CustomDataFiles tag.
Allowed Values: Any text/string excluding :, [, ]
Multiple Tag Allowed: Yes
Tag:                                CustomDataFiles
Tag Format: [CustomDataFiles:Value]
Description: This tag specifies one or more TextTemplate files that will be used to set block custom data if using the AddCustomDataToBlocks tag. This tag should be paired with the CustomDataBlockNames tag.
Allowed Values: TextTemplate file name
eg: SomeTextTemplate.xml
Multiple Tag Allowed: Yes

Zone

This section contains actions that can change / manipulate Zones (formerly Territories) in the game world.

Tag:                                ChangeZoneAtPosition
Tag Format: [ChangeZoneAtPosition:Value]
Description: This tag specifies if a zone at the NPCs current position should be manipulated.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                ZoneName
Tag Format: [ZoneName:Value]
Description: This tag specifies the name of the specific zone that should be manipulated.
Allowed Values: Any Zone PublicName value
Multiple Tag Allowed: No
Tag:                                ZoneToggleActive
Tag Format: [ZoneToggleActive:Value]
Description: This tag specifies if the named zone in ZoneName should have its Active status changed. The NPC does not need to be inside the zone for this to be functional.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                ZoneToggleActiveMode
Tag Format: [ZoneToggleActive:Value]
Description: This tag specifies what the Active status of a zone should be set to if using ZoneToggleActive. The NPC does not need to be inside the zone for this to be functional.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                ZoneToggleActiveAtPosition
Tag Format: [ZoneToggleActiveAtPosition:Value]
Description: This tag specifies if the named zone in ZoneName should have its Active status changed. The NPC needs to be inside the zone for this to be functional.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                ZoneToggleActiveAtPositionMode
Tag Format: [ZoneToggleActiveAtPositionMode:Value]
Description: This tag specifies what the Active status of a zone should be set to if using ZoneToggleActiveAtPosition. The NPC needs to be inside the zone for this to be functional.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                ZoneRadiusChangeType
Tag Format: [ZoneRadiusChangeType:Value]
Description: This tag specifies if the zone that the NPC is inside (also matching ZoneName) should have its Radius changed. You can choose a modifier in this tag that will be used in combination with ZoneRadiusChangeType
Allowed Values: None
Set
Add
Subtract
Multiply
Divide
Multiple Tag Allowed: No
Tag:                                ZoneRadiusChangeAmount
Tag Format: [ZoneRadiusChangeAmount:Value]
Description: This tag specifies how much the zone radius will be changed if using the ZoneRadiusChangeType tag.
Allowed Values: Any Number
Multiple Tag Allowed: No
Tag:                                ZoneCustomCounterChange
Tag Format: [ZoneToggleActiveAtPositionMode:Value]
Description: This tag specifies if the Custom Counters of the zone (at NPC position and matching ZoneName) should be manipulated.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                ZoneCustomCounterChangeType
Tag Format: [ZoneCustomCounterChangeType:Value]
Description: This tag specifies how the value of a zone's Custom Counter will be changed.
Allowed Values: None
Set
Add
Subtract
Multiply
Divide
Multiple Tag Allowed: Yes
Tag:                                ZoneCustomCounterChangeName
Tag Format: [ZoneCustomCounterChangeName:Value]
Description: This tag specifies the name of the zone's Custom Counter that will be changed.
Allowed Values: Any Counter Name
Multiple Tag Allowed: Yes
Tag:                                ZoneCustomCounterChangeAmount
Tag Format: [ZoneCustomCounterChangeAmount:Value]
Description: This tag specifies the amount that the counter specified by ZoneCustomCounterChangeName will be changed.
Allowed Values: Any Integer
Multiple Tag Allowed: Yes
Tag:                                ZoneCustomBoolChange
Tag Format: [ZoneCustomBoolChange:Value]
Description: This tag specifies if the Custom Bools of the zone (at NPC position and matching ZoneName) should be manipulated.
Allowed Values: true
false
Multiple Tag Allowed: No
Tag:                                ZoneCustomBoolChangeName
Tag Format: [ZoneCustomBoolChangeName:Value]
Description: This tag specifies the name of the zone's Custom Bool that will be changed.
Allowed Values: Any Bool Name
Multiple Tag Allowed: Yes
Tag:                                ZoneCustomBoolChangeValue
Tag Format: [ZoneCustomBoolChangeValue:Value]
Description: This tag specifies the value that the bool specified by ZoneCustomBoolChangeName will be changed.
Allowed Values: true
false
Multiple Tag Allowed: Yes

Additional Tags

These tags add behaviors and effects that an Action profile can run when its linked Trigger conditions are satisfied.

Tag: ActivateAssertiveAntennas
Tag Format: [ActivateAssertiveAntennas:Value]
Description: When true, enables assertive antenna behavior on the NPC grid (antennas actively broadcast/track).
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: ActivateEvent
Tag Format: [ActivateEvent:Value]
Description: When true, activates MES events whose ids or tags match ActivateEventIds / ActivateEventTags.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: ActivateEventIds
Tag Format: [ActivateEventIds:Value]
Description: One or more activate event profile or id values (comma-separated).
Allowed Value(s): Comma-separated list of values
Multiple Tags Allowed: Yes
Tag: ActivateEventTags
Tag Format: [ActivateEventTags:Value]
Description: List of values for activate event tags.
Allowed Value(s): Comma-separated list of values
Multiple Tags Allowed: Yes
Tag: AddCustomCountersVariablesFromCommand
Tag Format: [AddCustomCountersVariablesFromCommand:Value]
Description: When true, enables or applies custom counters variables from command.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: AddCustomStringsFromCommand
Tag Format: [AddCustomStringsFromCommand:Value]
Description: When true, enables or applies custom strings from command.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: AddGPSPlayerConditionIds
Tag Format: [AddGPSPlayerConditionIds:Value]
Description: One or more add gps player condition profile or id values (comma-separated).
Allowed Value(s): Comma-separated list of values
Multiple Tags Allowed: Yes
Tag: AddGPSPlayerOverridePositionInPlayerCondition
Tag Format: [AddGPSPlayerOverridePositionInPlayerCondition:Value]
Description: When true, enables or applies gps player override position in player condition.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: AddGPSToPlayers
Tag Format: [AddGPSToPlayers:Value]
Description: When true, enables or applies gps to players.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: AddInstanceEventGroup
Tag Format: [AddInstanceEventGroup:Value]
Description: When true, enables or applies instance event group.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: AddResearchPoints
Tag Format: [AddResearchPoints:Value]
Description: When true, enables or applies research points.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: AddTagsToPlayers
Tag Format: [AddTagsToPlayers:Value]
Description: When true, enables or applies tags to players.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: AntennaHudText
Tag Format: [AntennaHudText:Value]
Description: Text value for antenna hud text.
Allowed Value(s): Any String Value
Multiple Tags Allowed: No
Tag: AntennaHudTextSuffix
Tag Format: [AntennaHudTextSuffix:Value]
Description: Text value for antenna hud text suffix.
Allowed Value(s): Any String Value
Multiple Tags Allowed: No
Tag: AppendAntennaHudText
Tag Format: [AppendAntennaHudText:Value]
Description: When true, enables or applies antenna hud text.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: ApplyContractProfiles
Tag Format: [ApplyContractProfiles:Value]
Description: When true, enables or applies contract profiles.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: ApplyStoreProfiles
Tag Format: [ApplyStoreProfiles:Value]
Description: When true, enables or applies store profiles.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: BehaviorSpecificEventA
Tag Format: [BehaviorSpecificEventA:Value]
Description: When true, activates behavior specific event a.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: BlockNamesShareModeAll
Tag Format: [BlockNamesShareModeAll:Value]
Description: List of values for block names share mode all.
Allowed Value(s): Comma-separated list of values
Multiple Tags Allowed: Yes
Tag: BroadcastCurrentTarget
Tag Format: [BroadcastCurrentTarget:Value]
Description: When true, broadcasts current target.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: BroadcastDamagerTarget
Tag Format: [BroadcastDamagerTarget:Value]
Description: When true, broadcasts damager target.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: BroadcastGenericCommand
Tag Format: [BroadcastGenericCommand:Value]
Description: When true, broadcasts generic command.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: BroadcastSendCode
Tag Format: [BroadcastSendCode:Value]
Description: Text value for broadcast send code.
Allowed Value(s): Any String Value
Multiple Tags Allowed: No
Tag: ChangeAntennaHudText
Tag Format: [ChangeAntennaHudText:Value]
Description: When true, changes antenna hud text.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: ChangeAttackersFactionAccount
Tag Format: [ChangeAttackersFactionAccount:Value]
Description: When true, changes attackers faction account.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: ChangeAttackersFactionAccountByAmount
Tag Format: [ChangeAttackersFactionAccountByAmount:Value]
Description: Numeric amount for change attackers faction account by amount.
Allowed Value(s): Any Integer Value
Multiple Tags Allowed: No
Tag: ChangeAutopilotMinAltitude
Tag Format: [ChangeAutopilotMinAltitude:Value]
Description: When true, changes autopilot min altitude.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: ChangeBlockDamageMultipliers
Tag Format: [ChangeBlockDamageMultipliers:Value]
Description: When true, changes block damage multipliers.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: ChangeBlocksShareModeAll
Tag Format: [ChangeBlocksShareModeAll:Value]
Description: When true, changes blocks share mode all.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: ChangeGridOwnership
Tag Format: [ChangeGridOwnership:Value]
Description: When true, changes grid ownership.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: ChangeNpcFactionCredits
Tag Format: [ChangeNpcFactionCredits:Value]
Description: When true, changes npc faction credits.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: ChangeNpcFactionCreditsAmount
Tag Format: [ChangeNpcFactionCreditsAmount:Value]
Description: Numeric amount for change npc faction credits amount.
Allowed Value(s): Any Integer Value
Multiple Tags Allowed: No
Tag: ChangeNpcFactionCreditsTag
Tag Format: [ChangeNpcFactionCreditsTag:Value]
Description: Text value for change npc faction credits tag.
Allowed Value(s): Any String Value
Multiple Tags Allowed: No
Tag: ChangePlayerCredits
Tag Format: [ChangePlayerCredits:Value]
Description: When true, changes player credits.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: ChangePlayerCreditsAmount
Tag Format: [ChangePlayerCreditsAmount:Value]
Description: Numeric amount for change player credits amount.
Allowed Value(s): Any Integer Value
Multiple Tags Allowed: No
Tag: ChangePlayerCreditsIncludeSavedPlayerIdentity
Tag Format: [ChangePlayerCreditsIncludeSavedPlayerIdentity:Value]
Description: When true, changes player credits include saved player identity.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: ChangePlayerCreditsOverridePositionInPlayerCondition
Tag Format: [ChangePlayerCreditsOverridePositionInPlayerCondition:Value]
Description: When true, changes player credits override position in player condition.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: ChangePlayerCreditsPlayerConditionIds
Tag Format: [ChangePlayerCreditsPlayerConditionIds:Value]
Description: One or more change player credits player condition profile or id values (comma-separated).
Allowed Value(s): Comma-separated list of values
Multiple Tags Allowed: Yes
Tag: ChangeReputationBetweenFactions
Tag Format: [ChangeReputationBetweenFactions:Value]
Description: When true, changes reputation between factions.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: ChangeReputationFactionsAmounts
Tag Format: [ChangeReputationFactionsAmounts:Value]
Description: List of values for change reputation factions amounts.
Allowed Value(s): Any Integer Value
Multiple Tags Allowed: No
Tag: ChangeReputationFactionsFrom
Tag Format: [ChangeReputationFactionsFrom:Value]
Description: List of values for change reputation factions from.
Allowed Value(s): Comma-separated list of values
Multiple Tags Allowed: Yes
Tag: ChangeReputationFactionsTargets
Tag Format: [ChangeReputationFactionsTargets:Value]
Description: List of values for change reputation factions targets.
Allowed Value(s): Any Integer Value
Multiple Tags Allowed: No
Tag: ChangeReputationFactionsTo
Tag Format: [ChangeReputationFactionsTo:Value]
Description: List of values for change reputation factions to.
Allowed Value(s): Comma-separated list of values
Multiple Tags Allowed: Yes
Tag: ChangeReputationPropagatesToPlayers
Tag Format: [ChangeReputationPropagatesToPlayers:Value]
Description: When true, changes reputation propagates to players.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: ChangeTurretTargetingParameters
Tag Format: [ChangeTurretTargetingParameters:Value]
Description: OBSOLETE. Implement
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: ClearAntennaThoughtBubble
Tag Format: [ClearAntennaThoughtBubble:Value]
Description: When true, clears antenna thought bubble.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: ClearContractContentsFirst
Tag Format: [ClearContractContentsFirst:Value]
Description: When true, clears contract contents first.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: ClearStoreContentsFirst
Tag Format: [ClearStoreContentsFirst:Value]
Description: When true, clears store contents first.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: ContractBlockProfiles
Tag Format: [ContractBlockProfiles:Value]
Description: One or more contract block profile or id values (comma-separated).
Allowed Value(s): Comma-separated list of values
Multiple Tags Allowed: Yes
Tag: ContractBlocks
Tag Format: [ContractBlocks:Value]
Description: List of values for contract blocks.
Allowed Value(s): Comma-separated list of values
Multiple Tags Allowed: Yes
Tag: ContractProfiles
Tag Format: [ContractProfiles:Value]
Description: One or more contract profile or id values (comma-separated).
Allowed Value(s): Comma-separated list of values
Multiple Tags Allowed: Yes
Tag: CreateSafeZone
Tag Format: [CreateSafeZone:Value]
Description: When true, enables or applies safe zone.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: CustomCountersVariables
Tag Format: [CustomCountersVariables:Value]
Description: Configures custom counters variables.
Allowed Value(s): Comma-separated key,value pairs
Multiple Tags Allowed: Yes
Tag: CustomStrings
Tag Format: [CustomStrings:Value]
Description: Configures custom strings.
Allowed Value(s): Comma-separated key,value pairs
Multiple Tags Allowed: Yes
Tag: DamageMultiplierBlockNames
Tag Format: [DamageMultiplierBlockNames:Value]
Description: One or more damage multiplier block profile or id values (comma-separated).
Allowed Value(s): Comma-separated list of values
Multiple Tags Allowed: Yes
Tag: DamageMultiplierValues
Tag Format: [DamageMultiplierValues:Value]
Description: List of values for damage multiplier values.
Allowed Value(s): Any Integer Value
Multiple Tags Allowed: No
Tag: DebugMessage
Tag Format: [DebugMessage:Value]
Description: Debug Message.
Allowed Value(s): Any String Value
Multiple Tags Allowed: No
Tag: DecreaseAntennaThoughtBubblePercentage
Tag Format: [DecreaseAntennaThoughtBubblePercentage:Value]
Description: When true, enables or applies antenna thought bubble percentage.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: DecreaseAntennaThoughtBubblePercentageAmount
Tag Format: [DecreaseAntennaThoughtBubblePercentageAmount:Value]
Description: Numeric amount for decrease antenna thought bubble percentage amount.
Allowed Value(s): Any Integer Value
Multiple Tags Allowed: No
Tag: DecreaseCountersAmount
Tag Format: [DecreaseCountersAmount:Value]
Description: Numeric amount for decrease counters amount.
Allowed Value(s): Any Integer Value
Multiple Tags Allowed: No
Tag: DecreaseCountersAmountVariable
Tag Format: [DecreaseCountersAmountVariable:Value]
Description: Text value for decrease counters amount variable.
Allowed Value(s): Any String Value
Multiple Tags Allowed: No
Tag: DecreaseCountersUseAmountVariable
Tag Format: [DecreaseCountersUseAmountVariable:Value]
Description: When true, enables or applies counters use amount variable.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: DecreaseCountersUseCommandScore
Tag Format: [DecreaseCountersUseCommandScore:Value]
Description: When true, enables or applies counters use command score.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: DialogueCueId
Tag Format: [DialogueCueId:Value]
Description: A dialogue cue profile or id value.
Allowed Value(s): Any String Value
Multiple Tags Allowed: No
Tag: DisableAutopilot
Tag Format: [DisableAutopilot:Value]
Description: When true, disables autopilot.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: DisableTriggerIds
Tag Format: [DisableTriggerIds:Value]
Description: One or more disable trigger profile or id values (comma-separated).
Allowed Value(s): Comma-separated list of values
Multiple Tags Allowed: Yes
Tag: DisableTriggerTags
Tag Format: [DisableTriggerTags:Value]
Description: List of values for disable trigger tags.
Allowed Value(s): Comma-separated list of values
Multiple Tags Allowed: Yes
Tag: EnableAutopilot
Tag Format: [EnableAutopilot:Value]
Description: When true, enables autopilot.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: EnableTriggerIds
Tag Format: [EnableTriggerIds:Value]
Description: One or more enable trigger profile or id values (comma-separated).
Allowed Value(s): Comma-separated list of values
Multiple Tags Allowed: Yes
Tag: EnableTriggerTags
Tag Format: [EnableTriggerTags:Value]
Description: List of values for enable trigger tags.
Allowed Value(s): Comma-separated list of values
Multiple Tags Allowed: Yes
Tag: EndAntennaThoughtBubblePercentage
Tag Format: [EndAntennaThoughtBubblePercentage:Value]
Description: When true, enables or applies antenna thought bubble percentage.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: GPSColors
Tag Format: [GPSColors:Value]
Description: List of values for gps colors.
Allowed Value(s): Comma-separated Vector3D values eg: {X:0 Y:0 Z:0},{X:1 Y:1 Z:1}
Multiple Tags Allowed: Yes
Tag: GPSCoords
Tag Format: [GPSCoords:Value]
Description: List of values for gps coords.
Allowed Value(s): Comma-separated Vector3D values eg: {X:0 Y:0 Z:0},{X:1 Y:1 Z:1}
Multiple Tags Allowed: Yes
Tag: GPSDescriptions
Tag Format: [GPSDescriptions:Value]
Description: List of values for gps descriptions.
Allowed Value(s): Comma-separated list of values
Multiple Tags Allowed: Yes
Tag: GPSNames
Tag Format: [GPSNames:Value]
Description: One or more gps profile or id values (comma-separated).
Allowed Value(s): Comma-separated list of values
Multiple Tags Allowed: Yes
Tag: GPSVector3Ds
Tag Format: [GPSVector3Ds:Value]
Description: List of values for gps vector3 ds.
Allowed Value(s): Comma-separated Vector3D values eg: {X:0 Y:0 Z:0},{X:1 Y:1 Z:1}
Multiple Tags Allowed: Yes
Tag: HeavyYaw
Tag Format: [HeavyYaw:Value]
Description: When true, activates heavy yaw.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: HighlightBlockModes
Tag Format: [HighlightBlockModes:Value]
Description: When true, enables or applies block modes.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: HighlightBlockNames
Tag Format: [HighlightBlockNames:Value]
Description: One or more highlight block profile or id values (comma-separated).
Allowed Value(s): Comma-separated list of values
Multiple Tags Allowed: Yes
Tag: HighlightBlocks
Tag Format: [HighlightBlocks:Value]
Description: When true, enables or applies blocks.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: IgnoreOtherSafeZonesDuringCreation
Tag Format: [IgnoreOtherSafeZonesDuringCreation:Value]
Description: When true, enables or applies other safe zones during creation.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: IncreaseAntennaThoughtBubblePercentage
Tag Format: [IncreaseAntennaThoughtBubblePercentage:Value]
Description: When true, enables or applies antenna thought bubble percentage.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: IncreaseAntennaThoughtBubblePercentageAmount
Tag Format: [IncreaseAntennaThoughtBubblePercentageAmount:Value]
Description: Numeric amount for increase antenna thought bubble percentage amount.
Allowed Value(s): Any Integer Value
Multiple Tags Allowed: No
Tag: IncreaseCountersAmount
Tag Format: [IncreaseCountersAmount:Value]
Description: Numeric amount for increase counters amount.
Allowed Value(s): Any Integer Value
Multiple Tags Allowed: No
Tag: IncreaseCountersAmountVariable
Tag Format: [IncreaseCountersAmountVariable:Value]
Description: Text value for increase counters amount variable.
Allowed Value(s): Any String Value
Multiple Tags Allowed: No
Tag: IncreaseCountersUseAmountVariable
Tag Format: [IncreaseCountersUseAmountVariable:Value]
Description: When true, enables or applies counters use amount variable.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: IncreaseCountersUseCommandScore
Tag Format: [IncreaseCountersUseCommandScore:Value]
Description: When true, enables or applies counters use command score.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: InstanceEventGroupId
Tag Format: [InstanceEventGroupId:Value]
Description: A instance event group profile or id value.
Allowed Value(s): Any String Value
Multiple Tags Allowed: No
Tag: InstanceEventGroupReplaceKeys
Tag Format: [InstanceEventGroupReplaceKeys:Value]
Description: List of values for instance event group replace keys.
Allowed Value(s): Comma-separated list of values
Multiple Tags Allowed: Yes
Tag: InstanceEventGroupReplaceValues
Tag Format: [InstanceEventGroupReplaceValues:Value]
Description: List of values for instance event group replace values.
Allowed Value(s): Comma-separated list of values
Multiple Tags Allowed: Yes
Tag: KnownPlayerAreaMinThreatForAvoidingAbandonment
Tag Format: [KnownPlayerAreaMinThreatForAvoidingAbandonment:Value]
Description: Numeric value for known player area min threat for avoiding abandonment.
Allowed Value(s): Any Integer Value
Multiple Tags Allowed: No
Tag: LinkSafeZoneToRemoteControl
Tag Format: [LinkSafeZoneToRemoteControl:Value]
Description: When true, enables or applies safe zone to remote control.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: LocationSandboxVariableName
Tag Format: [LocationSandboxVariableName:Value]
Description: Text value for location sandbox variable name.
Allowed Value(s): Any String Value
Multiple Tags Allowed: No
Tag: ManuallyActivatedTriggerTags
Tag Format: [ManuallyActivatedTriggerTags:Value]
Description: List of values for manually activated trigger tags.
Allowed Value(s): Comma-separated list of values
Multiple Tags Allowed: Yes
Tag: MaxBlocksToRepair
Tag Format: [MaxBlocksToRepair:Value]
Description: Maximum value for blocks to repair.
Allowed Value(s): Any Integer Value
Multiple Tags Allowed: No
Tag: NewAutopilotMinAltitude
Tag Format: [NewAutopilotMinAltitude:Value]
Description: New value used for autopilot min altitude.
Allowed Value(s): Any Integer Value
Multiple Tags Allowed: No
Tag: NewBehavior
Tag Format: [NewBehavior:Value]
Description: OBSOLETE. Companion tag for deprecated SwitchToBehavior. Use NewBehaviorSubclass instead.
Allowed Value(s): Any String Value
Multiple Tags Allowed: No
Tag: NewTargetProfile
Tag Format: [NewTargetProfile:Value]
Description: OBSOLETE. Obsolete
Allowed Value(s): Any String Value
Multiple Tags Allowed: No
Tag: OldBlockSkins
Tag Format: [OldBlockSkins:Value]
Description: Previous value used for block skins.
Allowed Value(s): Comma-separated list of values
Multiple Tags Allowed: Yes
Tag: OverwriteAutopilotId
Tag Format: [OverwriteAutopilotId:Value]
Description: A overwrite autopilot profile or id value.
Allowed Value(s): Any String Value
Multiple Tags Allowed: No
Tag: OverwriteAutopilotMode
Tag Format: [OverwriteAutopilotMode:Value]
Description: Configures overwrite autopilot mode.
Allowed Value(s): Primary Secondary Tertiary
Multiple Tags Allowed: No
Tag: OverwriteAutopilotProfile
Tag Format: [OverwriteAutopilotProfile:Value]
Description: When true, enables or applies autopilot profile.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: ParentGridNameRequirement
Tag Format: [ParentGridNameRequirement:Value]
Description: Text value for parent grid name requirement.
Allowed Value(s): Any String Value
Multiple Tags Allowed: No
Tag: ParticleEffectColor
Tag Format: [ParticleEffectColor:Value]
Description: Vector3D coordinates for particle effect color.
Allowed Value(s): Vector3D coordinates eg: {X:0 Y:0 Z:0}
Multiple Tags Allowed: No
Tag: ParticleEffectId
Tag Format: [ParticleEffectId:Value]
Description: A particle effect profile or id value.
Allowed Value(s): Any String Value
Multiple Tags Allowed: No
Tag: ParticleEffectMaxTime
Tag Format: [ParticleEffectMaxTime:Value]
Description: Numeric value for particle effect max time.
Allowed Value(s): Any Number Value
Multiple Tags Allowed: No
Tag: ParticleEffectOffset
Tag Format: [ParticleEffectOffset:Value]
Description: Vector3D coordinates for particle effect offset.
Allowed Value(s): Vector3D coordinates eg: {X:0 Y:0 Z:0}
Multiple Tags Allowed: No
Tag: ParticleEffectScale
Tag Format: [ParticleEffectScale:Value]
Description: Numeric value for particle effect scale.
Allowed Value(s): Any Number Value
Multiple Tags Allowed: No
Tag: PlanetIgnoreSafeLocation
Tag Format: [PlanetIgnoreSafeLocation:Value]
Description: OBSOLETE. Implement //Doc.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: PlayDialogueCue
Tag Format: [PlayDialogueCue:Value]
Description: Playsound cue.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: PlayDialogueOverridePositionInPlayerCondition
Tag Format: [PlayDialogueOverridePositionInPlayerCondition:Value]
Description: When true, plays dialogue override position in player condition.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: PlayDialoguePlayerConditionIds
Tag Format: [PlayDialoguePlayerConditionIds:Value]
Description: One or more play dialogue player condition profile or id values (comma-separated).
Allowed Value(s): Comma-separated list of values
Multiple Tags Allowed: Yes
Tag: PlayDialogueToSpecificPlayers
Tag Format: [PlayDialogueToSpecificPlayers:Value]
Description: When true, plays dialogue to specific players.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: PlayParticleEffectAtRemote
Tag Format: [PlayParticleEffectAtRemote:Value]
Description: When true, plays particle effect at remote.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: PreserveSettingsOnBehaviorSwitch
Tag Format: [PreserveSettingsOnBehaviorSwitch:Value]
Description: OBSOLETE. Obsolete.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: PreserveTargetDataOnBehaviorSwitch
Tag Format: [PreserveTargetDataOnBehaviorSwitch:Value]
Description: OBSOLETE. Obsolete.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: PreserveTriggersOnBehaviorSwitch
Tag Format: [PreserveTriggersOnBehaviorSwitch:Value]
Description: OBSOLETE. Obsolete.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: ProcessStaticEncountersAtLocation
Tag Format: [ProcessStaticEncountersAtLocation:Value]
Description: When true, processes static encounters at location.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: ProcessStaticEncountersLocation
Tag Format: [ProcessStaticEncountersLocation:Value]
Description: Vector3D coordinates for process static encounters location.
Allowed Value(s): Vector3D coordinates eg: {X:0 Y:0 Z:0}
Multiple Tags Allowed: No
Tag: RemovePlayerIdentity
Tag Format: [RemovePlayerIdentity:Value]
Description: When true, enables or applies player identity.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: RepairBlocks
Tag Format: [RepairBlocks:Value]
Description: When true, repairs blocks.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: RepairBlocksIncludeSubgrids
Tag Format: [RepairBlocksIncludeSubgrids:Value]
Description: When true, repairs blocks include subgrids.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: ReputationPlayerConditionIds
Tag Format: [ReputationPlayerConditionIds:Value]
Description: One or more reputation player condition profile or id values (comma-separated).
Allowed Value(s): Comma-separated list of values
Multiple Tags Allowed: Yes
Tag: ResearchPointsAmount
Tag Format: [ResearchPointsAmount:Value]
Description: Numeric amount for research points amount.
Allowed Value(s): Any Integer Value
Multiple Tags Allowed: No
Tag: ResetCooldownTimeOfEvents
Tag Format: [ResetCooldownTimeOfEvents:Value]
Description: When true, resets cooldown time of events.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: ResetEventCooldownIds
Tag Format: [ResetEventCooldownIds:Value]
Description: One or more reset event cooldown profile or id values (comma-separated).
Allowed Value(s): Comma-separated list of values
Multiple Tags Allowed: Yes
Tag: ResetEventCooldownTags
Tag Format: [ResetEventCooldownTags:Value]
Description: List of values for reset event cooldown tags.
Allowed Value(s): Comma-separated list of values
Multiple Tags Allowed: Yes
Tag: ResetThisStaticEncounter
Tag Format: [ResetThisStaticEncounter:Value]
Description: When true, resets this static encounter.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: ResetTriggerCooldownTags
Tag Format: [ResetTriggerCooldownTags:Value]
Description: List of values for reset trigger cooldown tags.
Allowed Value(s): Comma-separated list of values
Multiple Tags Allowed: Yes
Tag: SafeZonePositionGridCenter
Tag Format: [SafeZonePositionGridCenter:Value]
Description: When true, activates safe zone position grid center.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: SafeZonePositionTerrainSurface
Tag Format: [SafeZonePositionTerrainSurface:Value]
Description: When true, activates safe zone position terrain surface.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: SafeZoneProfile
Tag Format: [SafeZoneProfile:Value]
Description: Text value for safe zone profile.
Allowed Value(s): Any String Value
Multiple Tags Allowed: No
Tag: SaveLocationToSandboxVariable
Tag Format: [SaveLocationToSandboxVariable:Value]
Description: When true, enables or applies location to sandbox variable.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: SavePlayerIdentity
Tag Format: [SavePlayerIdentity:Value]
Description: SaveSavePlayerIdentity.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: SendCommandWithoutAntenna
Tag Format: [SendCommandWithoutAntenna:Value]
Description: When true, activates send command without antenna.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: SendCommandWithoutAntennaRadius
Tag Format: [SendCommandWithoutAntennaRadius:Value]
Description: Radius in meters for send command without antenna.
Allowed Value(s): Any Number Value
Multiple Tags Allowed: No
Tag: SetAntennaThoughtBubble
Tag Format: [SetAntennaThoughtBubble:Value]
Description: When true, sets antenna thought bubble.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: SetAntennaThoughtBubbleName
Tag Format: [SetAntennaThoughtBubbleName:Value]
Description: Text value for set antenna thought bubble name.
Allowed Value(s): Any String Value
Multiple Tags Allowed: No
Tag: SetCountersAmountVariable
Tag Format: [SetCountersAmountVariable:Value]
Description: Text value for set counters amount variable.
Allowed Value(s): Any String Value
Multiple Tags Allowed: No
Tag: SetCountersUseAmountVariable
Tag Format: [SetCountersUseAmountVariable:Value]
Description: When true, sets counters use amount variable.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: SetCustomCountersVariables
Tag Format: [SetCustomCountersVariables:Value]
Description: When true, sets custom counters variables.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: SetCustomStrings
Tag Format: [SetCustomStrings:Value]
Description: When true, sets custom strings.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: SetGridToDynamic
Tag Format: [SetGridToDynamic:Value]
Description: When true, sets grid to dynamic.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: SetGridToStatic
Tag Format: [SetGridToStatic:Value]
Description: When true, sets grid to static.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: StartAntennaThoughtBubblePercentage
Tag Format: [StartAntennaThoughtBubblePercentage:Value]
Description: When true, enables or applies antenna thought bubble percentage.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: StartAntennaThoughtBubblePercentageValue
Tag Format: [StartAntennaThoughtBubblePercentageValue:Value]
Description: Numeric value for start antenna thought bubble percentage value.
Allowed Value(s): Any Integer Value
Multiple Tags Allowed: No
Tag: StoreBlocks
Tag Format: [StoreBlocks:Value]
Description: List of values for store blocks.
Allowed Value(s): Comma-separated list of values
Multiple Tags Allowed: Yes
Tag: StoreProfiles
Tag Format: [StoreProfiles:Value]
Description: One or more store profile or id values (comma-separated).
Allowed Value(s): Comma-separated list of values
Multiple Tags Allowed: Yes
Tag: Strafe
Tag Format: [Strafe:Value]
Description: Strafe - Implement Post Release.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: SwitchTargetProfile
Tag Format: [SwitchTargetProfile:Value]
Description: OBSOLETE. Obsolete
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: SwitchTargetToDamager
Tag Format: [SwitchTargetToDamager:Value]
Description: When true, switches target to damager.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: SwitchToBehavior
Tag Format: [SwitchToBehavior:Value]
Description: OBSOLETE. Do not use. MES skips re-registering an already-registered Remote Control. Use [ChangeBehaviorSubclass:true] and [NewBehaviorSubclass:Value] instead.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: TeleportPlayerConditionIds
Tag Format: [TeleportPlayerConditionIds:Value]
Description: One or more teleport player condition profile or id values (comma-separated).
Allowed Value(s): Comma-separated list of values
Multiple Tags Allowed: Yes
Tag: TeleportPlayerCoords
Tag Format: [TeleportPlayerCoords:Value]
Description: Vector3D coordinates for teleport player coords.
Allowed Value(s): Vector3D coordinates eg: {X:0 Y:0 Z:0}
Multiple Tags Allowed: No
Tag: TeleportPlayerOverridePositionInPlayerCondition
Tag Format: [TeleportPlayerOverridePositionInPlayerCondition:Value]
Description: When true, teleports player override position in player condition.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: TeleportPlayers
Tag Format: [TeleportPlayers:Value]
Description: When true, teleports players.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: TeleportPlayersIncludeSavedPlayerIdentity
Tag Format: [TeleportPlayersIncludeSavedPlayerIdentity:Value]
Description: When true, teleports players include saved player identity.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: ToggleEventIdModes
Tag Format: [ToggleEventIdModes:Value]
Description: When true, activates toggle event id modes.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: ToggleEventIds
Tag Format: [ToggleEventIds:Value]
Description: One or more toggle event profile or id values (comma-separated).
Allowed Value(s): Comma-separated list of values
Multiple Tags Allowed: Yes
Tag: ToggleEventTagModes
Tag Format: [ToggleEventTagModes:Value]
Description: When true, activates toggle event tag modes.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: ToggleEventTags
Tag Format: [ToggleEventTags:Value]
Description: List of values for toggle event tags.
Allowed Value(s): Comma-separated list of values
Multiple Tags Allowed: Yes
Tag: ToggleEvents
Tag Format: [ToggleEvents:Value]
Description: When true, activates toggle events.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: TryToDespawnThisGridOnly
Tag Format: [TryToDespawnThisGridOnly:Value]
Description: When true, attempts to despawn this grid only.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: TurretSubtypesForTargetChange
Tag Format: [TurretSubtypesForTargetChange:Value]
Description: OBSOLETE. Implement
Allowed Value(s): Comma-separated list of values
Multiple Tags Allowed: Yes
Tag: TurretTargetType
Tag Format: [TurretTargetType:Value]
Description: OBSOLETE. Implement
Allowed Value(s): Any String Value
Multiple Tags Allowed: No
Tag: TurretTypesForTargetChanges
Tag Format: [TurretTypesForTargetChanges:Value]
Description: OBSOLETE. Implement
Allowed Value(s): Comma-separated list of values
Multiple Tags Allowed: Yes
Tag: UseGPSObjective
Tag Format: [UseGPSObjective:Value]
Description: When true, uses gps objective.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: UseRandomNameGenerator
Tag Format: [UseRandomNameGenerator:Value]
Description: When true, uses random name generator.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: ZoneCustomBoolChangeUseKPL
Tag Format: [ZoneCustomBoolChangeUseKPL:Value]
Description: When true, activates zone custom bool change use kpl.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: ZoneCustomCounterChange
Tag Format: [ZoneCustomCounterChange:Value]
Description: When true, activates zone custom counter change.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: ZoneCustomCounterChangeUseKPL
Tag Format: [ZoneCustomCounterChangeUseKPL:Value]
Description: When true, activates zone custom counter change use kpl.
Allowed Value(s): true false
Multiple Tags Allowed: No
Tag: ZoneToggleActiveMode
Tag Format: [ZoneToggleActiveMode:Value]
Description: When true, activates zone toggle active mode.
Allowed Value(s): true false
Multiple Tags Allowed: No