Areas
Areas are predefined regions that you can run checks with. This allows you to remodel things based on their location, while we also get the benefit of optimizing it.
You can define areas under <namespace>/catharsis/areas/<id>.json
The definition follows the following scheme
An Area definition object
- type: One of the area definition types defined below
- Additional fields depending on the value of type, see the respective area type documentation for more details.
Supported Types
Simple (catharsis:simple)
The most simple type of area.
Root simple object
- type:
catharsis:simple box: One single bounding box
- An array with two positions
A position with int precision
- An array of three ints
- A string of coordinates parts formatted as
x:y:z - An object with the coordinate values
- x: The x part of the coordinate
- y: The y part of the coordinate
- z: The z part of the coordinate
- An array with 6 ints
- The coordinates in order
minX,minY,minZ,maxX,maxY,maxZ
- The coordinates in order
- An object with min and max
min: The min position
- An array of three ints
- A string of coordinates parts formatted as
x:y:z - An object with the coordinate values
- x: The x part of the coordinate
- y: The y part of the coordinate
- z: The z part of the coordinate
max: The max position
- An array of three ints
- A string of coordinates parts formatted as
x:y:z - An object with the coordinate values
- x: The x part of the coordinate
- y: The y part of the coordinate
- z: The z part of the coordinate
- An array with two positions
- islands (Optional) A list of skyblock islands
- Either the value of
modein/locrawor one of the enum values
- Either the value of
Multiple (catharsis:multiple)
Groups multiple boxes into one area.
Root multiple object
- type:
catharsis:multiple - boxes: A list of bounding boxes
A bounding box marking a region in 3d space
- An array with two positions
A position with int precision
- An array of three ints
- A string of coordinates parts formatted as
x:y:z - An object with the coordinate values
- x: The x part of the coordinate
- y: The y part of the coordinate
- z: The z part of the coordinate
- An array with 6 ints
- The coordinates in order
minX,minY,minZ,maxX,maxY,maxZ
- The coordinates in order
- An object with min and max
min: The min position
- An array of three ints
- A string of coordinates parts formatted as
x:y:z - An object with the coordinate values
- x: The x part of the coordinate
- y: The y part of the coordinate
- z: The z part of the coordinate
max: The max position
- An array of three ints
- A string of coordinates parts formatted as
x:y:z - An object with the coordinate values
- x: The x part of the coordinate
- y: The y part of the coordinate
- z: The z part of the coordinate
- An array with two positions
- islands: (Optional) A list of skyblock islands
- Either the value of
modein/locrawor one of the enum values
- Either the value of
- min_size: (Optional, at least 4) The lowest size a branch can reach in the tree, before falling over to a leaf.
Always (catharsis:always)
Always matches
Root always object
- type:
catharsis:always
On Island (catharsis:on_island)
Matches while on island
Root On Island object
- type:
catharsis:on_island - islands: (Optional) A list of skyblock islands
- Either the value of
modein/locrawor one of the enum values
- Either the value of
Per Island (catharsis:per_island)
Allows to change the definition based on the current island.
Root On Island object
- type:
catharsis:per_island - entries: A list of area definitions
- islands: A list of skyblock islands
- Either the value of
modein/locrawor one of the enum values
- Either the value of
- type: One of the area definition types
- Additional fields depending on the value of type, see the respective area type documentation for more details.
- islands: A list of skyblock islands