Portal Types (Flags)

[A]lways-On

Note

This flag is incompatible with the C, O, and E flags (activation modifiers).

Always-on gates are always active; that is to say, they will always display their traversable material.
Activators (buttons or coral) will not automatically be placed for Always-On gates..

Generally, always-on gates are used in spawns and server-builds.
By default, they are available to users with the sg.preset.builder node.

[B]ackwards

Backwards gates are functionally backwards; when exiting at a backwards gate, users will teleport to the side opposite to the sign.

Generally, backwards gates are used in spawns and server-builds as a way to hide signs.
By default, they are available to users with the sg.preset.builder node.

[C]ountdown

Caution

This flag breaks part of the design philosophy, and is therefore part of the Stargate Mechanics Module!`

Important

This flag uses the following custom syntax:

C[0d0h0m0s] entered on a portal sign's flags line.
The contents of the brackets are the time until the gate closes, in days, hours, mins, and seconds.
For example, the following is a valid portal sign combining the F flag, the B flag, and the D flag:

Origin
Destination
Network
FD[8d32m]B

Note

This flag is incompatible with the A, O, and E flags (activation modifiers).

The C flag keeps a portal's iris open for a specified amount of time.

If a short period of time is specified, this effectively results in a longer portal cooldown.
If a long period of time is specified, this effectively results in a temporary A portal every time this is activated.

The D flag is most often used in towny settings, or for creating various events.

Self [D]estruct

Caution

This flag breaks part of the design philosophy, and is therefore part of the Stargate Mechanics Module!

Important

This flag uses the following custom syntax:

D[0d0h0m0s] entered on a portal sign's flags line.
The contents of the brackets are the time until destruction, in days, hours, mins, and seconds.
For example, the following is a valid portal sign combining the A flag, the B flag, and the D flag:

Origin
Destination
Network
AD[8h32s]B

This flag destroys the portal on which the flag was applied, after a set period of time.

Note that the gate is not physically destroyed, but rather, is deactivated.
Also, note that this action will occur regardless of chunk loading.

The D flag is most often used in PVP settings, or for creating various events.

[E]lectrified

Caution

This flag breaks part of the design philosophy, and is therefore part of the Stargate Mechanics Module!

Note

This flag is incompatible with the A, C, and O flags (activation modifiers).

Gates with this flag may be activated with Redstone current (instead of a button).
One pulse of current delivered to any block of the gate's frame will activate it; a second pulse will deactivate it.

Warning

Due to some limitations in the API, certain methods of delivering redstone current (block update power, zero tick signals, delivering through blocks, etc. are not currently supported). This will likely be revisited in the future.

[F]ree

Note

This flag is incompatible with the P flag.

By default, players using Free gates will not be charged the usageCost specified in the config.

Generally, free gates are used for server utilities.
By default, they are available to users with the sg.preset.moderator node.

[G]enerate

Caution

This flag breaks part of the design philosophy, and is therefore part of the Stargate Mechanics Module!

Important

This flag uses the following custom syntax:

The Destination represents a portal that does not already exist.
Activating this gate will construct a portal at location specified as follows:

G{argument1;argument2;argument3}

Valid G arguments are as follows:

• If no arguments are present (ex. G or G{}), the destination is randomly generated within the borders of the origin portal's world.
• {integer} Constrains the destination to a specified distance from the origin.
• {integer,integer} Constrains the destination to specified x,z coordinates.
• {world_name} Constrains the destination to a dimension.
• {r relation integer} Constrains the radius to a set distance from the origin.
  • For example, r<100 forces the destination to generate within 100 blocks of the origin.
  • For example, 50<r<150 forces the destination to generate at least 50 blocks away from, but within 150 blocks of, the origin.

If the destination line is empty (line 2)

• Activating the portal will generate a new destination, confined by any G arguments present.
• If there is already a portal at the chosen destination, it will be connected to (no new gate will generate).

Here are some examples of G syntax:

This generates an always open, backwards, portal that connects to a specified location in the world:

Origin
Destination
Network
ABG{28,53;world_name}

Every time this is activated, it will send the player randomly into a fresh location in the world, for free!:

Origin

Network
FG

Every time someone enters this portal, they will be sent at least 1000 blocks away, but not more than 20000 blocks away.

Origin

Network
AG{1000<r<20000}

Note

Portal generation behaviour is determined by portal generation settings in Stargate Mechanics' folder.

Note

This flag is incompatible with the J, R, and L flags (selection modifiers).

This flag allows the user to generate a new portal at a remote destination.
Various arguments are available to constrain that destination; one can set up a G gate that is narrowed to specific coords, that randomly teleports players somewhere, or anywhere inbetween!

G Gates are intended to provide a mechanic for quick travel across vast distances to specified destinations, or as a mechanic for users to leave spawn and enter a survival world.

[H]idden

Warning

This flag fulfils legacy behaviour and is quite niche.
As such, it has been moved from the core to the Stargate Mechanics Module!

Hidden gates do not appear on the sign interfaces of networked portals on their network.

Generally, the hidden flag is used on various networks to hide fixed gates or infrequently used portals.
By default, they are available to users with the sg.preset.gatemaker node.

[I]nterserver

Important

Stargate works with the Velocity proxy, but depends on the BungeeBark Plugin for now.
(To use Stargates across a Velocity proxy, BungeeBark must first be installed).

Note

This flag is incompatible with the U flag (scope modifiers).

A brand new feature in SG Rewritten, Interserver gates leverage a new protocol to extend normal gate behaviour across your network! i gates work on Waterfall and Bungee proxies, and require a remote relational database to function.

Simply make any portal as you normally would, only this time, include the i flag.
To connect to it, use normal syntax; just be cognizant that i portals will only be able to see other portals if they also have the i flag.

Generally, i portals are used to link server utilities across a network.
By default, they are available to users with the sg.preset.builder node.

[J]ump

🧩 Add-on ⛔ Not Yet Implemented

K

🟢 Unused

[L]ibrary

🧩 Add-on ⛔ Not Yet Implemented

M

🟢 Unused

[N]o Network

Warning

This flag fulfils legacy behaviour and is quite niche.
As such, it has been moved from the core to the Stargate Mechanics Module!

Note

This flag is incompatible with the U flag.

No-Network gates are normal gates, with normal networks -- the only difference is that the network is hidden on the sign.

n portals used rarely; sometimes in spawns, and sometimes in maze-like minigames.
By default, they are available to users with the sg.preset.builder node.

T[O]ggle

Note

This flag is incompatible with the A, C, and E flags (activation modifiers).

⛔ Not Yet Implemented

[P]rivate

Note

This flag is incompatible with the U and F flags.

Private gates are gates on your personal network that you, and only you, can see and use.
Other users will not be able to activate private gates; additionally, they will not be able to use them as their destination.

Generally, private gates are used on personal networks for private utilities (farms, bases, etc.).
By default, they are available to users with the sg.preset.gatemaker node.

[Q]uiet

Warning

This flag fulfils legacy behaviour and is quite niche.
As such, it has been moved from the core to the Stargate Mechanics Module!

By default, whenever a player interacts with a stargate, certain messages are sent to chat.
For example, "Gate Destroyed", "Gate Created", "Teleported", etc.

When gates have the Q flag, these messages are hidden; perfect for roleplay servers!
By default, Q gates are available to users with the sg.preset.builder node.

[R]andom

Note

This flag is incompatible with the J, G, and L flags (selection modifiers).

Random gates are similar to always-on gates, except for one key thing; they don't have a fixed (or selectable) destination.
When a user enters a random gate, the gate will choose a random gate on its network to teleport said user to.

Generally, random gates are used for RTP systems, build showcases, and minigames.
By default, they are available to users with the sg.preset.moderator node.

Force-[S]hown

Warning

This flag fulfils legacy behaviour and is quite niche.
As such, it has been moved from the core to the Stargate Mechanics Module!

Certain types of portals are inaccessible and/or hidden to normal users.
These include gates with the P flag and the H flag.

S gates forcefully show any such gates on their network; if a S gate is on a network with a P gate, normal users will be able to access that P gate through the S gate.

S gates are often used for certain types of server utilities.
By default, they are available to users with the sg.preset.moderator node.

[T]erminal

⛔ Not Yet Implemented

Legacy B[U]ngee

Caution

⚠️ Deprecated

Before the i protocol was developed, old versions of StarGate took a much simpler approach to interserver teleportation. The u flag is very antiquated, and uses a completely different sign format that is disparate to all other flags and gates in this plugin.

Important

Stargate works with the Velocity proxy, but depends on the BungeeBark Plugin for now.
(To use Stargates across a Velocity proxy, BungeeBark must first be installed).

Note

This flag is incompatible with the I flag (scope modifiers).
It is also incompatible with the N and P flags.

u portals can be made with the following sign formatting.
Note that they can not connect to any other stargate portal, with the sole exception being another u gate.

Portal Name
Destination Portal Name
Destination Server Name
FLAGS

u gates primarily exist for reverse compatibility reasons; legacy imports will keep existing bungee gates and transform them into this format. Apart from that, u gates are sometimes used for their simple protocol; they can be used without the need for a remote relational database.

By default, they are available to users with the sg.preset.builder node.

In[V]isible

Caution

This flag breaks part of the design philosophy, and is therefore part of the Stargate Mechanics Module!

This flag hides the portal's sign interface; it will simply appear as an air block.
Right clicking the block within the frame, where the block should be, will cause the sign (or an alternative interface, depending on configuration) to appear. It is also possible to control V gates using the dial command in the Stargate Interfaces Module.

This flag is usually used for aesthetic purposes (setting a stargate flush into a wall).
In effect, it is a more drastic (yet more effective) version of the core's B flag.

W

🟢 Unused

X

🟢 Unused

Y

🟢 Unused

Z

🟢 Unused