journeymap.api.v2.client.event

Class MappingEvent

java.lang.Object

journeymap.api.v2.common.event.impl.JourneyMapEvent

journeymap.api.v2.client.event.ClientEvent

journeymap.api.v2.client.event.MappingEvent

public class MappingEvent
extends ClientEvent

This event fires when mapping starts or stops. WorldId can be set when mapping starts. This event is not cancellable.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MappingEvent.Stage The mapping stages

Field Summary

Fields inherited from class journeymap.api.v2.client.event.ClientEvent

dimension

Fields inherited from class journeymap.api.v2.common.event.impl.JourneyMapEvent

timestamp

Constructor Summary

Constructors

Constructor and Description
MappingEvent(MappingEvent.Stage stage, net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dimension, java.lang.String worldId)

Method Summary

Modifier and Type	Method and Description
MappingEvent.Stage	getStage() Gets the current mapping stage.
@Nullable java.lang.String	getWorldId() Gets the worldId for the current world.
void	setWorldId(@Nullable java.lang.String worldId) Sets the world id when mapping starts.

Methods inherited from class journeymap.api.v2.common.event.impl.JourneyMapEvent

cancel, isCancellable, isCancelled

Methods inherited from class java.lang.Object

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

Constructor Detail

MappingEvent

public MappingEvent(MappingEvent.Stage stage,
                    net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dimension,
                    java.lang.String worldId)

Method Detail

getStage

public MappingEvent.Stage getStage()

Gets the current mapping stage.

Returns:

- The stage

getWorldId

@Nullable
public @Nullable java.lang.String getWorldId()

Gets the worldId for the current world. Will return null if no worldId has been set.

Returns:

worldId.

setWorldId

public void setWorldId(@Nullable
                       @Nullable java.lang.String worldId)

Sets the world id when mapping starts. This can only be set on the mapping started stage.

Parameters:

worldId - - the new worldId