Uses of Class
com.olziedev.playerwarps.api.warp.Warp
Package
Description
All the generalized objects within the API.
All warp events that are triggered for menus.
All warp events that are triggered on an update.
All warp events that are triggered for warps.
All expansion based objects that expose methods for external plugins to hook into.
All player based objects that handles and manages data.
All warp based objects that handles and manages data.
-
Uses of Warp in com.olziedev.playerwarps.api
Modifier and TypeMethodDescriptionabstract Warp
PlayerWarpsAPI.getPlayerWarp
(String warpName, CommandSender sender) Retrieve the requested warp object.abstract Warp
PlayerWarpsAPI.getSponsorWarp
(String id, CommandSender sender) Retrieve the warp that is sponsoring the specified sponsor slot.abstract Warp
PlayerWarpsAPI.updateWarp
(long id) Updates the current warp with its new data, if the warp doesn't exist then a new warp object will be created and added to the cache automatically.Modifier and TypeMethodDescriptionPlayerWarpsAPI.getPlayerWarps
(boolean showLocked) PlayerWarpsAPI.getPlayerWarps
(boolean showLocked, CommandSender sender) Modifier and TypeMethodDescriptionabstract void
PlayerWarpsAPI.createPlayerWarp
(String name, WLocation location, WPlayer owner, WarpType type, CommandSender creator, Consumer<Warp> callback) Creates a player warp with the requested name.abstract void
PlayerWarpsAPI.createSafePlayerWarp
(String name, WLocation location, WPlayer owner, WarpType type, Player player, Consumer<Warp> callback) Creates a player warp with the requested name. -
Uses of Warp in com.olziedev.playerwarps.api.events.update
ModifierConstructorDescriptionWarpCategoryUpdateEvent
(List<WCategory> newCategory, Warp playerWarp) This event is triggered before a warps' category has been updated. -
Uses of Warp in com.olziedev.playerwarps.api.events.warp
Modifier and TypeMethodDescriptionPlayerWarpCreateEvent.getPlayerWarp()
PlayerWarpRemoveEvent.getPlayerWarp()
PlayerWarpRentEvent.getPlayerWarp()
PlayerWarpSponsorEvent.getPlayerWarp()
PlayerWarpTeleportEvent.getPlayerWarp()
ModifierConstructorDescriptionPlayerWarpCreateEvent
(Warp playerWarp, CommandSender creator) This event is triggered before a warp has been created.PlayerWarpRemoveEvent
(Warp playerWarp, CommandSender remover) This event is triggered before a warp has been removed.PlayerWarpRentEvent
(Warp playerWarp, WarpRentType rentType, double price) This event is triggered before a warp is required to rent.PlayerWarpSponsorEvent
(Warp playerWarp, String sponsorID, Player player, double price, ItemStack itemStack) This event is triggered before a warp has claimed a sponsored slot.PlayerWarpTeleportEvent
(Warp playerWarp, Player teleporter, PlayerWarpTeleportEvent.Cause cause) This event is triggered before a player teleports to a warp. -
Uses of Warp in com.olziedev.playerwarps.api.expansion
Modifier and TypeMethodDescriptionabstract void
Adds the marker to the map when either the map is a new install or a warp has been created.abstract void
WMapAddon.removeMarker
(Warp warp) Removes the marker from the map when the warp is removed.abstract void
WMapAddon.updateMarker
(Warp warp) Updates the marker when a warps' data has been changed. -
Uses of Warp in com.olziedev.playerwarps.api.player
Modifier and TypeMethodDescriptionabstract Warp
WPlayer.getPendingWarp()
abstract Warp
WGUIPlayer.getPlayerWarp()
abstract Warp
WPayer.getPlayerWarp()
Modifier and TypeMethodDescriptionWPlayer.getFavouriteWarps
(CommandSender sender) WPlayer.getPlayerWarps
(boolean showLocked, CommandSender sender) WPlayer.getVisitedWarps
(CommandSender sender) WPlayer.getWarps
(boolean showLocked) Modifier and TypeMethodDescriptionabstract void
WPlayer.setPendingWarp
(Warp playerWarp, Runnable expire) Modifies the pending warp that the player will teleport to on another server.abstract void
WGUIPlayer.setPlayerWarp
(Warp playerWarp) Modifies the cached warp in this object.Modifier and TypeMethodDescriptionabstract void
WPlayer.setFavouriteWarps
(List<Warp> favouriteWarps) Modifies the list of favourite warps for this player.abstract void
WPlayer.setVisitedWarps
(List<Warp> visitedWarps) Modifies the list of recently visited warps for this player. -
Uses of Warp in com.olziedev.playerwarps.api.warp
Modifier and TypeMethodDescriptionvoid
WarpRentType.sendMessage
(WPlayer warpPlayer, Warp warp, FileConfiguration configuration) Sends a message to a player about their rent status depending on the enum instance.