From 0427ab89f1753a44b30cbc35ce021cbbdc845109 Mon Sep 17 00:00:00 2001 From: Foghrye4 Date: Thu, 10 Aug 2017 18:52:45 +0300 Subject: fix missing source folder --- .../minecraftforge/common/ForgeChunkManager.html | 694 +++++++++++++++++++++ 1 file changed, 694 insertions(+) create mode 100644 javadoc/net/minecraftforge/common/ForgeChunkManager.html (limited to 'javadoc/net/minecraftforge/common/ForgeChunkManager.html') diff --git a/javadoc/net/minecraftforge/common/ForgeChunkManager.html b/javadoc/net/minecraftforge/common/ForgeChunkManager.html new file mode 100644 index 0000000..0550c95 --- /dev/null +++ b/javadoc/net/minecraftforge/common/ForgeChunkManager.html @@ -0,0 +1,694 @@ + + + + + +ForgeChunkManager (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.common
+

Class ForgeChunkManager

+
+
+ +
+
    +
  • +
    +
    +
    public class ForgeChunkManager
+extends java.lang.Object
    +
    Manages chunkloading for mods. + + The basic principle is a ticket based system. + 1. Mods register a callback setForcedChunkLoadingCallback(Object, LoadingCallback) + 2. Mods ask for a ticket requestTicket(Object, World, Type) and then hold on to that ticket. + 3. Mods request chunks to stay loaded forceChunk(Ticket, ChunkCoordIntPair) or remove chunks from force loading unforceChunk(Ticket, ChunkCoordIntPair). + 4. When a world unloads, the tickets associated with that world are saved by the chunk manager. + 5. When a world loads, saved tickets are offered to the mods associated with the tickets. The ForgeChunkManager.Ticket.getModData() that is set by the mod should be used to re-register + chunks to stay loaded (and maybe take other actions). + + The chunkloading is configurable at runtime. The file "config/forgeChunkLoading.cfg" contains both default configuration for chunkloading, and a sample individual mod + specific override section.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        MOD_PROP_ORDER

        +
        public static final java.util.List<java.lang.String> MOD_PROP_ORDER
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ForgeChunkManager

        +
        public ForgeChunkManager()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        savedWorldHasForcedChunkTickets

        +
        public static boolean savedWorldHasForcedChunkTickets(java.io.File chunkDir)
        +
        Allows dynamically loading world mods to test if there are chunk tickets in the world + Mods that add dynamically generated worlds (like Mystcraft) should call this method + to determine if the world should be loaded during server starting.
        +
        Parameters:
        chunkDir - The chunk directory to test: should be equivalent to WorldServer.getChunkSaveLocation()
        +
        Returns:
        if there are tickets outstanding for this world or not
        +
        • +
      + + + +
        +
      • +

        setForcedChunkLoadingCallback

        +
        public static void setForcedChunkLoadingCallback(java.lang.Object mod,
+                                 ForgeChunkManager.LoadingCallback callback)
        +
        Set a chunkloading callback for the supplied mod object
        +
        Parameters:
        mod - The mod instance registering the callback
        callback - The code to call back when forced chunks are loaded
        +
        • +
      + + + +
        +
      • +

        ticketCountAvailableFor

        +
        public static int ticketCountAvailableFor(java.lang.Object mod,
+                          World world)
        +
        Discover the available tickets for the mod in the world
        +
        Parameters:
        mod - The mod that will own the tickets
        world - The world
        +
        Returns:
        The count of tickets left for the mod in the supplied world
        +
        • +
      + + + +
        +
      • +

        getMaxTicketLengthFor

        +
        public static int getMaxTicketLengthFor(java.lang.String modId)
        +
        • +
      + + + +
        +
      • +

        getMaxChunkDepthFor

        +
        public static int getMaxChunkDepthFor(java.lang.String modId)
        +
        • +
      + + + +
        +
      • +

        ticketCountAvailableFor

        +
        public static int ticketCountAvailableFor(java.lang.String username)
        +
        • +
      + + + + + + + +
        +
      • +

        requestTicket

        +
        public static ForgeChunkManager.Ticket requestTicket(java.lang.Object mod,
+                                     World world,
+                                     ForgeChunkManager.Type type)
        +
        Request a chunkloading ticket of the appropriate type for the supplied mod
        +
        Parameters:
        mod - The mod requesting a ticket
        world - The world in which it is requesting the ticket
        type - The type of ticket
        +
        Returns:
        A ticket with which to register chunks for loading, or null if no further tickets are available
        +
        • +
      + + + +
        +
      • +

        releaseTicket

        +
        public static void releaseTicket(ForgeChunkManager.Ticket ticket)
        +
        Release the ticket back to the system. This will also unforce any chunks held by the ticket so that they can be unloaded and/or stop ticking.
        +
        Parameters:
        ticket - The ticket to release
        +
        • +
      + + + +
        +
      • +

        forceChunk

        +
        public static void forceChunk(ForgeChunkManager.Ticket ticket,
+              ChunkCoordIntPair chunk)
        +
        Force the supplied chunk coordinate to be loaded by the supplied ticket. If the ticket's ForgeChunkManager.Ticket.maxDepth is exceeded, the least + recently registered chunk is unforced and may be unloaded. + It is safe to force the chunk several times for a ticket, it will not generate duplication or change the ordering.
        +
        Parameters:
        ticket - The ticket registering the chunk
        chunk - The chunk to force
        +
        • +
      + + + +
        +
      • +

        reorderChunk

        +
        public static void reorderChunk(ForgeChunkManager.Ticket ticket,
+                ChunkCoordIntPair chunk)
        +
        Reorganize the internal chunk list so that the chunk supplied is at the *end* of the list + This helps if you wish to guarantee a certain "automatic unload ordering" for the chunks + in the ticket list
        +
        Parameters:
        ticket - The ticket holding the chunk list
        chunk - The chunk you wish to push to the end (so that it would be unloaded last)
        +
        • +
      + + + +
        +
      • +

        unforceChunk

        +
        public static void unforceChunk(ForgeChunkManager.Ticket ticket,
+                ChunkCoordIntPair chunk)
        +
        Unforce the supplied chunk, allowing it to be unloaded and stop ticking.
        +
        Parameters:
        ticket - The ticket holding the chunk
        chunk - The chunk to unforce
        +
        • +
      + + + +
        +
      • +

        getPersistentChunksFor

        +
        public static com.google.common.collect.ImmutableSetMultimap<ChunkCoordIntPair,ForgeChunkManager.Ticket> getPersistentChunksFor(World world)
        +
        The list of persistent chunks in the world. This set is immutable.
        +
        Parameters:
        world -
        +
        Returns:
        the list of persistent chunks in the world
        +
        • +
      + + + +
        +
      • +

        putDormantChunk

        +
        public static void putDormantChunk(long coords,
+                   Chunk chunk)
        +
        • +
      + + + +
        +
      • +

        fetchDormantChunk

        +
        public static Chunk fetchDormantChunk(long coords,
+                      World world)
        +
        • +
      + + + +
        +
      • +

        syncConfigDefaults

        +
        public static void syncConfigDefaults()
        +
        Synchronizes the local fields with the values in the Configuration object.
        +
        • +
      + + + + + + + +
        +
      • +

        getDefaultsCategory

        +
        public static ConfigCategory getDefaultsCategory()
        +
        • +
      + + + +
        +
      • +

        getModCategories

        +
        public static java.util.List<ConfigCategory> getModCategories()
        +
        • +
      + + + +
        +
      • +

        getConfigFor

        +
        public static ConfigCategory getConfigFor(java.lang.Object mod)
        +
        • +
      + + + +
        +
      • +

        addConfigProperty

        +
        public static void addConfigProperty(java.lang.Object mod,
+                     java.lang.String propertyName,
+                     java.lang.String value,
+                     Property.Type type)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + -- cgit v1.2.3