Portals
Portals teleport a player that enters the specified region to an exact location, by a certain offset amount or to a random location inside a region.
The position and direction attributes of a portal are relative to the players location and where they are looking. Prefix these values with an at symbol @
to specify absolute values. Portals can be restricted to certain teams by defining their filter attribute.
Portals respond to any player move event, this allows almost instant teleportation as soon as the player matches the portals filter.
TIP:
Copy the yaw and pitch from the F3 screen in minecraft (the Facing: Direction (Axis) (Yaw/Pitch)
line).
Element | Description | Value/Children |
---|---|---|
Node containing the portals on this map. | ||
Sub-elements | ||
An individual portal node. | Portal Sub-elements |
Portal Attributes
Attribute | Description | Value | Default |
---|---|---|---|
,, | Offset the players position by the amount specified. | Number | |
PropertyRequiredRegion where this portals entrance is located. Cannot combine an entrance region with or properties. | Region | ||
PropertyDestination of the portal, teleports players to a random point inside the region. Cannot combine an exit region with or properties. | Randomize-able Region | ||
PropertyFilter portal player access. | Filter | ||
Play the portal sound | true/false | true | |
Protect the portal entrance and exit regions. | true/false | false | |
Creates a dual-linked portal that goes both ways. This can only be used when all coordinates and directions are relative. | true/false | false | |
Specify the direction the player is looking horizontally from -180° to 180°. South 0, East -90, North 180 and West 90. | Number | ||
Smoothly teleport players. | true/false | false | |
Specify the direction the player is looking vertically from -90° to 90°. -90 is straight up 90 is straight down. | Number |
Portal Sub-elements
Element | Description | Value/Children | |
---|---|---|---|
PropertyRequiredRegion where this portals entrance is located. | Regions | ||
PropertyDestination of the portal, teleports players to a random point inside the region. Region is automatically filtered against block place. | Randomize-able Regions | ||
PropertyFilter portal player access. | Filters | ||
PropertyApply forward transform on rising edge | Dynamic Filters | ||
PropertyApply reverse transform on rising edge | Dynamic Filters | ||
PropertyApply forward transform on rising edge and reverse transform on falling edge Cannot combine property with or properties. | Dynamic Filters | ||
PropertyFilter portal observer access. | Filters |
Examples
<portals>
<!-- Moves the player to exactly X:10 Y:8 Z:45, pitch & yaw remain unchanged -->
<portal x="@10" y="@8" z="@45">
<region><cuboid min="-56,33,-1" max="-55,35,2"/></region>
</portal>
<!-- Adds 12 to the players Z position, turning them to face east and 10° up -->
<portal z="12" pitch="@10" yaw="@-90">
<region><cuboid min="-56,33,-1" max="-55,35,2"/></region>
</portal>
<!-- Teleport the player from portal-entrance to a random point inside portal-exit -->
<portal region="portal-entrance">
<destination><region id="portal-exit"/></destination>
</portal>
<!-- Teleports players on the Red Team from score-box to red-spawn, facing west -->
<portal filter="only-red" yaw="@90" region="score-box" destination="red-spawn"/>
</portals>