CannonRTP/com.magmaguy.cannonrtp.services/ConfiguredCannonRTP

ConfiguredCannonRTP

Constructors

public void ConfiguredCannonRTP(String configId, String instanceId, CannonRTPConfigFields configFields, Location cannonLocation, String locationString)

Properties

cannonChunkX

public int cannonChunkX

cannonChunkZ

public int cannonChunkZ

cannonLocation

public Location cannonLocation

configFields

public final CannonRTPConfigFields configFields

configId

public final String configId

The configuration file's id (filename without .yml).

instanceId

public final String instanceId

Unique id for this specific in-world placement.

lastStatusDetail

public String lastStatusDetail

locationString

public final String locationString

The serialized location string that produced this instance.

queuedLocations

public final ArrayDeque<Location> queuedLocations

searchState

public CannonSearchState searchState

Functions

buildFailureSummary

public String buildFailureSummary()

canUse

public boolean canUse(Player player)

clearNotifyThrottle

public void clearNotifyThrottle(UUID playerId)

public void clearNotifyThrottle(Player player)

consumeQueuedLocation

public Location consumeQueuedLocation()

exhaustSearch

public void exhaustSearch()

getAccentVisualColor

public Color getAccentVisualColor()

getAttemptsRemaining

public int getAttemptsRemaining()

getCannonChunkX

public int getCannonChunkX()

getCannonChunkZ

public int getCannonChunkZ()

getCannonLocation

public Location getCannonLocation()

getCannonWorldName

public String getCannonWorldName()

getConfigFields

public CannonRTPConfigFields getConfigFields()

getConfigId

public String getConfigId()

The configuration file's id (filename without .yml).

getDisplayName

public String getDisplayName()

getEffectiveTargetWorldName

public String getEffectiveTargetWorldName()

The world this cannon actually teleports to: the configured target world, or this cannon's own world when no explicit target is set.

getInstanceId

public String getInstanceId()

Unique id for this specific in-world placement.

getLastStatusDetail

public String getLastStatusDetail()

getLocationString

public String getLocationString()

The serialized location string that produced this instance.

getPrimaryVisualColor

public Color getPrimaryVisualColor()

getQueuedLocations

public ArrayDeque<Location> getQueuedLocations()

getResolvedSearchCenter

public Location getResolvedSearchCenter()

getSearchState

public CannonSearchState getSearchState()

getStatusDisplay

public String getStatusDisplay()

getTargetWorld

public World getTargetWorld()

handleChunkLoad

public void handleChunkLoad()

hasActiveModel

public boolean hasActiveModel()

hasTimedOut

public boolean hasTimedOut()

invalidateModelCache

public void invalidateModelCache()

isActive

public boolean isActive()

A cannon participates in the manager tick loop only when it is enabled, valid, has a resolvable location, and its world and chunk are both loaded.

isCharged

public boolean isCharged()

isEnabled

public boolean isEnabled()

markSearchFailure

public void markSearchFailure(SearchFailureReason reason)

public void markSearchFailure(SearchFailureReason reason, String rejectionReason)

As markSearchFailure, additionally surfacing the rejecting plugin's reason in the admin-facing status detail when one was provided.

markSearchSuccess

public void markSearchSuccess(Location location)

markTargetWorldUnavailable

public void markTargetWorldUnavailable(String worldName)

needsMoreLocations

public boolean needsMoreLocations()

notifyCannonWorldUnloaded

public void notifyCannonWorldUnloaded()

notifyTargetWorldLoaded

public void notifyTargetWorldLoaded()

playFireAnimation

public void playFireAnimation()

purgeQueuedLocationsForWorld

public int purgeQueuedLocationsForWorld(String worldName)

Removes destinations backed by an unloading Bukkit world instance.

refreshLabel

public void refreshLabel()

refreshWorldReference

public void refreshWorldReference()

Re-parses locationString so the stored Location picks up the freshly loaded world.

remove

public void remove(RemovalReason reason)

Unified teardown for this instance.

removeVisuals

public void removeVisuals()

resetModelAfterFmmReload

public void resetModelAfterFmmReload()

FMM tears down every StaticEntity during an imported-content reload while consumer references remain non-null.

returnQueuedLocation

public void returnQueuedLocation(Location location)

Returns a queued location to the head of the deque.

setChunkLoaded

public void setChunkLoaded(boolean loaded)

shouldNotify

public boolean shouldNotify(Player player, long throttleMs)