IClientAPI (JourneyMap API and Example Mod)

All Superinterfaces:: CommonAPI

@ParametersAreNonnullByDefault
public interface IClientAPI
extends CommonAPI

Definition for the JourneyMap Client API.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String API_OWNER

static java.lang.String API_VERSION

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`API_OWNER`
`static java.lang.String`	`API_VERSION`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addWaypoint(java.lang.String modId, Waypoint waypoint)` Adds a waypoint
`void`	`addWaypointGroup(WaypointGroup group)` Adds a Waypoint group to the system.
`void`	`disableFeature(net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dimension, Context.MapType mapType, boolean enable)` Note: This method IS NOT SUPPORTED for most mods.
`boolean`	`exists(Displayable displayable)` Check whether a displayable exists in the Client API.
`java.util.List<? extends WaypointGroup>`	`getAllWaypointGroups()` Gets an immutable list of all waypoint groups.
`java.util.List<? extends Waypoint>`	`getAllWaypoints()` Returns all waypoints that journeymap has stored for the current game/server.
`java.util.List<? extends Waypoint>`	`getAllWaypoints(net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dim)` Gets all waypoints for the provided dimension from all of journeymap's waypoints.
`java.io.File`	`getDataPath(java.lang.String modId)` This call gets the current user's data path for saving custom addon data specific to the game/world the user is playing in.
`UIState`	`getUIState(Context.UI ui)` Returns the current UIState of the UI specified.
`Waypoint`	`getWaypoint(java.lang.String modId, java.lang.String guid)` Gets the waypoint by display Id for the modId provided.
`WaypointGroup`	`getWaypointGroup(java.lang.String groupGuid)` Gets a waypoint group from the group's guid.
`WaypointGroup`	`getWaypointGroupByName(java.lang.String modId, java.lang.String name)` Gets a waypoint group from the name.
`java.util.List<? extends WaypointGroup>`	`getWaypointGroups(java.lang.String modId)` Gets all waypoint groups for a modid.
`java.util.List<? extends Waypoint>`	`getWaypoints(java.lang.String modId)` Gets all waypoints for the provided modId
`java.lang.String`	`getWorldId()` Gets the worldId for the current world.
`boolean`	`minimapEnabled()` Gets the minimap enabled or disabled state
`boolean`	`playerAccepts(java.lang.String modId, DisplayType displayType)` Check whether player will accept a type of Displayable from your mod.
`void`	`remove(Displayable displayable)` Remove a displayable from the player's maps.
`void`	`removeAll(java.lang.String modId)` Remove all displayables.
`void`	`removeAll(java.lang.String modId, DisplayType displayType)` Remove all displayables by DisplayType from the player's maps.
`void`	`removeAllWaypoints(java.lang.String modId)` Remove all waypoints.
`void`	`removeWaypoint(java.lang.String modId, Waypoint waypoint)` Remove a waypoint.
`void`	`removeWaypointGroup(WaypointGroup group, boolean deleteWaypoints)` Removes a waypoint group.
`void`	`removeWaypointGroups(java.lang.String modId, boolean deleteWaypoints)` Removes groups for a modId.
`void`	`requestMapTile(java.lang.String modId, net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dimension, Context.MapType mapType, net.minecraft.world.level.ChunkPos startChunk, net.minecraft.world.level.ChunkPos endChunk, java.lang.Integer chunkY, int zoom, boolean showGrid, java.util.function.Consumer<com.mojang.blaze3d.platform.NativeImage> callback)` Asynchronously request a map tile image from JourneyMap.
`void`	`show(Displayable displayable)` Add (or update) a displayable object to the player's maps.
`void`	`toggleMinimap(boolean enable)` Toggles the minimmap display

- Field Detail
  - API_OWNER
```
static final java.lang.String API_OWNER
```
    See Also:
    
    Constant Field Values
  - API_VERSION
```
static final java.lang.String API_VERSION
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getUIState
```
@Nullable
UIState getUIState(Context.UI ui)
```
    Returns the current UIState of the UI specified.
    Note: Context.UI.Any is not a meaningful parameter value here and will just return null.
    
    Parameters:
    
    ui - Should be one of: Fullscreen, Minimap, or Webmap
    
    Returns:
    
    the current UIState of the UI specified.
  - show
```
void show(Displayable displayable)
   throws java.lang.Exception
```
    Add (or update) a displayable object to the player's maps. If you modify a Displayable after it has been added, call this method again to ensure the maps reflect your changes.
    If an object of the same Displayable.Type from your mod with the same displayId has already been added, it will be replaced.
    Has no effect on display types not accepted by the player.
    
    Parameters:
    
    displayable - The object to display.
    
    Throws:
    
    java.lang.Exception - if the Displayable can't be shown.
    
    See Also:
    
    playerAccepts(String, DisplayType)
  - remove
```
void remove(Displayable displayable)
```
    Remove a displayable from the player's maps. Has no effect on display types not accepted by the player.
    
    Parameters:
    
    displayable - The object to display.
    
    See Also:
    
    playerAccepts(String, DisplayType)
  - removeAll
```
void removeAll(java.lang.String modId,
               DisplayType displayType)
```
    Remove all displayables by DisplayType from the player's maps. Has no effect on display types not accepted by the player.
    
    Parameters:
    
    modId - Mod id
    
    displayType - Display type
    
    See Also:
    
    playerAccepts(String, DisplayType)
  - removeAll
```
void removeAll(java.lang.String modId)
```
    Remove all displayables. Has no effect on display types not accepted by the player.
    
    Parameters:
    
    modId - Mod id
    
    See Also:
    
    playerAccepts(String, DisplayType)
  - exists
```
boolean exists(Displayable displayable)
```
    Check whether a displayable exists in the Client API. A return value of true means the Client API has the indicated displayable, but not necessarily that the player has made it visible.
    Always returns false if the display type is not accepted by the player.
    
    Parameters:
    
    displayable - the object
    
    See Also:
    
    playerAccepts(String, DisplayType)
  - playerAccepts
```
boolean playerAccepts(java.lang.String modId,
                      DisplayType displayType)
```
    Check whether player will accept a type of Displayable from your mod. (Like Displayables or Overlays).
    
    Parameters:
    
    modId - Mod id
    
    displayType - Display type to check
    
    Returns:
    
    true if player accepts addition/removal of displayables
    
    See Also:
    
    DisplayType
  - requestMapTile
```
void requestMapTile(java.lang.String modId,
                    net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dimension,
                    Context.MapType mapType,
                    net.minecraft.world.level.ChunkPos startChunk,
                    net.minecraft.world.level.ChunkPos endChunk,
                    @Nullable
                    java.lang.Integer chunkY,
                    int zoom,
                    boolean showGrid,
                    java.util.function.Consumer<com.mojang.blaze3d.platform.NativeImage> callback)
```
    Asynchronously request a map tile image from JourneyMap. Requests may be throttled, so use sparingly. The largest image size that will be returned is 512x512 px.
    
    Parameters:
    
    modId - The calling mod's id
    
    dimension - The dimension
    
    mapType - The map type
    
    startChunk - The NW chunk of the tile
    
    endChunk - The SE chunk of the tile
    
    chunkY - The vertical chunk (slice) if the map type isn't day/night/topo
    
    zoom - The zoom level (0-8)
    
    showGrid - Whether to include the chunk grid overlay
    
    callback - A callback which will receive the NativeImage when available, or null if unavailable
  - disableFeature
```
void disableFeature(@Nullable
                    net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dimension,
                    Context.MapType mapType,
                    boolean enable)
```
    Note: This method IS NOT SUPPORTED for most mods. Talk to Techbrew if you need to use this function.
    This call can be used to enable or disable map types and UIs in a specific dimension or all dimensions.
    
    Parameters:
    
    dimension - The dimension. Use null for all dimensions.
    
    mapType - The map type
    
    enable - True to enable, false to disable.
  - getDataPath
```
@Nullable
java.io.File getDataPath(java.lang.String modId)
```
    This call gets the current user's data path for saving custom addon data specific to the game/world the user is playing in.
    This is only valid when Journeymap is mapping. Mods ideally should store this value on MappingEvent.Stage#MAPPING_STARTED event.
    Note: Will method return null if not in world or not mapping. The path is flushed right after MappingEvent.Stage#MAPPING_STOPPED
    
    Parameters:
    
    modId - The ModId
    
    Returns:
    
    a path similar to ./journeymap/data/{sp|mp}/{worldname}/addon-data/{modid}/
  - getAllWaypoints
```
java.util.List<? extends Waypoint> getAllWaypoints()
```
    Returns all waypoints that journeymap has stored for the current game/server. Modifying these waypoints will not change anything in game, they are just a copy.
    
    Returns:
    
    - List of all waypoints.
  - getAllWaypoints
```
java.util.List<? extends Waypoint> getAllWaypoints(net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dim)
```
    Gets all waypoints for the provided dimension from all of journeymap's waypoints. Modifying these waypoints will not change anything in game, they are just a copy.
    
    Parameters:
    
    dim - - The dimension
    
    Returns:
    
    The waypoints.
  - getWaypoint
```
@Nullable
Waypoint getWaypoint(java.lang.String modId,
                               java.lang.String guid)
```
    Gets the waypoint by display Id for the modId provided.
    
    Parameters:
    
    modId - - The modId
    
    guid - - The guid
    
    Returns:
    
    The waypoint.
  - getWaypoints
```
java.util.List<? extends Waypoint> getWaypoints(java.lang.String modId)
```
    Gets all waypoints for the provided modId
    
    Parameters:
    
    modId - - The modId
    
    Returns:
    
    the waypoint list
  - removeWaypoint
```
void removeWaypoint(java.lang.String modId,
                    Waypoint waypoint)
```
    Remove a waypoint.
    
    Parameters:
    
    modId - - The modId
    
    waypoint - - the waypoint
  - addWaypoint
```
void addWaypoint(java.lang.String modId,
                 Waypoint waypoint)
```
    Adds a waypoint
    
    Parameters:
    
    modId - - The modId
    
    waypoint - - the waypoint
  - removeAllWaypoints
```
void removeAllWaypoints(java.lang.String modId)
```
    Remove all waypoints.
    
    Parameters:
    
    modId - - The modId
  - addWaypointGroup
```
void addWaypointGroup(WaypointGroup group)
```
    Adds a Waypoint group to the system.
  - getWaypointGroup
```
WaypointGroup getWaypointGroup(java.lang.String groupGuid)
```
    Gets a waypoint group from the group's guid.
    
    Parameters:
    
    groupGuid - the guid
    
    Returns:
    
    the group.
  - getWaypointGroupByName
```
WaypointGroup getWaypointGroupByName(java.lang.String modId,
                                     java.lang.String name)
```
    Gets a waypoint group from the name. (not case-sensitive) If multiple are found, returns the first one.
    
    Parameters:
    
    name - the group name
    
    modId - the modId
    
    Returns:
    
    the group.
  - getWaypointGroups
```
java.util.List<? extends WaypointGroup> getWaypointGroups(java.lang.String modId)
```
    Gets all waypoint groups for a modid.
    
    Parameters:
    
    modId - the modId
    
    Returns:
    
    the immutable list of groups
  - getAllWaypointGroups
```
java.util.List<? extends WaypointGroup> getAllWaypointGroups()
```
    Gets an immutable list of all waypoint groups.
    
    Returns:
    
    the immutable list of groups
  - removeWaypointGroup
```
void removeWaypointGroup(WaypointGroup group,
                         boolean deleteWaypoints)
```
    Removes a waypoint group. Setting deleteWaypoints to false will move all waypoints in the Default group.
    
    Parameters:
    
    group - the group
    
    deleteWaypoints - to delete all waypoints in group
  - removeWaypointGroups
```
void removeWaypointGroups(java.lang.String modId,
                          boolean deleteWaypoints)
```
    Removes groups for a modId. Setting deleteWaypoints to false will move all waypoints in the Default group.
    
    Parameters:
    
    modId - - the modId
    
    deleteWaypoints - to delete all waypoints in group
  - getWorldId
```
java.lang.String getWorldId()
```
    Gets the worldId for the current world.
    
    Returns:
    
    worldId.
  - toggleMinimap
```
void toggleMinimap(boolean enable)
```
    Toggles the minimmap display
    
    Parameters:
    
    enable - - enable or disable
  - minimapEnabled
```
boolean minimapEnabled()
```
    Gets the minimap enabled or disabled state
    
    Returns:
    
    - true or false

Interface IClientAPI

Field Summary

Method Summary

Field Detail

API_OWNER

API_VERSION

Method Detail

getUIState

show

remove

removeAll

removeAll

exists

playerAccepts

requestMapTile

disableFeature

getDataPath

getAllWaypoints

getAllWaypoints

getWaypoint

getWaypoints

removeWaypoint

addWaypoint

removeAllWaypoints

addWaypointGroup

getWaypointGroup

getWaypointGroupByName

getWaypointGroups

getAllWaypointGroups

removeWaypointGroup

removeWaypointGroups

getWorldId

toggleMinimap

minimapEnabled