ChunkTicketManager (SpongeAPI 7.3.0 API)

```
public interface ChunkTicketManager
```
A manager of chunks. Chunks can be managed via tickets that may represent forced-chunk-loading, player-chunk-loading, entity-chunk-loading, etc.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`ChunkTicketManager.Callback` A callback for loading tickets during world load.
`static interface`	`ChunkTicketManager.EntityLoadingTicket` Represents a loading ticket which is attached to a specific entity.
`static interface`	`ChunkTicketManager.LoadingTicket` Represents a handle which allows you to force a set of chunks to remain loaded.
`static interface`	`ChunkTicketManager.OrderedCallback` A ordered callback for loading tickets during world load.
`static interface`	`ChunkTicketManager.PlayerEntityLoadingTicket` Represents a loading ticket which is attached to a player entity.
`static interface`	`ChunkTicketManager.PlayerLoadingTicket` Represents a loading ticket which is attached to a specific player.
`static interface`	`ChunkTicketManager.PlayerOrderedCallback` A player ordered callback for loading tickets during world load.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Optional<ChunkTicketManager.EntityLoadingTicket>`	`createEntityTicket(Object plugin, World world)` Attempts to create a new loading ticket for a plugin to load chunks in a world.
`Optional<ChunkTicketManager.PlayerEntityLoadingTicket>`	`createPlayerEntityTicket(Object plugin, World world, UUID player)` Attempts to create a new loading ticket for a plugin to load chunks in a world.
`Optional<ChunkTicketManager.PlayerLoadingTicket>`	`createPlayerTicket(Object plugin, World world, UUID player)` Attempts to create a new loading ticket for a plugin to load chunks in a world.
`Optional<ChunkTicketManager.LoadingTicket>`	`createTicket(Object plugin, World world)` Attempts to create a new loading ticket for a plugin to load chunks in a world.
`int`	`getAvailableTickets(Object plugin, World world)` Gets the amount of remaining tickets a plugin can have in the world before hitting the maximum.
`int`	`getAvailableTickets(UUID player)` Gets the amount of tickets remaining available for a player.
`ImmutableSetMultimap<com.flowpowered.math.vector.Vector3i,ChunkTicketManager.LoadingTicket>`	`getForcedChunks(World world)` Gets the set of currently force-loaded chunks in a world.
`int`	`getMaxTickets(Object plugin)` Gets the maximum allowed per-world tickets for a plugin.
`void`	`registerCallback(Object plugin, ChunkTicketManager.Callback callback)` Sets the callback for handling loading forced chunk tickets on world load.

- Method Detail
  - registerCallback
```
void registerCallback(Object plugin,
                      ChunkTicketManager.Callback callback)
```
    Sets the callback for handling loading forced chunk tickets on world load.
    Required for any plugin that wants to force-load chunks. Any plugin that does not have a registered callback will have all saved tickets dropped on world load.
    
    Parameters:
    
    plugin - Plugin that is registering a callback
    
    callback - The callback function object
  - createTicket
```
Optional<ChunkTicketManager.LoadingTicket> createTicket(Object plugin,
                                                        World world)
```
    Attempts to create a new loading ticket for a plugin to load chunks in a world.
    Plugins can be limited in the number of tickets they can create per world.
    
    Parameters:
    
    plugin - Plugin that wants to load chunks
    
    world - World that chunks will be loaded in
    
    Returns:
    
    The new LoadingTicket, or Optional.empty() if a ticket could not be created
  - createEntityTicket
```
Optional<ChunkTicketManager.EntityLoadingTicket> createEntityTicket(Object plugin,
                                                                    World world)
```
    Attempts to create a new loading ticket for a plugin to load chunks in a world.
    This version is to create tickets that are bound to the existence of an Entity. For instance, a ticket to load the chunks a minecart is travelling through.
    
    Plugins can be limited in the number of tickets they can create per world.
    
    Parameters:
    
    plugin - Plugin that wants to load chunks
    
    world - World that chunks will be loaded in
    
    Returns:
    
    The new LoadingTicket, or Optional.empty() if a ticket could not be created
  - createPlayerTicket
```
Optional<ChunkTicketManager.PlayerLoadingTicket> createPlayerTicket(Object plugin,
                                                                    World world,
                                                                    UUID player)
```
    Attempts to create a new loading ticket for a plugin to load chunks in a world. The returned ticket will be associated with the given player.
    .
    
    Parameters:
    
    plugin - Plugin that wants to load chunks
    
    world - World that chunks will be loaded in
    
    player - Player that chunks are being loaded for
    
    Returns:
    
    The new LoadingTicket, or Optional.empty() if a ticket could not be created
  - createPlayerEntityTicket
```
Optional<ChunkTicketManager.PlayerEntityLoadingTicket> createPlayerEntityTicket(Object plugin,
                                                                                World world,
                                                                                UUID player)
```
    Attempts to create a new loading ticket for a plugin to load chunks in a world. The returned ticket will be associated with the given player.
    This version is to create tickets that are bound to the existence of an Entity. For instance, a ticket to load the chunks a minecart is travelling through.
    
    Plugins can be limited in the number of tickets they can create per world.
    
    Parameters:
    
    plugin - Plugin that wants to load chunks
    
    world - World that chunks will be loaded in
    
    player - Player that chunks are being loaded for
    
    Returns:
    
    The new LoadingTicket, or Optional.empty() if a ticket could not be created
  - getMaxTickets
```
int getMaxTickets(Object plugin)
```
    Gets the maximum allowed per-world tickets for a plugin.
    
    Parameters:
    
    plugin - The plugin to get the maximum ticket count for
    
    Returns:
    
    The maximum number of tickets the plugin can have in any given world
  - getAvailableTickets
```
int getAvailableTickets(Object plugin,
                        World world)
```
    Gets the amount of remaining tickets a plugin can have in the world before hitting the maximum.
    
    Parameters:
    
    plugin - The plugin to get the remaining available ticket count for
    
    world - The world to get the remaining count in
    
    Returns:
    
    The remaining tickets the plugin has available in the world
  - getAvailableTickets
```
int getAvailableTickets(UUID player)
```
    Gets the amount of tickets remaining available for a player.
    
    Parameters:
    
    player - The player to get the number of remaining tickets for
    
    Returns:
    
    The remaining tickets the player has available
  - getForcedChunks
```
ImmutableSetMultimap<com.flowpowered.math.vector.Vector3i,ChunkTicketManager.LoadingTicket> getForcedChunks(World world)
```
    Gets the set of currently force-loaded chunks in a world.
    
    Parameters:
    
    world - The world to get force-loaded chunks from
    
    Returns:
    
    The set of all force-loaded chunk coordinates and the tickets that are loading those chunks

Interface ChunkTicketManager

Nested Class Summary

Method Summary

Method Detail

registerCallback

createTicket

createEntityTicket

createPlayerTicket

createPlayerEntityTicket

getMaxTickets

getAvailableTickets

getAvailableTickets

getForcedChunks