Package org.sgrewritten.stargate.api.network.portal.flag

Interface PortalFlag

All Known Implementing Classes:
CustomFlag, StargateFlag
public interface PortalFlag

  • Field Details

    • RANDOM

      static final PortalFlag RANDOM
      A random stargate which teleports to a random destination in its network

    • INTERSERVER

      static final PortalFlag INTERSERVER
      An across-server stargate using the new and better protocol

    • ALWAYS_ON

      static final PortalFlag ALWAYS_ON
      A stargate which is always on and always open

    • BACKWARDS

      static final PortalFlag BACKWARDS
      A stargate where the exit is on the opposite side of the sign

    • HIDDEN

      static final PortalFlag HIDDEN
      A stargate which is hidden on the network for unprivileged users, except for the owner

    • PRIVATE

      static final PortalFlag PRIVATE
      A stargate which can only be used by the owner and unprivileged users

    • FORCE_SHOW

      static final PortalFlag FORCE_SHOW
      A stargate displaying all available destinations, regardless of whether they are available to the player

    • HIDE_NETWORK

      static final PortalFlag HIDE_NETWORK
      A stargate with its network name hidden

    • FREE

      static final PortalFlag FREE
      A free stargate, regardless of all set prices

    • LEGACY_INTERSERVER

      static final PortalFlag LEGACY_INTERSERVER
      An across-server stargate using the legacy BungeeCord protocol

    • SILENT

      static final PortalFlag SILENT
      A silent stargate which doesn't output a teleportation message

    • NO_SIGN

      static final PortalFlag NO_SIGN
      A stargate without a sign.

      This is used by an official module, no implementation in Stargate-Core has been done

    • NETWORKED

      static final PortalFlag NETWORKED
      A normal networked stargate

    • FIXED

      static final PortalFlag FIXED
      A fixed stargate with only one destination

    • IRON_DOOR

      static final PortalFlag IRON_DOOR
      A stargate whose opening can be entirely blocked by an iron door

    • PERSONAL_NETWORK

      static final PortalFlag PERSONAL_NETWORK
      A stargate part of a personal network

    • DEFAULT_NETWORK

      static final PortalFlag DEFAULT_NETWORK
      A stargate on the default network

    • CUSTOM_NETWORK

      static final PortalFlag CUSTOM_NETWORK
      A stargate custom network

    • TERMINAL_NETWORK

      static final PortalFlag TERMINAL_NETWORK
      A stargate on the terminal network NOT IMPLEMENTED AT THE MOMENT, temporary an internal flag (inaccessible)

  • Method Details

    • isBehaviorFlag

      boolean isBehaviorFlag()
      Returns:

      Whether this flag relates to how a portal selects destinations

    • isInternalFlag

      boolean isInternalFlag()
      Gets whether this flag is an internal flag

      User specifiable flags are flags like backwards or always on, which the user specifies upon creation. Internal flags are the flags that are implicitly set to some value based on the Stargate created.

      Returns:

      True if this flag is user specifiable

    • getCharacterRepresentation

      char getCharacterRepresentation()
      Gets the character representing this portal flag
      Returns:

      The character representing this portal flag

    • isCustom

      boolean isCustom()
      Returns:

      True if this flag is custom

    • parseFlags

      static Set<PortalFlag> parseFlags(String flagString)
      Parameters:
      flagString -

      The flag string to parse

      Returns:

      A mutable set of PortalFlags