A comprehensive guide on creating maps and game modes for Atlas.
<checks>
Checks are conditions that must pass in order for an action to happen in a match.
On their own, they do nothing.
<all>
This check will only pass if all of it's children checks pass.
<checks>
<all id="allofthis">
<carrying material="iron" amount="12" />
<holding material="iron sword" />
</all>
</checks>
Attribute | Description | Type |
id | The globally unique ID of this feature. This can be used to reference this feature from other parts of the XML. | Feature ID |
<allow>
This check will only pass if the child check passes.
<checks>
<allow id="ironsword3">
<holding material="iron sword" />
</allow>
</checks>
Attribute | Description | Type |
id | The globally unique ID of this feature. This can be used to reference this feature from other parts of the XML. | Feature ID |
<always>
This check will always pass.
<checks>
<!-- NOTE: The "always" ID is added by default and cannot be used -->
<always id="always-1" />
</checks>
Attribute | Description | Type |
id | The globally unique ID of this feature. This can be used to reference this feature from other parts of the XML. | Feature ID |
<any>
This check will pass if any of the child checks pass.
<checks>
<any id="why">
<carrying material="iron" amount="12" />
<holding material="iron sword" />
</any>
</checks>
Attribute | Description | Type |
id | The globally unique ID of this feature. This can be used to reference this feature from other parts of the XML. | Feature ID |
<attacker>
This check is a parent check that can be used to query any information about the attacker of a damage event.
<checks>
...
<attacker id="donthurtme">
<any>
<team>red</team>
<team>blue</team>
</any>
</attacker>
</checks>
Attribute | Description | Type |
id | The globally unique ID of this feature. This can be used to reference this feature from other parts of the XML. | Feature ID |
<carrying>
This check can be used to query information about what an entity has in their inventory.
<checks>
...
<carrying material="diamond" amount="3" id="diamond" />
</checks>
Attribute | Description | Type |
id | The globally unique ID of this feature. This can be used to reference this feature from other parts of the XML. | Feature ID |
<damage>
This check can be used to query information about the cause of a damage event.
<checks>
...
<damage id="falldam">fall</damage>
</checks>
Description | Type |
Damage cause to look for. | DamageCause Possible Values |
Attribute | Description | Type |
id | The globally unique ID of this feature. This can be used to reference this feature from other parts of the XML. | Feature ID |
<deny>
This check will only pass if the child check fails.
<checks>
<deny id="ironsword2">
<holding material="iron sword" />
</deny>
</checks>
Attribute | Description | Type |
id | The globally unique ID of this feature. This can be used to reference this feature from other parts of the XML. | Feature ID |
<elimination>
This check is used to check if elimination is currently enabled.
Specification | Changes |
1.0.4 | ADDED |
<checks>
<elimination id="eliminated" />
</checks>
Attribute | Description | Type |
id | The globally unique ID of this feature. This can be used to reference this feature from other parts of the XML. | Feature ID |
<entity>
This check can be used to query information about the type of entity involved in an event.
<checks>
...
<entity id="piggy">pig</entity>
</checks>
Description | Type |
The type of entity to check for. | EntityType Possible Values |
Attribute | Description | Type |
id | The globally unique ID of this feature. This can be used to reference this feature from other parts of the XML. | Feature ID |
<explosion>
This check is used to check if an entity is a explosive.
Specification | Changes |
1.0.4 | ADDED |
<checks>
...
<explosion id="boom" />
</checks>
Attribute | Description | Type |
id | The globally unique ID of this feature. This can be used to reference this feature from other parts of the XML. | Feature ID |
<flying>
This check is used to check if a player is flying.
<checks>
...
<flying id="fly" />
</checks>
Attribute | Description | Type |
state | True/False | |
id | The globally unique ID of this feature. This can be used to reference this feature from other parts of the XML. | Feature ID |
<holding>
This check is used to query information about what an entity is holding in hand.
<checks>
...
<holding id="stone" material="stone sword" />
</checks>
Attribute | Description | Type |
id | The globally unique ID of this feature. This can be used to reference this feature from other parts of the XML. | Feature ID |
<inside>
This check is used to check if a location is inside of a region.
<checks>
<inside id="insidethis">
<region>
<sphere origin="41, 15, 0" radius="5" />
</region>
</inside>
</checks>
Attribute | Description | Type |
id | The globally unique ID of this feature. This can be used to reference this feature from other parts of the XML. | Feature ID |
<item>
This check is used to query information about the type of an item.
<checks>
...
<item id="woodcheck" material="wood" damage="1" />
</checks>
Description | Type |
The material to check against. A material is defined in the syntax of matname:damage when matname is the name of the material and damage is the damage value of the material. A damage value is not required. | Singular Material Matcher |
Attribute | Description | Type |
id | The globally unique ID of this feature. This can be used to reference this feature from other parts of the XML. | Feature ID |
<kill-streak>
This check is used to query information about the amount of kills a player has gotten in a row.
<checks>
<kill-streak id="hey" scope="life">1-4</kill-streak>
</checks>
Attribute | Description | Type |
scope | Scope to use when checking streak. | Scopelife ,match |
id | The globally unique ID of this feature. This can be used to reference this feature from other parts of the XML. | Feature ID |
<kit>
REQUIREMENT:
This feature requires the Kits Module.This check is used to check which kit a player is using.
Specification | Changes |
1.0.1 | ADDED |
<checks>
...
<kit id="kitcheck">some-kit</kit>
</checks>
Description | Type |
The id of the kit for reference. | Kit ID |
Attribute | Description | Type |
id | The globally unique ID of this feature. This can be used to reference this feature from other parts of the XML. | Feature ID |
<material>
This check is used to query information about what type of material an item or block is.
<checks>
...
<material id="logfolder">log:1</material>
</checks>
Attribute | Description | Type |
id | The globally unique ID of this feature. This can be used to reference this feature from other parts of the XML. | Feature ID |
<never>
This check will never pass.
<checks>
<!-- NOTE: The "never" ID is added by default and cannot be used -->
<never id="never-1" />
</checks>
Attribute | Description | Type |
id | The globally unique ID of this feature. This can be used to reference this feature from other parts of the XML. | Feature ID |
<not>
This check will invert the result of the child check.
<checks>
<not id="ironsword">
<holding material="iron sword" />
</not>
</checks>
Attribute | Description | Type |
id | The globally unique ID of this feature. This can be used to reference this feature from other parts of the XML. | Feature ID |
<objective>
REQUIREMENT:
This feature requires the Objectives Module.This check is used to query information about the current state of an objective.
<checks>
<objective id="touch" state="touched">some-flag</objective>
<!-- STATES: Completed, Captured, Touched. -->
</checks>
Attribute | Description | Type |
team | The id of the team for reference. | Team ID |
state | The score to check for. | Check Typecompleted ,captured ,touched |
id | The globally unique ID of this feature. This can be used to reference this feature from other parts of the XML. | Feature ID |
<on-ground>
This check is used to check if a player is on ground.
<checks>
...
<on-ground id="walking" />
</checks>
Attribute | Description | Type |
state | True/False | |
id | The globally unique ID of this feature. This can be used to reference this feature from other parts of the XML. | Feature ID |
<participating>
This check is used to check if a player is currently participating in the match.
Specification | Changes |
1.0.4 | ADDED |
<checks>
<participating id="youplaying" />
</checks>
Attribute | Description | Type |
id | The globally unique ID of this feature. This can be used to reference this feature from other parts of the XML. | Feature ID |
<random>
This check will randomly return true based on chance.
<checks>
...
<!-- 10% chance of passing -->
<random id="chance">0.1</random>
</checks>
Attribute | Description | Type |
id | The globally unique ID of this feature. This can be used to reference this feature from other parts of the XML. | Feature ID |
<score>
REQUIREMENT:
This feature requires the Objectives Module.This check is used to check the current score of a team.
If no team is specified, the team will be determined contextually.
<checks>
...
<score compare="greater" team="blue">4</score>
</checks>
Description | Type |
The score to compare against. | Text |
Attribute | Description | Type | Default |
team | The id of the team for reference. | Team ID | |
compare | The comparator which is used to compare the supplied value and the score. | Number Comparatorequals - Check if numbers are exact match. ,less than - Check if the supplied value is less than the score. ,less than equal - Check if the supplied value is less than, or equal, to the score. ,greater than - Check if the supplied value is greater than the score. ,greater than equal - Check if the supplied value is greater than, or equal, to the score. | equals |
id | The globally unique ID of this feature. This can be used to reference this feature from other parts of the XML. | Feature ID |
<sneaking>
This check is used to check if a player is sneaking.
<checks>
...
<sneaking id="sneak" />
</checks>
Attribute | Description | Type |
state | True/False | |
id | The globally unique ID of this feature. This can be used to reference this feature from other parts of the XML. | Feature ID |
<sometimes>
This is a random check with a 50% value.
<checks>
...
<!-- NOTE: The "sometimes" ID is added by default and cannot be used -->
<sometimes id="sometimes-1" />
</checks>
Attribute | Description | Type |
id | The globally unique ID of this feature. This can be used to reference this feature from other parts of the XML. | Feature ID |
<spawn>
<spawn-reason>
This check is used to check the spawn reason of a spawn event.
<checks>
...
<spawn id="spawneggs">spawner egg</spawn>
</checks>
Description | Type |
Reason to check for. | SpawnReason Possible Values |
Attribute | Description | Type |
id | The globally unique ID of this feature. This can be used to reference this feature from other parts of the XML. | Feature ID |
<spectating>
This check is used to check if a player is currently spectating the match.
Specification | Changes |
1.0.4 | ADDED |
<checks>
...
<spectating id="spectator" />
</checks>
Attribute | Description | Type |
id | The globally unique ID of this feature. This can be used to reference this feature from other parts of the XML. | Feature ID |
<sprinting>
This check is used to check if a player is sprinting.
<checks>
...
<sprinting id="sprint" />
</checks>
Attribute | Description | Type |
state | True/False | |
id | The globally unique ID of this feature. This can be used to reference this feature from other parts of the XML. | Feature ID |
<state>
This check is used to check the current state of the match.
Default states are starting, playing, and cycling
<checks>
...
<state id="matchstate">playing</state>
</checks>
Description | Type |
The id of the state for reference. | State ID |
Attribute | Description | Type |
id | The globally unique ID of this feature. This can be used to reference this feature from other parts of the XML. | Feature ID |
<team>
This check is used to check what team a player is on.
<checks>
...
<team id="blueteam">blue</team>
</checks>
Description | Type |
The id of the team for reference. | Team ID |
Attribute | Description | Type |
id | The globally unique ID of this feature. This can be used to reference this feature from other parts of the XML. | Feature ID |
<time>
This check is used to check time that the match has been playing.
<checks>
...
<!-- Time equals 5 minutes, 0 seconds -->
<time id="5minute">5m</time>
</checks>
Description | Type |
The time to check against. | Number (Without Decimal) |
Attribute | Description | Type | Default |
compare | The comparator which is used to compare the supplied value and the playing time. | Number Comparatorequals - Check if numbers are exact match. ,less than - Check if the supplied value is less than the playing time. ,less than equal - Check if the supplied value is less than, or equal, to the playing time. ,greater than - Check if the supplied value is greater than the playing time. ,greater than equal - Check if the supplied value is greater than, or equal, to the playing time. | equals |
id | The globally unique ID of this feature. This can be used to reference this feature from other parts of the XML. | Feature ID |
<victim>
This check is a parent check that can be used to query any information about the victim of a damage event.
<checks>
...
<victim id="victims">
<any>
<team>green</team>
<team>yellow</team>
</any>
</victim>
</checks>
Attribute | Description | Type |
id | The globally unique ID of this feature. This can be used to reference this feature from other parts of the XML. | Feature ID |
<void>
This check is used to check if a location is above the void.
Specification | Changes |
1.0.4 | ADDED |
<checks>
...
<void min="0,0,0" max="1,1,1" id="VOID" />
</checks>
Attribute | Description | Type | Default |
min | The minimum y coordinate to check. | Number | 0 |
max | The maximum y coordinate to check. | Number | 5 |
id | The globally unique ID of this feature. This can be used to reference this feature from other parts of the XML. | Feature ID |
<wearing>
This check can be used to query information about what an entity is wearing.
<checks>
...
<wearing id="chestplate" material="iron chestplate" />
</checks>
Attribute | Description | Type |
id | The globally unique ID of this feature. This can be used to reference this feature from other parts of the XML. | Feature ID |
<weather>
This check can be used to query information about what an entity has in their inventory.
<checks>
...
<weather id="norain">clear</weather>
</checks>
Description | Type |
The type of weather to check for. | Weather Typedownfall ,clear |
Attribute | Description | Type |
id | The globally unique ID of this feature. This can be used to reference this feature from other parts of the XML. | Feature ID |