org.spongepowered.api.world

Interface ChunkTicketManager.LoadingTicket

All Known Subinterfaces:

ChunkTicketManager.EntityLoadingTicket, ChunkTicketManager.PlayerEntityLoadingTicket, ChunkTicketManager.PlayerLoadingTicket

Enclosing interface:

ChunkTicketManager

public static interface ChunkTicketManager.LoadingTicket

Represents a handle which allows you to force a set of chunks to remain loaded.

Method Summary

Modifier and Type	Method and Description
void	forceChunk(com.flowpowered.math.vector.Vector3i chunk) Force-loads a chunk using this ticket.
ImmutableSet<com.flowpowered.math.vector.Vector3i>	getChunkList() Gets the set of chunks that are being force-loaded by this ticket.
DataContainer	getCompanionData() Gets the companion data stored in a DataContainer.
int	getMaxNumChunks() Gets the maximum limit on the number of concurrently loaded chunks this ticket can have.
int	getNumChunks() Gets the number of chunks this ticket can load at once.
String	getPlugin() Gets the ID of the plugin that this ticket belongs to.
World	getWorld() Gets the World passed when creating this ticket.
void	prioritizeChunk(com.flowpowered.math.vector.Vector3i chunk) Reorders a chunk to count as the 'newest' loaded chunk, making it the last chunk to be removed when adding more chunks for force-loading.
void	release() Releases this ticket, removing all associated chunks and freeing up the ticket slot for later use by a new ticket.
void	setCompanionData(DataContainer container) Sets the companion data for this loading ticket.
boolean	setNumChunks(int numChunks) Sets the number of chunks this ticket will load at once.
void	unforceChunk(com.flowpowered.math.vector.Vector3i chunk) Removes a chunk from the force-loaded set of this ticket.

Method Detail

setNumChunks

boolean setNumChunks(int numChunks)

Sets the number of chunks this ticket will load at once.

Parameters:

numChunks - The number of chunks this ticket can load at once

Returns:

True if successful, false if the number of chunks is above the maximum allowed for this ticket

getNumChunks

int getNumChunks()

Gets the number of chunks this ticket can load at once.

Returns:

The number of possible concurrently loaded chunks

getMaxNumChunks

int getMaxNumChunks()

Gets the maximum limit on the number of concurrently loaded chunks this ticket can have.

Returns:

The maximum allowed concurrently loaded chunks

getWorld

World getWorld()

Gets the World passed when creating this ticket.

Returns:

The World object given to this ticket upon its creation

getCompanionData

DataContainer getCompanionData()

Gets the companion data stored in a DataContainer. Note that the provided DataContainer is modifiable, but a copy of the internal container, and as such may need to be setCompanionData(DataContainer) before modifications can be handled.

The sort of data stored in the container is plugin/mod dependent and is based on the original creator of this ChunkTicketManager.LoadingTicket. As such, the structure and particular data stored in the container is not concrete or defined in any specific way.

Returns:

The companion data in the form of a data container

setCompanionData

void setCompanionData(DataContainer container)

Sets the companion data for this loading ticket.

The sort of data stored in the container is plugin/mod dependent and is based on the original creator of this ChunkTicketManager.LoadingTicket. As such, the structure and particular data stored in the container is not concrete or defined in any specific way.

Parameters:

container - The container containing the companion data

getPlugin

String getPlugin()

Gets the ID of the plugin that this ticket belongs to.

Returns:

The ID of the plugin that registered this ticket

getChunkList

ImmutableSet<com.flowpowered.math.vector.Vector3i> getChunkList()

Gets the set of chunks that are being force-loaded by this ticket.

Returns:

The set of force-loaded chunks

forceChunk

void forceChunk(com.flowpowered.math.vector.Vector3i chunk)

Force-loads a chunk using this ticket. If the configured concurrently loaded chunk limit is reached, the oldest loaded chunk will be removed.

This does not cause an immediate load of the chunk. Forced chunks will be loaded eventually, but may not be available for a few ticks. Forced chunk loading is equivalent to the loading caused by a player.

Parameters:

chunk - The chunk to force-load

unforceChunk

void unforceChunk(com.flowpowered.math.vector.Vector3i chunk)

Removes a chunk from the force-loaded set of this ticket.

Parameters:

chunk - The chunk to remove from force-loading

prioritizeChunk

void prioritizeChunk(com.flowpowered.math.vector.Vector3i chunk)

Reorders a chunk to count as the 'newest' loaded chunk, making it the last chunk to be removed when adding more chunks for force-loading.

Parameters:

chunk - The chunk to reorder

release

void release()

Releases this ticket, removing all associated chunks and freeing up the ticket slot for later use by a new ticket.

After this operation the ticket is invalid and cannot be used to force-load chunks.