Portal Modifiers

Portal Modifiers are items that manipulate the behavior of portals in Abyss. Some modifiers are meant for players to use, and others are meant for administrators. A portal's modifiers are placed in the modifier frames, beneath the network and color frames.

Modifier Frames
Three Modifier Frames

Modifiers

Bed <sub>Bed</sub>

  • Default Permission: Operators

This modifier sets the spawn point of any players arriving at the portal to the location of the modifier's Utility Block. When the modifier is placed, if the Utility Block is not in a valid spawn location it attempts to find the closest spawn point directly above the Utility Block.

FlagDescription
silentIf this flag is present, no messages will be displayed to teleporting players.


Book <sub>Book and Quill</sub>

  • Default Permission: All

This modifier displays a message to players coming arriving at the portal. If the book is a Book and Quill or signed book with text, it will use that text. Otherwise, it will search the Utility Block for either a sign or an item frame with a Book and Quill with text.

To facilitate the use of color with signs, the & character will be used to start color sequences, allowing you to enter text such as: &cThis is red!

FlagDescription
no colorIf this flag is present, all color will be stripped from the text to be displayed.


Bottle 'o Enchanting <sub>Bottle o' Enchanting</sub>

  • Default Permission: Operators

This modifier allows you to place experience costs and limits on portals. Similarly to the /xp command, the values used with this modifier are treated as experience points by default, or as levels if the number is suffixed with an L.

FlagDescription
check onlyIf this flag is present, players will only be able to travel through the portal if they have enough experience, but the cost will not be withdrawn when they do travel.
arriveThe amount of experience or levels to charge any player arriving through the portal. They will be denied transportation if they do not have enough.
departThe amount of experience or levels to charge any player departing through the portal. They will be denied transportation if they do not have enough.
silentIf this flag is present, no messages will be displayed to teleporting players.


Button <sub>Stone Button Wooden Button</sub>

  • Default Permission: All

These modifiers will momentarily toggle a lever at the location of the modifier's Utility Block whenever an entity departs through the portal. Wooden Buttons will trigger for any entity, and Stone Buttons will only trigger for players. These make it easy to make redstone contraptions that work with portals.

FlagDescription
durationThe duration, in ticks, to toggle the lever for. By default, this is 20 ticks (one second). The shortest duration you can toggle a lever is for two ticks.


Compass <sub>Compass</sub>

  • Default Permission: Operators

This modifier sets the compass target of all players arriving at the portal to the location of the modifier's Utility Block.

FlagDescription
silentIf this flag is present, no messages will be displayed to teleporting players.


Dispenser <sub>Dispenser</sub>

  • Default Permission: All

This modifier will take items from a chest at the modifier's Utility Block location and dispense them to players, storage minecarts, hopper minecarts, and any other entities that have an inventory and are arriving at the portal. Because it's difficult to predict exactly where a leaving entity will be placed, the dispenser will interact with the player's or other entity's inventory directly.

This modifier, being a dispenser, has different behaviors depending on the item it is dispensing:

  • Flint and Steel will light the player or entity on fire.
  • Armor will be equipped on players, if they aren't wearing armor.
  • Other items will be dispensed normally.

Any items that do not fit in the player's or entity's inventory will be dropped into the world.

FlagDescription
full stackIf this flag is present, an entire stack of will be dispensed at once, rather than just a single item.
cloneIf this flag is present, items will not be removed from the chest when they are dispensed, effectively cloning them. Be careful with this.
never dropIf this flag is present, items will never be dropped if they do not fit in the entity's inventory.
equipThis flag changes the behavior of armor equipping onto players. Default: if empty

if empty: Equip the armor if that slot is empty, otherwise simply place it in the player's inventory.
only: Equip the armor if that slot is empty, or do nothing if it isn't.
force: Equip the armor even if the player already has equipment, shunting their old armor out into their inventory.
never: Never equip the armor and simply place it in their inventory.
selectThis flag changes how the dispenser decides what item(s) to dispense. Default: random

random: Select one random item from the chest.
first: Select the first item in the chest.
all: Select all items in the chest.


Emerald Block <sub>Block of Emerald</sub>

  • Default Permission: Operators
  • Required: Vault

This modifier allows portals to interact with economy mods, using the Vault plugin to support many of the different economy plugins.

FlagDescription
check onlyIf this flag is present, players will only be able to travel through the portal if they have enough currency, but the cost will not be withdrawn when they do travel.
arriveThe amount of currency to charge any player arriving through the portal. They will be denied transportation if they do not have enough.
departThe amount of currency to charge any player departing through the portal. They will be denied transportation if they do not have enough.
silentIf this flag is present, no messages will be displayed to teleporting players.


Ender Pearl <sub>Ender Pearl</sub>

  • Default Permission: All

This modifier increases the portal's range multiplier by one, making it easier to connect to far off portals without greatly increasing the portal's depth.

Note: This modifier, along with portal range mechanics in general, is probably going to be changed at some point.


Eye of Ender <sub>Eye of Ender</sub>

  • Default Permission: All

This modifier increases a portal's effective range. However, unlike the Ender Pearl, it does this by reducing the cost of crossing dimensional barriers.

Note: This modifier, along with portal range mechanics in general, is probably going to be changed at some point.


Obsidian <sub>Obsidian</sub>

  • Default Permission: All

This modifier prevents you from arriving through the portal, making a one-way portal.


Pressure Plate <sub>Stone Pressure Plate Wooden Pressure Plate</sub>

  • Default Permission: All

This modifier acts similarly to the Button modifiers. However, rather than activating when an entity leaves through the portal, it activates when an entity arrives through the portal. Wooden Pressure Plates activates for all entities, and Stone Pressure Plates only activate for players.

FlagDescription
durationThe duration, in ticks, to toggle the lever for. By default, this is 20 ticks (one second). The shortest duration you can toggle a lever is for two ticks.


Slime Ball <sub>Slime Ball</sub>

  • Default Permission: All

This modifier multiplies your velocity when you arrive through the portal, effectively increasing the portal's velocity multiplier by 1 for each slime ball. That value can be changed with the slime-ball-strength Abyss configuration option.

The final velocity of all teleported entities are still required to fall between minimum-velocity and maximum-velocity.


Soul Sand <sub>Soul Sand</sub>

  • Default Permission: All

This modifier prevents you from leaving through the portal, making a one-way portal.




Utility Block

Utility Block

So, just what is a Utility Block? A Utility Block is a location in the world that a portal modifier uses for stuff. By default, the Utility Block location is just on the opposite side of the portal's frame from the modifier frame. In the above picture, a chest is in the default position for a Dispenser's modifier block.

It's possible to move a utility block using the Utility command. The following command, as an example, will move the utility block for the first modifier of a portal named "test-portal" to the block at 10,20,30 in the world named "world": /abutility test-portal 0 @10,20,30,world

However, it's far, far easier to move a Utility Block using a Portal Wand. Create a Utility wand with /abwand utility and right-click on the modifier frame of the modifier that you wish to move the Utility Block of. Then, right click on the target block using that same wand. You will see a message about the utility block being moved, and a simple visual effect around the block as well.


Setting a Utility Block
Step 1. Right-click on the modifier frame using the Portal Wand [Utility].

Setting a Utility Block 2
Step 2. Right-click on the target block using the same Portal Wand [Utility].


Comments

Posts Quoted:
Reply
Clear All Quotes