Skip to content

Commit e074bb7

Browse files
committed
chore: remove Polar and update Javadoc references
1 parent 8c18e14 commit e074bb7

File tree

4 files changed

+9
-77
lines changed

4 files changed

+9
-77
lines changed

.vitepress/config.mts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,6 @@ export default defineConfig({
8383
link: "/docs/world/loading",
8484
items: [
8585
{ text: "Anvil", link: "/docs/world/loading/anvil" },
86-
{ text: "Polar", link: "/docs/world/loading/polar" },
8786
],
8887
},
8988
{

docs/world/loading.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
# World Loading
22

3-
In order to load or save an [`Instance`](https://javadoc.minestom.net/net/minestom/server/instance/Instance.html), you must provide an [`IChunkLoader`](https://javadoc.minestom.net/net/minestom/server/instance/IChunkLoader.html) that Minestom will use to read and write chunk data to and from.
3+
In order to load or save an [`Instance`](https://javadoc.minestom.net/net.minestom.server/net/minestom/server/instance/Instance.html), you must provide a [`ChunkLoader`](https://javadoc.minestom.net/net.minestom.server/net/minestom/server/instance/ChunkLoader.html) that Minestom will use to read and write chunk data to and from.
44

55
When creating your instance, you can provide the loader in multiple ways:
6-
* [`InstanceManager#createInstanceContainer(@Nullable IChunkLoader)`](https://javadoc.minestom.net/net/minestom/server/instance/InstanceManager.html#createInstanceContainer(net.minestom.server.instance.IChunkLoader))
7-
* [`InstanceManager#createInstanceContainer(RegistryKey<DimensionType>, @Nullable IChunkLoader)`](https://javadoc.minestom.net/net/minestom/server/instance/InstanceManager.html#createInstanceContainer(net.minestom.server.instance.IChunkLoader))
8-
* [`InstanceContainer#setChunkLoader(IChunkLoader)`](https://javadoc.minestom.net/net/minestom/server/instance/InstanceContainer.html#setChunkLoader(net.minestom.server.instance.IChunkLoader))
6+
* [`InstanceManager#createInstanceContainer(@Nullable ChunkLoader)`](https://javadoc.minestom.net/net.minestom.server/net/minestom/server/instance/InstanceManager.html#createInstanceContainer(net.minestom.server.instance.ChunkLoader))
7+
* [`InstanceManager#createInstanceContainer(RegistryKey<DimensionType>, @Nullable ChunkLoader)`](https://javadoc.minestom.net/net.minestom.server/net/minestom/server/instance/InstanceManager.html#createInstanceContainer(net.minestom.server.instance.ChunkLoader))
8+
* [`InstanceContainer#setChunkLoader(ChunkLoader)`](https://javadoc.minestom.net/net.minestom.server/net/minestom/server/instance/InstanceContainer.html#setChunkLoader(net.minestom.server.instance.ChunkLoader))
99

1010
Minestom will automatically load chunks from the loader once provided.
1111

1212
## Saving
1313

1414
Saving must be done in two steps:
15-
1. [`Instance#saveChunksToStorage`](https://javadoc.minestom.net/net/minestom/server/instance/Instance.html#saveChunksToStorage())
16-
2. [`Instance#saveInstance`](https://javadoc.minestom.net/net/minestom/server/instance/Instance.html#saveInstance())
15+
1. [`Instance#saveChunksToStorage`](https://javadoc.minestom.net/net.minestom.server/net/minestom/server/instance/Instance.html#saveChunksToStorage())
16+
2. [`Instance#saveInstance`](https://javadoc.minestom.net/net.minestom.server/net/minestom/server/instance/Instance.html#saveInstance())
1717

1818
```java
1919
MinecraftServer.getSchedulerManager().buildShutdownTask(() -> {
@@ -24,6 +24,5 @@ MinecraftServer.getSchedulerManager().buildShutdownTask(() -> {
2424

2525
## Loaders
2626

27-
* [No-op](https://javadoc.minestom.net/net/minestom/server/instance/IChunkLoader.html#noop())
27+
* [No-op](https://javadoc.minestom.net/net.minestom.server/net/minestom/server/instance/ChunkLoader.html#noop())
2828
* [Anvil](/docs/world/loading/anvil.md)
29-
* [Polar](/docs/world/loading/polar.md)

docs/world/loading/anvil.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ Anvil is the format made by Mojang for vanilla. Minestom provides this format an
44

55
## Requirements
66

7-
Worlds to be used with [`AnvilLoader`](https://javadoc.minestom.net/net/minestom/server/instance/anvil/AnvilLoader.html) only need to contain the `region` directory, which is where the chunk data comes from. Chunk loaders do not read entity data.
7+
Worlds to be used with [`AnvilLoader`](https://javadoc.minestom.net/net.minestom.server/net/minestom/server/instance/anvil/AnvilLoader.html) only need to contain the `region` directory, which is where the chunk data comes from. Chunk loaders do not read entity data.
88

99
## Usage
1010

11-
To use a world from the **runtime file system**, you can do something like the following code snippet, which constructs the loader using [`AnvilLoader#<init>(Path)`](https://javadoc.minestom.net/net/minestom/server/instance/anvil/AnvilLoader.html#%3Cinit%3E(java.nio.file.Path)).
11+
To use a world from the **runtime file system**, you can do something like the following code snippet, which constructs the loader using [`AnvilLoader#<init>(Path)`](https://javadoc.minestom.net/net.minestom.server/net/minestom/server/instance/anvil/AnvilLoader.html#%3Cinit%3E(java.nio.file.Path)).
1212

1313
```java
1414
final Path directory = this.worlds.join("world");

docs/world/loading/polar.md

Lines changed: 0 additions & 66 deletions
This file was deleted.

0 commit comments

Comments
 (0)