From dc3df3edd5843bde0c1335d6a8e460b2c832aa48 Mon Sep 17 00:00:00 2001 From: Foghrye4 Date: Sat, 17 Jun 2017 08:12:18 +0300 Subject: full project files --- .../common/ForgeChunkManager.Ticket.html | 435 +++++++++++++++++++++ 1 file changed, 435 insertions(+) create mode 100644 javadoc/net/minecraftforge/common/ForgeChunkManager.Ticket.html (limited to 'javadoc/net/minecraftforge/common/ForgeChunkManager.Ticket.html') diff --git a/javadoc/net/minecraftforge/common/ForgeChunkManager.Ticket.html b/javadoc/net/minecraftforge/common/ForgeChunkManager.Ticket.html new file mode 100644 index 0000000..181e4eb --- /dev/null +++ b/javadoc/net/minecraftforge/common/ForgeChunkManager.Ticket.html @@ -0,0 +1,435 @@ + + + + + +ForgeChunkManager.Ticket (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.minecraftforge.common
+

Class ForgeChunkManager.Ticket

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    ForgeChunkManager
    +
    +
    +
    +
    public static class ForgeChunkManager.Ticket
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      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
        +
        • +
      + + + + + + + +
        +
      • +

        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
        +
        • +
      + + + + + + + +
        +
      • +

        getChunkList

        +
        public com.google.common.collect.ImmutableSet<ChunkCoordIntPair> getChunkList()
        +
        Gets a list of requested chunks for this ticket.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + -- cgit v1.2.3