Package journeymap.api.v2.common.waypoint

Class WaypointFactory

java.lang.Object

journeymap.api.v2.common.waypoint.WaypointFactory

public class WaypointFactory
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	WaypointFactory.WaypointStore

Constructor Summary

Constructors

Constructor	Description
WaypointFactory(WaypointFactory.WaypointStore store)

Method Summary

Modifier and Type	Method	Description
static Waypoint	createClientWaypoint(String modId, net.minecraft.core.BlockPos pos, @Nullable String name, String primaryDimension, boolean persistent)	Deprecated.
static Waypoint	createClientWaypoint(String modId, net.minecraft.core.BlockPos pos, @Nullable String name, net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> primaryDimension, boolean persistent)	Deprecated. Use createWaypoint(String, BlockPos, String, String, boolean) instead.
static Waypoint	createClientWaypoint(String modId, net.minecraft.core.BlockPos pos, String primaryDimension, boolean persistent)	Deprecated.
static Waypoint	createClientWaypoint(String modId, net.minecraft.core.BlockPos pos, net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> primaryDimension, boolean persistent)	Deprecated.
static Waypoint	createWaypoint(String modId, net.minecraft.core.BlockPos pos, @Nullable String name, String primaryDimension, boolean persistent)
static Waypoint	createWaypoint(String modId, net.minecraft.core.BlockPos pos, @Nullable String name, net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> primaryDimension, boolean persistent)	Creates a Waypoint.
static Waypoint	createWaypoint(String modId, net.minecraft.core.BlockPos pos, String primaryDimension, boolean persistent)
static Waypoint	createWaypoint(String modId, net.minecraft.core.BlockPos pos, net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> primaryDimension, boolean persistent)
static WaypointGroup	createWaypointGroup(String modId, String name)
static WaypointGroup	fromGroupJsonString(String waypoint)
static Waypoint	fromWaypointJsonString(String waypoint)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WaypointFactory

@Internal
public WaypointFactory(WaypointFactory.WaypointStore store)

Method Details

createWaypoint

public static Waypoint createWaypoint(String modId,
 net.minecraft.core.BlockPos pos,
 @Nullable
 @Nullable String name,
 net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> primaryDimension,
 boolean persistent)

Creates a Waypoint. On the client side this will be a ClientWaypoint; on the server side this will be a plain WaypointImpl.

Parameters:

modId - - The modid of the mod creating the waypoint

pos - - The BlockPos of the waypoint

name - - The Optional Name of the waypoint. If null, it will use the coordinates as the name.

primaryDimension - - The primary dimension identifier string.

persistent - - should the waypoint persist between sessions? True, JourneyMap will save this waypoint to disk and load every session it only needs to be sent once. False, The waypoint will be flushed when the user changes dimensions and exits the game.

Returns:

- The Waypoint with default values set.

createWaypoint

public static Waypoint createWaypoint(String modId,
 net.minecraft.core.BlockPos pos,
 net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> primaryDimension,
 boolean persistent)

createWaypoint

public static Waypoint createWaypoint(String modId,
 net.minecraft.core.BlockPos pos,
 String primaryDimension,
 boolean persistent)

createWaypoint

public static Waypoint createWaypoint(String modId,
 net.minecraft.core.BlockPos pos,
 @Nullable
 @Nullable String name,
 String primaryDimension,
 boolean persistent)

createClientWaypoint

@Deprecated
public static Waypoint createClientWaypoint(String modId,
 net.minecraft.core.BlockPos pos,
 @Nullable
 @Nullable String name,
 net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> primaryDimension,
 boolean persistent)

Deprecated.

Use createWaypoint(String, BlockPos, String, String, boolean) instead.

Creates a ClientWaypoint.

Parameters:

modId - - The modid of the mod creating the waypoint

pos - - The BlockPos of the waypoint

name - - The Optional Name of the waypoint. If null, it will use the coordinates as the name.e

primaryDimension - - The primary dimension, this is where it will be displayed and if waypoint teleporting is enabled this is the dimension the user will be teleported to.

persistent - - should the waypoint persist between sessions? True, JourneyMap will save this waypoint to disk and load every session it only needs to be sent once. False, The waypoint will be flushed when the user changes dimensions and exits the game.

Returns:

- The Waypoint with default values set.

createClientWaypoint

@Deprecated
public static Waypoint createClientWaypoint(String modId,
 net.minecraft.core.BlockPos pos,
 net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> primaryDimension,
 boolean persistent)

Deprecated.

createClientWaypoint

@Deprecated
public static Waypoint createClientWaypoint(String modId,
 net.minecraft.core.BlockPos pos,
 String primaryDimension,
 boolean persistent)

Deprecated.

createClientWaypoint

@Deprecated
public static Waypoint createClientWaypoint(String modId,
 net.minecraft.core.BlockPos pos,
 @Nullable
 @Nullable String name,
 String primaryDimension,
 boolean persistent)

Deprecated.

fromWaypointJsonString

public static Waypoint fromWaypointJsonString(String waypoint)

fromGroupJsonString

public static WaypointGroup fromGroupJsonString(String waypoint)

createWaypointGroup

public static WaypointGroup createWaypointGroup(String modId,
 String name)