Skip to content

Commit da2189a

Browse files
mysticdrewclaude
andcommitted
Fixed: requestMapTile is now open to all plugins, updated javadoc
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent d1101a5 commit da2189a

File tree

1 file changed

+7
-10
lines changed

1 file changed

+7
-10
lines changed

common/src/main/java/journeymap/api/v2/client/IClientAPI.java

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -125,21 +125,18 @@ public interface IClientAPI extends CommonAPI
125125
boolean playerAccepts(String modId, DisplayType displayType);
126126

127127
/**
128-
* Note: This method IS NOT SUPPORTED for most mods. Misuse will lead to severe performance issues.
129-
* Talk to Techbrew if you need to use this function.
130-
* <p>
131-
* Asynchonrously request a BufferedImage map tile from JourneyMap. Requests may be throttled, so use sparingly.
128+
* Asynchronously request a map tile image from JourneyMap. Requests may be throttled, so use sparingly.
132129
* The largest image size that will be returned is 512x512 px.
133130
*
134-
* @param modId Mod id
131+
* @param modId The calling mod's id
135132
* @param dimension The dimension
136133
* @param mapType The map type
137-
* @param startChunk The NW chunk of the tile.
138-
* @param endChunk The SW chunk of the tile.
139-
* @param chunkY The vertical chunk (slice) if the maptype isn't day/night/topo
134+
* @param startChunk The NW chunk of the tile
135+
* @param endChunk The SE chunk of the tile
136+
* @param chunkY The vertical chunk (slice) if the map type isn't day/night/topo
140137
* @param zoom The zoom level (0-8)
141-
* @param showGrid Whether to include to include the chunk grid overlay
142-
* @param callback A callback function which will provide a BufferedImage when/if available. If it returns null, then no image available.
138+
* @param showGrid Whether to include the chunk grid overlay
139+
* @param callback A callback which will receive the NativeImage when available, or null if unavailable
143140
*/
144141
void requestMapTile(String modId, ResourceKey<Level> dimension, Context.MapType mapType, ChunkPos startChunk, ChunkPos endChunk,
145142
@Nullable Integer chunkY, int zoom, boolean showGrid, final Consumer<NativeImage> callback);

0 commit comments

Comments
 (0)