Uses of Interface
org.sgrewritten.stargate.api.network.portal.Portal

Packages that use Portal

Package	Description
org.sgrewritten.stargate.api
org.sgrewritten.stargate.api.database
org.sgrewritten.stargate.api.event.portal
org.sgrewritten.stargate.api.event.portal.message
org.sgrewritten.stargate.api.manager
org.sgrewritten.stargate.api.network
org.sgrewritten.stargate.api.network.portal
org.sgrewritten.stargate.api.network.portal.behavior
org.sgrewritten.stargate.api.network.portal.formatting
org.sgrewritten.stargate.api.network.portal.formatting.data
org.sgrewritten.stargate.api.permission
org.sgrewritten.stargate.database
org.sgrewritten.stargate.economy
org.sgrewritten.stargate.exception
org.sgrewritten.stargate.manager
org.sgrewritten.stargate.network
org.sgrewritten.stargate.network.portal
org.sgrewritten.stargate.util
org.sgrewritten.stargate.util.portal

Uses of Portal in org.sgrewritten.stargate.api

Methods in org.sgrewritten.stargate.api with parameters of type Portal

Modifier and Type	Method	Description
boolean	BlockHandlerInterface.registerBlock(org.bukkit.Location blockLocation, @Nullable org.bukkit.OfflinePlayer player, Portal portal, Metadata metaData)	Called if a Stargate is created or a block is placed, and the result of getHandledMaterial matches with the detected location
void	BlockHandlerInterface.unRegisterBlock(org.bukkit.Location blockLocation, Portal portal)	Called if a Stargate is removed, and the add-on has registered this location

Uses of Portal in org.sgrewritten.stargate.api.database

Methods in org.sgrewritten.stargate.api.database with parameters of type Portal

Modifier and Type	Method	Description
void	StorageAPI.addFlag(Character flagChar, Portal portal, StorageType portalType)	Add a flag to a portal in the database
String	StorageAPI.getPortalMetaData(Portal portal, StorageType portalType)	Get misc data of a portal
String	StorageAPI.getPortalPositionMetaData(Portal portal, PortalPosition portalPosition, StorageType portalType)	Get misc data of a portal position
void	StorageAPI.removeFlag(Character flagChar, Portal portal, StorageType portalType)	Remove a flag to a portal in the database
void	StorageAPI.removePortalFromStorage(Portal portal)	Removes a portal and its associated data from storage
void	StorageAPI.setPortalMetaData(Portal portal, String data, StorageType portalType)	Set misc data of a portal

Uses of Portal in org.sgrewritten.stargate.api.event.portal

Methods in org.sgrewritten.stargate.api.event.portal that return Portal

Modifier and Type	Method	Description
@Nullable Portal	StargateOpenPortalEvent.getDestination()
Portal	StargateTeleportPortalEvent.getDestination()	Gets the destination portal
Portal	StargateListPortalEvent.getListedPortal()
Portal	StargatePortalEvent.getPortal()	Gets the portal involved in this stargate event

Methods in org.sgrewritten.stargate.api.event.portal with parameters of type Portal

Modifier and Type	Method	Description
void	StargateOpenPortalEvent.setDestination(Portal destination)

Constructors in org.sgrewritten.stargate.api.event.portal with parameters of type Portal

Modifier	Constructor	Description
protected	CancellableStargatePortalEvent(@NotNull Portal portal, boolean async)	Instantiates a new cancellable stargate event
	StargateAccessPortalEvent(org.bukkit.entity.Entity travellingEntity, Portal portal, boolean deny, String denyReason)	Instantiates a new stargate access event
	StargateActivatePortalEvent(@NotNull Portal portal, @NotNull org.bukkit.entity.Entity entity, @NotNull List<String> destinations, String destination)	Instantiates a new stargate activate event
	StargateClosePortalEvent(@NotNull Portal portal, boolean force)	Instantiates a new stargate closing event
	StargateCreatePortalEvent(@NotNull org.bukkit.OfflinePlayer player, @NotNull Portal portal, @NotNull String[] lines, boolean deny, String denyReason, double cost)	Instantiates a new stargate creation event
	StargateDeactivatePortalEvent(Portal portal)	Instantiates a new stargate deactivation event
	StargateDestroyPortalEvent(@NotNull Portal portal, BlockEventType cause)	Instantiates a new cancellable stargate event
	StargateListPortalEvent(@NotNull Portal portal, org.bukkit.entity.Entity entity, Portal listedPortal, boolean deny)	Instantiates a new stargate event
	StargateOpenPortalEvent(org.bukkit.entity.Player player, @NotNull Portal portal, @Nullable Portal destination, boolean cancelled, boolean force)	Instantiates a new stargate open event
	StargatePlayerDestroyPortalEvent(@NotNull Portal portal, @NotNull org.bukkit.entity.Player player, boolean deny, String denyReason, double cost)	Instantiates a new Stargate Destroy Event
	StargatePortalLoadEvent(@NotNull Portal portal)	Instantiates a new portal load event
	StargateSignDyeChangePortalEvent(@NotNull Portal portal, org.bukkit.DyeColor colorChange, org.bukkit.Location location, PortalPosition portalPosition)	Instantiates a new stargate event
	StargateTeleportPortalEvent(@NotNull org.bukkit.entity.Entity travellingEntity, @NotNull Portal portal, Portal destination, @NotNull org.bukkit.Location exit)	Instantiates a new stargate portal event

Uses of Portal in org.sgrewritten.stargate.api.event.portal.message

Constructors in org.sgrewritten.stargate.api.event.portal.message with parameters of type Portal

Modifier	Constructor	Description
	AsyncStargateSendMessagePortalEvent(Portal portal, org.bukkit.entity.Entity entity, MessageType type, StargateComponent message)	Instantiates a new stargate player event
protected	StargateSendMessagePortalEvent(Portal portal, org.bukkit.entity.Entity entity, MessageType type, StargateComponent message, boolean async)	Instantiates a new stargate player event
	SyncStargateSendMessagePortalEvent(Portal portal, org.bukkit.entity.Entity entity, MessageType type, StargateComponent message)	Instantiates a new stargate player event

Uses of Portal in org.sgrewritten.stargate.api.manager

Methods in org.sgrewritten.stargate.api.manager that return Portal

Modifier and Type	Method	Description
Portal	BungeeManager.pullFromQueue(String playerName)	Gets a portal from the BungeeCord teleportation queue

Uses of Portal in org.sgrewritten.stargate.api.network

Methods in org.sgrewritten.stargate.api.network that return Portal

Modifier and Type	Method	Description
Portal	Network.getPortal(String name)	Gets the portal with the given name

Methods in org.sgrewritten.stargate.api.network that return types with arguments of type Portal

Modifier and Type	Method	Description
Collection<Portal>	Network.getAllPortals()	Gets all portals belonging to this network

Methods in org.sgrewritten.stargate.api.network with parameters of type Portal

Modifier and Type	Method	Description
void	Network.addPortal(Portal portal)	Adds the given portal to this network
boolean	Network.canSeePortal(Portal portalToSee, Portal origin, org.bukkit.entity.Player player)	Whether the origin portal can list / choose the portal to see.
Set<String>	Network.getAvailablePortals(org.bukkit.entity.Player player, Portal requester)	Gets names of all portals available to the given player from the given portal
void	Network.removePortal(Portal portal)	Removes the given portal from this network
void	NetworkManager.rename(Portal portal, String newName)
void	RegistryAPI.unregisterPortal(Portal portal)	Removes the given portal from registry.

Uses of Portal in org.sgrewritten.stargate.api.network.portal

Subinterfaces of Portal in org.sgrewritten.stargate.api.network.portal

Modifier and Type	Interface	Description
interface	RealPortal	A real portal with a physical sign that is located on this server

Methods in org.sgrewritten.stargate.api.network.portal with parameters of type Portal

Modifier and Type	Method	Description
void	RealPortal.doTeleport(@NotNull org.bukkit.entity.Entity target, @Nullable Portal destination)	Teleports the given entity to given destination
void	RealPortal.open(@Nullable Portal destination, @Nullable org.bukkit.entity.Player actor)	Open this portal without any checks
void	Portal.overrideDestination(Portal destination)	Forces this portal to temporarily go to the given destination regardless of the normal destination(s)

Uses of Portal in org.sgrewritten.stargate.api.network.portal.behavior

Methods in org.sgrewritten.stargate.api.network.portal.behavior that return Portal

Modifier and Type	Method	Description
@Nullable Portal	FixedBehavior.getDestination()
@Nullable Portal	LegacyBungeeBehavior.getDestination()
Portal	NetworkedBehavior.getDestination()
@Nullable Portal	PortalBehavior.getDestination()
@Nullable Portal	RandomBehavior.getDestination()

Uses of Portal in org.sgrewritten.stargate.api.network.portal.formatting

Methods in org.sgrewritten.stargate.api.network.portal.formatting that return Portal

Modifier and Type	Method	Description
Portal	PortalLine.getPortal()

Constructors in org.sgrewritten.stargate.api.network.portal.formatting with parameters of type Portal

Modifier	Constructor	Description
	PortalLine(List<Holder<StargateComponent>> components, @Nullable Portal portal, SignLineType type)
	PortalLine(HighlightingStyle style, @Nullable Portal portal, net.md_5.bungee.api.ChatColor textColor, net.md_5.bungee.api.ChatColor pointerColor, SignLineType type)

Uses of Portal in org.sgrewritten.stargate.api.network.portal.formatting.data

Methods in org.sgrewritten.stargate.api.network.portal.formatting.data that return Portal

Modifier and Type	Method	Description
@Nullable Portal	PortalLineData.getPortal()

Constructors in org.sgrewritten.stargate.api.network.portal.formatting.data with parameters of type Portal

Modifier	Constructor	Description
	PortalLineData(@NotNull Portal portal, SignLineType portalType)

Uses of Portal in org.sgrewritten.stargate.api.permission

Methods in org.sgrewritten.stargate.api.permission with parameters of type Portal

Modifier and Type	Method	Description
boolean	PermissionManager.hasOpenPermissions(RealPortal entrance, Portal exit)	Check if entity has permission to open portal

Uses of Portal in org.sgrewritten.stargate.database

Methods in org.sgrewritten.stargate.database with parameters of type Portal

Modifier and Type	Method	Description
void	SQLDatabase.addFlag(Character flagChar, Portal portal, StorageType portalType)
PreparedStatement	SQLQueryGenerator.generateGetPortalPositionStatement(Connection connection, Portal portal, PortalPosition portalPosition, StorageType portalType)
PreparedStatement	SQLQueryGenerator.generateGetPortalStatement(Connection connection, Portal portal, StorageType portalType)	Generate statement to fetch the data on specified portal
PreparedStatement	SQLQueryGenerator.generateRemoveFlagsStatement(Connection connection, StorageType portalType, Portal portal)	Gets a prepared statement for removing the relation between a portal and its flags
PreparedStatement	SQLQueryGenerator.generateRemoveFlagStatement(Connection connection, StorageType portalType, Portal portal, Character flagChar)	Gets a prepared statement for removing the relation between a portal and its flag
PreparedStatement	SQLQueryGenerator.generateRemovePortalPositionsStatement(Connection connection, StorageType portalType, Portal portal)	Gets a prepared statement for removing a position
PreparedStatement	SQLQueryGenerator.generateRemovePortalPositionStatement(Connection connection, StorageType portalType, Portal portal, PortalPosition portalPosition)
PreparedStatement	SQLQueryGenerator.generateRemovePortalStatement(Connection connection, Portal portal, StorageType portalType)	Gets a prepared statement for removing a portal
PreparedStatement	SQLQueryGenerator.generateSetPortalMetaStatement(Connection connection, Portal portal, String meta, StorageType portalType)
String	SQLDatabase.getPortalMetaData(Portal portal, StorageType portalType)
String	SQLDatabase.getPortalPositionMetaData(Portal portal, PortalPosition portalPosition, StorageType portalType)
void	SQLDatabase.removeFlag(Character flagChar, Portal portal, StorageType portalType)
void	SQLDatabase.removePortalFromStorage(Portal portal)
void	SQLDatabase.setPortalMetaData(Portal portal, String data, StorageType portalType)

Uses of Portal in org.sgrewritten.stargate.economy

Methods in org.sgrewritten.stargate.economy with parameters of type Portal

Modifier and Type	Method	Description
boolean	EconomyManager.chargePlayer(org.bukkit.OfflinePlayer player, Portal origin, double amount)
boolean	StargateEconomyAPI.chargePlayer(org.bukkit.OfflinePlayer player, Portal origin, double amount)	Charges the given player for using the given portal
boolean	EconomyManager.refundPlayer(org.bukkit.OfflinePlayer player, Portal origin, double amount)
boolean	StargateEconomyAPI.refundPlayer(org.bukkit.OfflinePlayer player, Portal origin, double amount)	Refunds a player's payment for using a portal

Uses of Portal in org.sgrewritten.stargate.exception

Methods in org.sgrewritten.stargate.exception that return Portal

Modifier and Type	Method	Description
@Nullable Portal	LocalisedMessageException.getPortal()

Constructors in org.sgrewritten.stargate.exception with parameters of type Portal

Modifier	Constructor	Description
	LocalisedMessageException(String localizedMessage, @Nullable Portal portal, @Nullable MessageType messageType)

Uses of Portal in org.sgrewritten.stargate.manager

Methods in org.sgrewritten.stargate.manager that return Portal

Modifier and Type	Method	Description
Portal	StargateBungeeManager.pullFromQueue(String playerName)

Methods in org.sgrewritten.stargate.manager with parameters of type Portal

Modifier and Type	Method	Description
boolean	StargatePermissionManager.hasOpenPermissions(RealPortal entrance, Portal exit)
boolean	UnrestrictedPermissionManager.hasOpenPermissions(RealPortal entrance, Portal exit)

Uses of Portal in org.sgrewritten.stargate.network

Methods in org.sgrewritten.stargate.network that return Portal

Modifier and Type	Method	Description
Portal	StargateNetwork.getPortal(String name)

Methods in org.sgrewritten.stargate.network that return types with arguments of type Portal

Modifier and Type	Method	Description
Collection<Portal>	StargateNetwork.getAllPortals()

Methods in org.sgrewritten.stargate.network with parameters of type Portal

Modifier and Type	Method	Description
void	StargateNetwork.addPortal(Portal portal)
boolean	StargateNetwork.canSeePortal(Portal portalToSee, Portal origin, org.bukkit.entity.Player player)
Set<String>	StargateNetwork.getAvailablePortals(org.bukkit.entity.Player player, Portal requester)
void	StargateNetwork.removePortal(Portal portal)
void	StargateNetworkManager.rename(Portal portal, String newName)
void	StargateRegistry.unregisterPortal(Portal portal)

Uses of Portal in org.sgrewritten.stargate.network.portal

Classes in org.sgrewritten.stargate.network.portal that implement Portal

Modifier and Type	Class	Description
class	LegacyVirtualPortal	A virtual portal compatible with the legacy BungeeCord behavior
class	StargatePortal	An abstract implementation of a real portal
class	VirtualPortal	A virtual representation of a portal on a different server

Fields in org.sgrewritten.stargate.network.portal declared as Portal

Modifier and Type	Field	Description
protected Portal	StargatePortal.overriddenDestination

Methods in org.sgrewritten.stargate.network.portal with parameters of type Portal

Modifier and Type	Method	Description
void	StargatePortal.doTeleport(@NotNull org.bukkit.entity.Entity target, @Nullable Portal destination)
static GlobalPortalId	GlobalPortalId.getFromPortal(Portal portal)	Gets a global portal id from the given portal
void	StargatePortal.open(@Nullable Portal destination, @Nullable org.bukkit.entity.Player actor)
void	StargatePortal.overrideDestination(Portal destination)
void	VirtualPortal.overrideDestination(Portal destination)

Uses of Portal in org.sgrewritten.stargate.util

Methods in org.sgrewritten.stargate.util that return types with arguments of type Portal

Modifier and Type	Method	Description
static @NotNull List<Portal>	LegacyPortalStorageLoader.loadPortalsFromStorage(File dir, String defaultNetworkName, StargateAPI stargateAPI)	Loads legacy portals in .db files from the given folder

Methods in org.sgrewritten.stargate.util with parameters of type Portal

Modifier and Type	Method	Description
static String	BungeeHelper.generateJsonMessage(Portal portal, StargateProtocolRequestType requestType)
static String	BungeeHelper.generateLegacyTeleportMessage(String player, Portal portal)
static String	BungeeHelper.generateTeleportJsonMessage(String player, Portal portal)
static void	MessageUtils.sendMessageFromPortal(Portal portal, @Nullable org.bukkit.entity.Entity receiver, String message, MessageType type)	Send a message from this portal; triggers a StargateSendMessagePortalEvent
static boolean	EconomyHelper.shouldChargePlayer(org.bukkit.entity.Player player, Portal portal, BypassPermission bypassPermission)	Checks whether the given player should be charged for destroying a portal

Uses of Portal in org.sgrewritten.stargate.util.portal

Methods in org.sgrewritten.stargate.util.portal with parameters of type Portal

Modifier and Type	Method	Description
static boolean	PortalDestructionHelper.destroyPortalIfHasPermissionAndCanPay(org.bukkit.entity.Player player, Portal portal, Runnable destroyAction, LanguageManager languageManager, StargateEconomyAPI economyManager)	Destroys a portal if the entity has permission and can pay any fees
static List<String>	PortalPermissionHelper.getOpenPermissions(RealPortal entrance, Portal exit, org.bukkit.entity.Entity actor)	Generate open permissions