ForgeChunkManager.Ticket (Forge API)

java.lang.Object
-
- net.minecraftforge.common.ForgeChunkManager.Ticket
-

Enclosing class:: ForgeChunkManager

-
-

public static class ForgeChunkManager.Ticket
-extends java.lang.Object

- -

- - -
Field Summary
- - - - - - - - - - -
Fields
Modifier and Type Field and Description
World world
-

Fields
Modifier and Type	Field and Description
`World`	`world`

- -

- - -

Method Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Methods
Modifier and Type	Method and Description
`void`	`bindEntity(Entity entity)` - Bind the entity to the ticket for `ForgeChunkManager.Type.ENTITY` type tickets. -
`com.google.common.collect.ImmutableSet<ChunkCoordIntPair>`	`getChunkList()` - Gets a list of requested chunks for this ticket. -
`int`	`getChunkListDepth()` - Gets the current max depth for this ticket. -
`Entity`	`getEntity()` - Get the entity associated with this `ForgeChunkManager.Type.ENTITY` type ticket -
`int`	`getMaxChunkListDepth()` - Get the maximum chunk depth size -
`NBTTagCompound`	`getModData()` - Retrieve the `NBTTagCompound` that stores mod specific data for the chunk ticket. -
`java.lang.String`	`getModId()` - Get the associated mod id -
`java.lang.String`	`getPlayerName()` - Get the player associated with this ticket -
`ForgeChunkManager.Type`	`getType()` - Gets the ticket type -
`boolean`	`isPlayerTicket()` - Is this a player associated ticket rather than a mod associated ticket? -
`void`	`setChunkListDepth(int depth)` - The chunk list depth can be manipulated up to the maximal grant allowed for the mod. -

- - -
Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- -
- - - -
  Field Detail
  - - - -
  - -
    world
    -
```
public final World world
```
    -
  -
- -
- - - -
  Method Detail
  - - - -
  - -
    setChunkListDepth
    -
```
public void setChunkListDepth(int depth)
```
    -
    The chunk list depth can be manipulated up to the maximal grant allowed for the mod. This value is configurable. Once the maximum is reached, - the least recently forced chunk, by original registration time, is removed from the forced chunk list.
    -
    Parameters:
    depth - The new depth to set
    -
  - - - -
  - -
    getChunkListDepth
    -
```
public int getChunkListDepth()
```
    -
    Gets the current max depth for this ticket. - Should be the same as getMaxChunkListDepth() - unless setChunkListDepth has been called.
    -
    Returns:
    Current max depth
    -
  - - - -
  - -
    getMaxChunkListDepth
    -
```
public int getMaxChunkListDepth()
```
    -
    Get the maximum chunk depth size
    -
    Returns:
    The maximum chunk depth size
    -
  - - - -
  - -
    bindEntity
    -
```
public void bindEntity(Entity entity)
```
    -
    Bind the entity to the ticket for ForgeChunkManager.Type.ENTITY type tickets. Other types will throw a runtime exception.
    -
    Parameters:
    entity - The entity to bind
    -
  - - - -
  - -
    getModData
    -
```
public NBTTagCompound getModData()
```
    -
    Retrieve the NBTTagCompound that stores mod specific data for the chunk ticket. - Example data to store would be a TileEntity or Block location. This is persisted with the ticket and - provided to the ForgeChunkManager.LoadingCallback for the mod. It is recommended to use this to recover - useful state information for the forced chunks.
    -
    Returns:
    The custom compound tag for mods to store additional chunkloading data
    -
  - - - -
  - -
    getEntity
    -
```
public Entity getEntity()
```
    -
    Get the entity associated with this ForgeChunkManager.Type.ENTITY type ticket
    -
    Returns:
    the entity
    -
  - - - -
  - -
    isPlayerTicket
    -
```
public boolean isPlayerTicket()
```
    -
    Is this a player associated ticket rather than a mod associated ticket?
    -
  - - - -
  - -
    getPlayerName
    -
```
public java.lang.String getPlayerName()
```
    -
    Get the player associated with this ticket
    -
  - - - -
  - -
    getModId
    -
```
public java.lang.String getModId()
```
    -
    Get the associated mod id
    -
  - - - -
  - -
    getType
    -
```
public ForgeChunkManager.Type getType()
```
    -
    Gets the ticket type
    -
  - - - -
  - -
    getChunkList
    -
```
public com.google.common.collect.ImmutableSet<ChunkCoordIntPair> getChunkList()
```
    -
    Gets a list of requested chunks for this ticket.
    -
  -
-

Class ForgeChunkManager.Ticket

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

world

Method Detail

setChunkListDepth

getChunkListDepth

getMaxChunkListDepth

bindEntity

getModData

getEntity

isPlayerTicket

getPlayerName

getModId

getType

getChunkList