McBorder Plugin Documentation

Region

Command /mb region-edit-mode can switch to region editing mode

Usage

In editing mode, simply input in the following format without adding / A region is composed of three or more points and can be configured directly in editing mode Region files are located in the region folder of the plugin configuration file

• add
  • Loads the current location into the last edited region node
• save
  • Saves the currently edited region as a configuration file. File name: region_id.yml
• exit
  • Exits editing mode
• tp <index>
  • Teleports to a specific node, you can use look to see all node numbers, tp number to teleport to that node
  • Note: it's a shift, teleport based on your own height, fly higher and then teleport, otherwise you might get stuck in a wall
• look
  • View the currently edited region
• region <id>
  • Switches the currently edited region to an existing one, if the specified id doesn't exist, it creates a new one. Remember to save after changes.
• id <id>
  • Sets the id of the currently edited region, affecting the file name
• display <display>
  • Sets the display name of the currently edited region
• weight <weight>
  • Sets the weight of the currently edited region. When regions overlap, the higher weight is considered the player's location
• world <world>
  • Sets the world of the currently edited region
• insert <index>
  • Inserts the current location as a node at a specific position
• flag <key> <value>
  • Adds a flag to the region
• set <index>
  • Set the current location into region's nodes
• remove <index>
  • Remove the node from region
• clear
  • Clear now region's nodes

Flags

• check-perm-move
  • Checks if the player has the specified permission within this node value. If not, it will prevent the player from moving within the region
• check-perm-join
  • Checks if the player has the specified permission within this node value. If not, it will prevent the player from moving into this region
• check-perm-tp-move
  • Similar to the above, but it prevents the player from teleporting within this region to another position in this region
• check-perm-tp-join
  • Similar to the above, prevents teleportation into this region
• deny-to
  • Prohibits movement from this region to other specified regions
  • Format: * indicates no movement to any other region, or specific names can be specified
  • Example: deny-to: "A,B,C,D" prohibits movement from this region to regions with IDs A, B, C, D
• deny-tp-to
  • Prohibits teleportation from this region to other regions, same format as deny-to
• deny-move-message
  • Message displayed when movement within the region is blocked
• deny-join-message
  • Message displayed when entry into this region is blocked
• deny-to-message
  • Message displayed when movement from this region to other regions is blocked
• deny-tp-join-message
  • Message displayed when teleportation into this region is blocked
• deny-tp-to-message
  • Message displayed when teleportation from this region to other regions is blocked

Variables

• %BorderInfo_BorderSize% | Current world border size
• %BorderInfo_BorderCenterX% | X-coordinate of the current world border center
• %BorderInfo_BorderCenterZ% | Z-coordinate of the current world border center
• %BorderInfo_BorderOutDamage% | Damage value beyond the current world border
• %McBorder_Biome% | Biome of the player's current location
• %BorderInfo_Region_In_RegionID% | Returns whether the player is within the specified region name (returns: true/false)
• %BorderInfo_Region_Name% | Returns the display name of the region where the player is currently located

Permissions

McBorder.commandName {.is-success}

Commands

• /McBorder(mb) help
  • View plugin help
• /McBorder(mb) setborder <world> <size> [time]
  • Set the size of the world border
• /McBorder(mb) setcenter <world> <x> <z>
  • Set the center point of the world border
• /McBorder(mb) setplayer <player> <size> [time]
  • Set the border size of the world the player is in and center it
• /McBorder(mb) setplayerworld <player> [size] [world] [time]
  • Set the border of the world the player is in, with more optional parameters
• /McBorder(mb) reborder <world>
  • Reset the border of the specified world
• /McBorder(mb) replayer <player>
  • Reset the border of the world the specified player is in
• /McBorder(mb) setwarning <world> <warningDistance> <warningTime> <bufferDistance> <damageAmount>
  • Set warning distance, warning time, buffer size, and damage amount beyond the border for a world
• /McBorder(mb) increase <world> <increaseValue>
  • Increase the size of the world border
• /McBorder(mb) reduce <world> <reduceValue>
  • Reduce the size of the world border
• /McBorder(mb) getcenter <world>
  • Get the center coordinates of the specified world
• /McBorder(mb) getsize <world>
  • Get the size of the specified world's border
• /McBorder(mb) rtp <player> <world>
  • Randomly teleport the specified player within the border of the specified world
• /McBorder(mb) reload
  • Reload the plugin
• /McBorder(mb) upsetting
  • Update borders via the configuration file
• /McBorder(mb) region-edit-mode
  • Enter region editing mode, keywords for region editing can be sent directly during this mode