Regions

QLD Minecraft is made up of regions that control the ability of the player and their surroundings.

By default, if the player is not inside a region, then their region is null.

To find out which regions are currently being applied to you or a player, you can use the command:

/qm region list|player (<player_name>)

This will return a list of regions currently being applied, in order of highest to lowest priority. It will also display the abilities of the player.

Regions

To create a region, first you need the //wand tool, then select the 2 points of area to define as a region. If you want to extend the region into the sky, you can also use the //expand vert <size> command after selecting the 2 points.

Once you have an area selected, use the following command to define a new region:

/qm region create <region_id>

This will create a new region with a region_id that you specify. Whenever making changes to a region, you need to use the region_id to let the server know which region you are referring to.

To delete a region, use the command:

/qm region remove <region_id>

and to modify the cuboid of a region, use the command

/qm region update <region_id>

Region IDs must be unique. If you try to create a region that already exists, an error will be displayed

API

qm_region.create - creates a new region. Requires a region_id and a cuboid qm_region.delete - deletes a region. Requires a region_id qm_region.update - updates a region. Requires a region_id and a cuboid qmp_region.exists - returns true or false if a region exists. Requires region_id qmp_region.get - returns a list of regions in order of highest to lowest priority. Requires a location

- run qm_region.create def:<region_id>|<cuboid>
- run qm_region.delete def:<region_id>
- run qm_region.update def:<region_id>|<cuboid>
- <proc[qmp_region.exists].context[<region_id>]>
- <proc[qmp_region.get].context[<location>]>

Priority

Regions by default have a priority of 0 and in most cases, this setting does not need to be changed.

When you have regions inside a region, the settings of both regions are applied to the player. However when the settings of each region conflict, then the region with the higher priority will take effect. If both regions have the same priority, then either could be applied.

You can view a regions priority setting by the following command:

/qm region <region_id> priority

To change a regions priority, you can use the command:

/qm region <region_id> priority <priority>

API

qm_region.priority - sets a regions priority. Requires a region_id and a priority qmp_region.priority - returns a regions priority. Requires a region_id

- run qm_region.priority def:<region_id>
- <proc[qmp_region.priority].context[<region_id>]>

Multiple Cuboids

There are times that a region cannot be defined solely as a large cuboid, but can be as multiple smaller cuboids. You can add and additional cuboids to a defined region by using the //wand tool, selecting a cuboid, and using the command:

/qm region <region_id> add cuboid

To list the current cuboids that are part of a region, use the command:

/qm region <region_id> list cuboid

and to remove a cuboid from a region:

/qm region <region_id> remove cuboid <cuboid_id>

API

qm_region.add.cuboid - adds a cuboid to a region. Requires a region_id and a cuboid qm_region.remove.cuboid - removes a cuboid to a region. Requires a region_id and a cuboid_id qmp_region.list.cuboids - returns a list of cuboids defined in the region. Requires a region_id

- run qm_region.add.cuboid def:<region_id>|<cuboid>
- run qm_region.remove.cuboid def:<region_id>|<cuboid_id>
- <proc[qmp_region.list.cuboids].context[<region_id>]>

Biomes

Biomes can be added to a region to further define its area. This can be helpful and most times quicker when trying to define 2 regions that are side-by-side, but are clearly different biomes.

When you add a biome to a region, a player will only be considered inside the region when they are both inside a defined cuboid and defined biome

To add a biome to a region, use the command:

/qm region <region_id> add biome <biome_id>

To list the current biomes defining a region, use the command:

/qm region <region_id> list biome

and finally to remove a biome from a region:

/qm region <region_id> remove biome <biome_id>

Flags

Regions support flags that affect the abilities of the player and the characteristics of the region. Flags can be set to a value or not set at all. If a flag is not set, then its default option is applied to the player when inside the region.

Flag

Values

Default

Description

break-block

true | false

true

Allows the player to break blocks

place-block

true | false

true

Allows the player to place blocks

gamemode

creative | survival

survival

Defines the gamemode of the player

announce

true | false

true

Announces entering/exiting the region to the player when the title is set

Region flags that are currently set can be viewed using the command:

/qm region <region_id> flag

To set a region flag, use the command:

/qm region <region_id> flag set <flag> <value>

and to remove a flag:

/qm region<region_id> flag remove <flag>

Title

QLD Minecraft can display prompts when a player enters or exits a region. This can be done when the region has a title set and the flag announce is set to true

Type

Region types help identify classes of regions inside scripts. Types can also have predetermined flags (saved in region.types.<type>)

  • town (block-break/place false, announce true, announce formatted id)

<proc[qmp_region.get.*] returns a single regions information
<proc[qmp_region.find.*] finds the value from a location

Language

API