Event-Conditions.md

Event Condition Profiles allow you to define some extra conditions that must be met before a Event Profile can execute its Actions. It is important that you use a unique SubtypeId for each Condition Profile you create, otherwise they may not work correctly.

Here's an example of how a Event Condition Profile Definition is setup:

<EntityComponent xsi:type="MyObjectBuilder_InventoryComponentDefinition">
    <Id>
      <TypeId>Inventory</TypeId>
      <SubtypeId>TAG-EventCondition-Example/SubtypeId>
    </Id>
    <Description>

    [MES Event Condition]

    [CheckTrueBooleans:true]
    [TrueBooleans:SomeRandomBoolean]  

    [CheckThreatScore:true]
    [ThreatScoreAmount:600]
    [ThreatScoreDistance:5000]
    [ThreatScoreCoords:{X:-1129033.5 Y:126871.5 Z:1293873.5}]
    [ThreatScoreDistanceFromCoords:90000]
    [ThreatScoreType:PlayerLocation]
    [ThreatScoreGridConfiguration:Static]
        </Description>
</EntityComponent>

Basic

SandboxVariables

Player

TheatScore

Basic

Tag:	UseFailCondition
Tag Format:	`[UseFailCondition:Value]`
Description:	nan
Allowed Values:	`true` `false`
Multiple Tag Allowed:	no

Tag:	UseAnyPassingCondition
Tag Format:	`[UseAnyPassingCondition:Value]`
Description:	nan
Allowed Values:	`true` `false`
Multiple Tag Allowed:	no
# SandboxVariables

Tag:	CheckTrueBooleans
Tag Format:	`[CheckTrueBooleans:Value]`
Description:	nan
Allowed Values:	`true` `false`
Multiple Tag Allowed:	no

Tag:	TrueBooleans
Tag Format:	`[TrueBooleans:Value]`
Description:	nan
Allowed Values:	Any name string excluding `:`, `[`, `]`
Multiple Tag Allowed:	yes

Tag:	AllowAnyTrueBoolean
Tag Format:	`[AllowAnyTrueBoolean:Value]`
Description:	nan
Allowed Values:	`true` `false`
Multiple Tag Allowed:	no

Tag:	CheckFalseBooleans
Tag Format:	`[CheckFalseBooleans:Value]`
Description:	nan
Allowed Values:	`true` `false`
Multiple Tag Allowed:	no

Tag:	FalseBooleans
Tag Format:	`[FalseBooleans:Value]`
Description:	nan
Allowed Values:	Any name string excluding `:`, `[`, `]`
Multiple Tag Allowed:	yes

Tag:	AllowAnyFalseBoolean
Tag Format:	`[AllowAnyFalseBoolean:Value]`
Description:	nan
Allowed Values:	`true` `false`
Multiple Tag Allowed:	no

Tag:	CheckCustomCounters
Tag Format:	`[CheckCustomCounters:Value]`
Description:	nan
Allowed Values:	`true` `false`
Multiple Tag Allowed:	no

Tag:	CustomCounters
Tag Format:	`[CustomCounters:Value]`
Description:	nan
Allowed Values:	Any name string excluding `:`, `[`, `]`
Multiple Tag Allowed:	yes

Tag:	CustomCountersTargets
Tag Format:	`[CustomCountersTargets:Value]`
Description:	nan
Allowed Values:	Any interger
Multiple Tag Allowed:	yes

Tag:	CounterCompareTypes
Tag Format:	`[CounterCompareTypes:Value]`
Description:	nan
Allowed Values:	`GreaterOrEqual` `Greater` `Equal` `NotEqual` `Less` `LessOrEqual`
Multiple Tag Allowed:	yes
# Player

Tag:	CheckPlayerCondition
Tag Format:	`[CheckPlayerCondition :Value]`
Description:	nan
Allowed Values:	`true` `false`
Multiple Tag Allowed:	no

Tag:	PlayerConditionIds
Tag Format:	`[PlayerConditionIds:Value]`
Description:	nan
Allowed Values:	Any name string excluding `:`, `[`, `]`
Multiple Tag Allowed:	yes

Tag:	CheckPlayerNear
Tag Format:	`[CheckPlayerNear:Value]`
Description:	nan
Allowed Values:	`true` `false`
Multiple Tag Allowed:	no

Tag:	PlayerNearCoords
Tag Format:	`[PlayerNearCoords:Value]`
Description:	nan
Allowed Values:	A Vector3D Value in the following format: `{X:# Y:# Z:#}` Replace `#` with values in meters.
Multiple Tag Allowed:	no

Tag:	PlayerNearDistanceFromCoords
Tag Format:	`[PlayerNearDistanceFromCoords:Value]`
Description:	nan
Allowed Values:	Any interger equal or greater than 0
Multiple Tag Allowed:	no

Tag:	PlayerFilterIds
Tag Format:	`[PlayerFilterIds:Value]`
Description:	nan
Allowed Values:	Any PlayerFilter Profile SubtypeId
Multiple Tag Allowed:	no
# TheatScore

Tag:	CheckThreatScore
Tag Format:	`[CheckThreatScore:Value]`
Description:	nan
Allowed Values:	`true` `false`
Multiple Tag Allowed:	no

Tag:	ThreatScoreAmount
Tag Format:	`[ThreatScoreAmount:Value]`
Description:	nan
Allowed Values:	Any interger equal or greater than 0
Multiple Tag Allowed:	no

Tag:	ThreatScoreDistance
Tag Format:	`[ThreatScoreDistance:Value]`
Description:	nan
Allowed Values:	Any interger equal or greater than 0
Multiple Tag Allowed:	no

Tag:	ThreatScoreType
Tag Format:	`[ThreatScoreType:Value]`
Description:	nan
Allowed Values:	Player PlayerLocation Location
Multiple Tag Allowed:	no

Tag:	ThreatScoreCoords
Tag Format:	`[ThreatScoreCoords:Value]`
Description:	nan
Allowed Values:	A Vector3D Value in the following format: `{X:# Y:# Z:#}` Replace `#` with values in meters.
Multiple Tag Allowed:	no

Tag:	ThreatScoreDistanceFromCoords
Tag Format:	`[ThreatScoreDistanceFromCoords:Value]`
Description:	nan
Allowed Values:	Any interger equal or greater than 0
Multiple Tag Allowed:	no

Tag:	ThreatScoreGridConfiguration
Tag Format:	`[ThreatScoreGridConfiguration:Value]`
Description:	nan
Allowed Values:	`All` `Static` `Dynamic`
Multiple Tag Allowed:	no