Constructor Detail

• SpawnSign

  public SpawnSign(com.bergerkiller.bukkit.common.BlockLocation location)

Method Detail

• load

  public void load(SignActionEvent signEvent)

  Loads spawn sign information by parsing the information stored on a spawn sign

  Parameters:

  signEvent - of the spawn sign to parse

• getLocation

  public com.bergerkiller.bukkit.common.BlockLocation getLocation()

  Gets the location of the spawn sign

  Returns:

  spawn sign location

• hasInterval

  public boolean hasInterval()

  Gets whether this spawn sign periodically spawns

  Returns:

  True if an interval was set

• getInterval

  public long getInterval()

  Gets the interval to spawn at, measured in milliseconds. A value of 0 indicates no interval is used.

  Returns:

  spawn interval

• getRemaining

  public long getRemaining(long currentTime)

  Gets the duration in milliseconds until this spawn sign should spawn next. Returns 0 when the spawn must occur right now. Returns MAX_VALUE when this spawn sign is inactive.

  Parameters:

  currentTime - from which to measure remaining time

  Returns:

  remaining time in milliseconds

• getNextSpawnTime

  public long getNextSpawnTime()

  Gets the timestamp ( currentTimeMillis() ) for when the next spawn occurs. Returns MAX_VALUE when this spawn sign is inactive.

  Returns:

  timestamp of next spawn

• isActive

  public boolean isActive()

  Checks whether this spawn sign is powered by redstone / active

  Returns:

  True if active

• getSpawnForce

  public double getSpawnForce()

  Gets the speed at which the train is launched after spawning

  Returns:

  spawn force

• getSpawnableGroup

  public SpawnableGroup getSpawnableGroup()

  Gets the spawnable group that is spawned by this spawn sign

  Returns:

  spawnable group

• resetSpawnTime

  public void resetSpawnTime()

  Resets the spawn timer, causing this sign to spawn when the interval elapses.

• nextSpawnTime

  public void nextSpawnTime()

  Resets the spawn timer right after an interval spawn was performed

• getWorld

  public org.bukkit.World getWorld()

  Gets the (cached) world information of the sign

  Returns:

  world

• loadChunksAsync

  public void loadChunksAsync(double percent)

  Queues additional chunks for loading asynchronously in preparation for a spawn

  Parameters:

  percent - of chunks that should be loaded

• loadChunksAsyncReset

  public void loadChunksAsyncReset()

  Called after the spawn sign goes back to a longer-term slumber

• isNearChunk

  public boolean isNearChunk(int x,
                             int z)

  Checks whether this spawn sign is nearby a particular chunk

  Parameters:

  x - - coordinate of the chunk to probe

  z - - coordinate of the chunk to probe

  Returns:

  True if nearby

• remove

  public void remove()

  Removes this spawn sign from the spawn sign manager

• spawn

  public void spawn()

  Attempts to spawn a train from this sign right this instant

• spawn

  public void spawn(SignActionEvent sign)

  Attempts to spawn a train from this sign, using the sign action information, right this instant

  Parameters:

  sign - event info

• toString

  public java.lang.String toString()

  Overrides:

  toString in class java.lang.Object

• write

  public void write(java.io.DataOutputStream stream)
             throws java.io.IOException

  Throws:

  java.io.IOException

• read

  public static SpawnSign read(java.io.DataInputStream stream)
                        throws java.io.IOException

  Throws:

  java.io.IOException

• getSpawnForce

  public static double getSpawnForce(SignActionEvent event)

• getSpawnTime

  public static long getSpawnTime(SignActionEvent event)

• isValid

  public static boolean isValid(SignActionEvent event)