Event-Action.md
These profile are what execute specified actions when the conditions in a Event 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 Event 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>TAG-EventAction-Example</SubtypeId>
</Id>
<Description>
[MES Event Action]
[UseChatBroadcast:true]
[ChatData:RAI-ExampleChatProfile]
[ChangeBooleans:true]
[SetBooleansTrue:SomeRandomBool]
</Description>
</EntityComponent>
</EntityComponents>
</Definitions>
Debug
SandboxVariables
Chat
Spawning
Zones
Players
Events
Debug
Tag:
DebugHudMessage
Tag Format:
[DebugHudMessage:Value]
Description:
nan
Allowed Values:
Any name string excluding :
, [
, ]
Multiple Tag Allowed:
no
# SandboxVariables
This Section
Tag:
ChangeBooleans
Tag Format:
[ChangeBooleans:Value]
Description:
nan
Allowed Values:
true
false
Multiple Tag Allowed:
no
Tag:
SetBooleansTrue
Tag Format:
[SetBooleansTrue:Value]
Description:
nan
Allowed Values:
Any name string excluding :
, [
, ]
Multiple Tag Allowed:
yes
Tag:
SetBooleansFalse
Tag Format:
[SetBooleansFalse:Value]
Description:
nan
Allowed Values:
Any name string excluding :
, [
, ]
Multiple Tag Allowed:
yes
Tag:
ChangeCounters
Tag Format:
[ChangeCounters:Value]
Description:
nan
Allowed Values:
true
false
Multiple Tag Allowed:
no
Tag:
IncreaseCounters
Tag Format:
[IncreaseCounters:Value]
Description:
nan
Allowed Values:
Any name string excluding :
, [
, ]
Multiple Tag Allowed:
yes
Tag:
DecreaseCounters
Tag Format:
[DecreaseCounters:Value]
Description:
nan
Allowed Values:
Any name string excluding :
, [
, ]
Multiple Tag Allowed:
yes
Tag:
IncreaseCountersAmount
Tag Format:
[IncreaseCountersAmount:Value]
Description:
nan
Allowed Values:
Any interger equal or greater than 0
Multiple Tag Allowed:
yes
Tag:
DecreaseCountersAmount
Tag Format:
[DecreaseCountersAmount:Value]
Description:
nan
Allowed Values:
Any interger equal or greater than 0
Multiple Tag Allowed:
yes
Tag:
SetCounters
Tag Format:
[SetCounters:Value]
Description:
nan
Allowed Values:
Any name string excluding :
, [
, ]
Multiple Tag Allowed:
yes
Tag:
SetCountersAmount
Tag Format:
[SetCountersAmount:Value]
Description:
nan
Allowed Values:
Any interger
Multiple Tag Allowed:
yes
# Chat
This Section
Tag:
UseChatBroadcast
Tag Format:
[UseChatBroadcast:Value]
Description:
nan
Allowed Values:
true
false
Multiple Tag Allowed:
no
Tag:
ChatData
Tag Format:
[ChatData:Value]
Description:
nan
Allowed Values:
Any behaviour Chat Profile SubtypeId
Multiple Tag Allowed:
yes
# Spawning
This Section
Tag:
SpawnVector3Ds
Tag Format:
[SpawnVector3Ds:Value]
Description:
nan
Allowed Values:
A Vector3D Value in the following format:{X:# Y:# Z:#}
Replace #
with values in meters.
Multiple Tag Allowed:
yes
Tag:
SpawnFactionTags
Tag Format:
[SpawnFactionTags:Value]
Description:
nan
Allowed Values:
Any name string excluding :
, [
, ]
Multiple Tag Allowed:
yes
Tag:
Spawner
Tag Format:
[Spawner:Value]
Description:
nan
Allowed Values:
Any behaviour Spawner Profile SubtypeId
Multiple Tag Allowed:
no
# Zones
This Section
Tag:
ChangeZoneAtPosition
Tag Format:
[ChangeZoneAtPosition:Value]
Description:
nan
Allowed Values:
true
false
Multiple Tag Allowed:
yes
Tag:
SpawnEncounter
Tag Format:
[SpawnEncounter:Value]
Description:
nan
Allowed Values:
true
false
Multiple Tag Allowed:
no
Tag:
ZoneNames
Tag Format:
[ZoneNames:Value]
Description:
nan
Allowed Values:
Any name string excluding :
, [
, ]
Multiple Tag Allowed:
yes
Tag:
ZoneCoords
Tag Format:
[ZoneCoords:Value]
Description:
nan
Allowed Values:
A Vector3D Value in the following format:{X:# Y:# Z:#}
Replace #
with values in meters.
Multiple Tag Allowed:
yes
Tag:
ZoneToggleActiveModes
Tag Format:
[ZoneToggleActiveModes:Value]
Description:
true will activate it. false will set disable it
Allowed Values:
true
false
Multiple Tag Allowed:
yes
# Players
This Section
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:
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:
AddGPSToPlayers
Tag Format:
[AddGPSToPlayers:Value]
Description:
nan
Allowed Values:
true
false
Multiple Tag Allowed:
no
Tag:
RemoveGPSFromPlayers
Tag Format:
[RemoveGPSFromPlayers:Value]
Description:
nan
Allowed Values:
true
false
Multiple Tag Allowed:
no
Tag:
UseGPSObjective
Tag Format:
[UseGPSObjective:Value]
Description:
nan
Allowed Values:
true
false
Multiple Tag Allowed:
no
Tag:
GPSNames
Tag Format:
[GPSNames:Value]
Description:
nan
Allowed Values:
Any name string excluding :
, [
, ]
Multiple Tag Allowed:
yes
Tag:
GPSDescriptions
Tag Format:
[GPSDescriptions:Value]
Description:
nan
Allowed Values:
Any name string excluding :
, [
, ]
Multiple Tag Allowed:
yes
Tag:
GPSVector3Ds
Tag Format:
[GPSVector3Ds:Value]
Description:
nan
Allowed Values:
A Vector3D Value in the following format:{X:# Y:# Z:#}
Replace #
with values in meters.
Multiple Tag Allowed:
yes
Tag:
GPSColors
Tag Format:
[GPSColors:Value]
Description:
nan
Allowed Values:
A Vector3D Value in the following format:{X:# Y:# Z:#}
.
Multiple Tag Allowed:
yes
Tag:
FadeInPlayers
Tag Format:
[FadeInPlayers:Value]
Description:
nan
Allowed Values:
true
false
Multiple Tag Allowed:
no
Tag:
FadeInPlayerConditionIds
Tag Format:
[FadeInPlayerConditionIds:Value]
Description:
nan
Allowed Values:
Any name string excluding :
, [
, ]
Multiple Tag Allowed:
yes
Tag:
FadeOutPlayers
Tag Format:
[FadeOutPlayers:Value]
Description:
nan
Allowed Values:
true
false
Multiple Tag Allowed:
no
Tag:
FadeOutPlayerConditionIds
Tag Format:
[FadeOutPlayerConditionIds:Value]
Description:
nan
Allowed Values:
Any name string excluding :
, [
, ]
Multiple Tag Allowed:
yes
Tag:
TeleportPlayers
Tag Format:
[TeleportPlayers:Value]
Description:
nan
Allowed Values:
true
false
Multiple Tag Allowed:
no
Tag:
TeleportPlayerConditionIds
Tag Format:
[TeleportPlayerConditionIds:Value]
Description:
nan
Allowed Values:
Any name string excluding :
, [
, ]
Multiple Tag Allowed:
yes
Tag:
TeleportPlayerCoords
Tag Format:
[TeleportPlayerCoords:Value]
Description:
nan
Allowed Values:
A Vector3D Value in the following format:{X:# Y:# Z:#}
.
Multiple Tag Allowed:
no
Tag:
TeleportRadius
Tag Format:
[TeleportRadius:Value]
Description:
nan
Allowed Values:
Any interger
Multiple Tag Allowed:
nan
# Events
Jaa events!
Tag:
ToggleEvents
Tag Format:
[ToggleEvents:Value]
Description:
nan
Allowed Values:
true
false
Multiple Tag Allowed:
no
Tag:
ToggleEventIds
Tag Format:
[ToggleEventIds:Value]
Description:
nan
Allowed Values:
Any Event Profile SubtypeId
Multiple Tag Allowed:
yes
Tag:
ToggleEventIdModes
Tag Format:
[ToggleEventIdModes:Value]
Description:
true will activate it. false will set disable it
Allowed Values:
true
false
Multiple Tag Allowed:
yes
Tag:
ToggleEventTags
Tag Format:
[ToggleEventTags:Value]
Description:
nan
Allowed Values:
Any name string excluding :
, [
, ]
Multiple Tag Allowed:
yes
Tag:
ToggleEventTagModes
Tag Format:
[ToggleEventTagModes:Value]
Description:
true will activate it. false will set disable it
Allowed Values:
true
false
Multiple Tag Allowed:
yes
Tag:
ResetCooldownTimeOfEvents
Tag Format:
[ResetCooldownTimeOfEvents:Value]
Description:
nan
Allowed Values:
true
false
Multiple Tag Allowed:
no
Tag:
ResetEventCooldownIds
Tag Format:
[ResetEventCooldownIds:Value]
Description:
nan
Allowed Values:
Any Event Profile SubtypeId
Multiple Tag Allowed:
yes
Tag:
ResetEventCooldownTags
Tag Format:
[ResetEventCooldownTags:Value]
Description:
nan
Allowed Values:
Any name string excluding characters ": [ ]"
Multiple Tag Allowed:
yes
Custom Actions
This Secition ...
See Here
Documentation built with MkDocs using Windmill theme by Grist Labs.