Class ObjectivePlugin

java.lang.Object

com.hypixel.hytale.server.core.plugin.PluginBase

com.hypixel.hytale.server.core.plugin.JavaPlugin

com.hypixel.hytale.builtin.adventure.objectives.ObjectivePlugin

All Implemented Interfaces:

CommandOwner

public class ObjectivePlugin
extends JavaPlugin

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ObjectivePlugin.ObjectivePluginConfig

Field Summary

Fields

Modifier and Type	Field	Description
static final String	OBJECTIVE_LOCATION_MARKER_MODEL_ID
static final long	SAVE_INTERVAL_MINUTES

Fields inherited from class PluginBase

METRICS_REGISTRY

Constructor Summary

Constructors

Constructor	Description
ObjectivePlugin(JavaPluginInit init)

Method Summary

Modifier and Type	Method	Description
void	addPlayerToExistingObjective(Store<EntityStore> store, UUID playerUUID, UUID objectiveUUID)
void	cancelObjective(UUID objectiveUUID, Store<EntityStore> store)
boolean	canPlayerDoObjective(Player player, String objectiveAssetId)
boolean	canPlayerDoObjectiveLine(Player player, String objectiveLineId)
ObjectiveCompletion	createCompletion(ObjectiveCompletionAsset completionAsset)
ObjectiveTask	createTask(ObjectiveTaskAsset task, int taskSetIndex, int taskIndex)
static ObjectivePlugin	get()
String	getObjectiveDataDump()
ObjectiveDataStore	getObjectiveDataStore()
ComponentType<EntityStore, ObjectiveHistoryComponent>	getObjectiveHistoryComponentType()
ComponentType<EntityStore, ObjectiveLocationMarker>	getObjectiveLocationMarkerComponentType()
Model	getObjectiveLocationMarkerModel()
ComponentType<EntityStore, ReachLocationMarker>	getReachLocationMarkerComponentType()
void	objectiveCompleted(Objective objective, Store<EntityStore> store)
<T extends ObjectiveCompletionAsset, U extends ObjectiveCompletion> void	registerCompletion(String id, Class<T> assetClass, Codec<T> codec, Function<T,U> generator)
<T extends ObjectiveTaskAsset, U extends ObjectiveTask> void	registerTask(String id, Class<T> assetClass, Codec<T> assetCodec, Class<U> implementationClass, Codec<U> implementationCodec, TriFunction<T,Integer,Integer,U> generator)
void	removePlayerFromExistingObjective(Store<EntityStore> store, UUID playerUUID, UUID objectiveUUID)
Objective	startObjective(String objectiveId, Set<UUID> playerUUIDs, UUID worldUUID, UUID markerUUID, Store<EntityStore> store)
Objective	startObjective(String objectiveId, UUID objectiveUUID, Set<UUID> playerUUIDs, UUID worldUUID, UUID markerUUID, Store<EntityStore> store)
Objective	startObjectiveLine(Store<EntityStore> store, String objectiveLineId, Set<UUID> playerUUIDs, UUID worldUUID, UUID markerUUID)
void	storeObjectiveHistoryData(Objective objective)
void	storeObjectiveLineHistoryData(ObjectiveLineHistoryData objectiveLineHistoryData, Set<UUID> playerUUIDs)
void	untrackObjectiveForPlayer(Objective objective, UUID playerUUID)

Methods inherited from class JavaPlugin

getClassLoader, getFile, getType

Methods inherited from class PluginBase

getAssetRegistry, getBasePermission, getChunkStoreRegistry, getClientFeatureRegistry, getCodecRegistry, getCodecRegistry, getCodecRegistry, getCommandRegistry, getDataDirectory, getEntityRegistry, getEntityStoreRegistry, getEventRegistry, getIdentifier, getLogger, getManifest, getName, getState, getTaskRegistry, isDisabled, isEnabled, preLoad

Methods inherited from class Object

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

Field Details

OBJECTIVE_LOCATION_MARKER_MODEL_ID

@Nonnull
public static final String OBJECTIVE_LOCATION_MARKER_MODEL_ID

See Also:

• Constant Field Values

SAVE_INTERVAL_MINUTES

public static final long SAVE_INTERVAL_MINUTES

See Also:

• Constant Field Values

Constructor Details

ObjectivePlugin

public ObjectivePlugin(@Nonnull
 JavaPluginInit init)

Method Details

get

public static ObjectivePlugin get()

getObjectiveHistoryComponentType

public ComponentType<EntityStore, ObjectiveHistoryComponent> getObjectiveHistoryComponentType()

getObjectiveLocationMarkerModel

public Model getObjectiveLocationMarkerModel()

getObjectiveDataStore

@Nullable
public ObjectiveDataStore getObjectiveDataStore()

getReachLocationMarkerComponentType

public ComponentType<EntityStore, ReachLocationMarker> getReachLocationMarkerComponentType()

getObjectiveLocationMarkerComponentType

public ComponentType<EntityStore, ObjectiveLocationMarker> getObjectiveLocationMarkerComponentType()

registerTask

public <T extends ObjectiveTaskAsset, U extends ObjectiveTask>
void registerTask(String id,
 Class<T> assetClass,
 Codec<T> assetCodec,
 Class<U> implementationClass,
 Codec<U> implementationCodec,
 TriFunction<T,Integer,Integer,U> generator)

registerCompletion

public <T extends ObjectiveCompletionAsset, U extends ObjectiveCompletion>
void registerCompletion(String id,
 Class<T> assetClass,
 Codec<T> codec,
 Function<T,U> generator)

createTask

public ObjectiveTask createTask(@Nonnull
 ObjectiveTaskAsset task,
 int taskSetIndex,
 int taskIndex)

createCompletion

public ObjectiveCompletion createCompletion(@Nonnull
 ObjectiveCompletionAsset completionAsset)

startObjective

@Nullable
public Objective startObjective(@Nonnull
 String objectiveId,
 @Nonnull
 Set<UUID> playerUUIDs,
 @Nonnull
 UUID worldUUID,
 @Nullable
 UUID markerUUID,
 @Nonnull
 Store<EntityStore> store)

startObjective

@Nullable
public Objective startObjective(@Nonnull
 String objectiveId,
 @Nullable
 UUID objectiveUUID,
 @Nonnull
 Set<UUID> playerUUIDs,
 @Nonnull
 UUID worldUUID,
 @Nullable
 UUID markerUUID,
 @Nonnull
 Store<EntityStore> store)

canPlayerDoObjective

public boolean canPlayerDoObjective(@Nonnull
 Player player,
 @Nonnull
 String objectiveAssetId)

startObjectiveLine

@Nullable
public Objective startObjectiveLine(@Nonnull
 Store<EntityStore> store,
 @Nonnull
 String objectiveLineId,
 @Nonnull
 Set<UUID> playerUUIDs,
 @Nonnull
 UUID worldUUID,
 @Nullable
 UUID markerUUID)

canPlayerDoObjectiveLine

public boolean canPlayerDoObjectiveLine(@Nonnull
 Player player,
 @Nonnull
 String objectiveLineId)

objectiveCompleted

public void objectiveCompleted(@Nonnull
 Objective objective,
 @Nonnull
 Store<EntityStore> store)

storeObjectiveHistoryData

public void storeObjectiveHistoryData(@Nonnull
 Objective objective)

storeObjectiveLineHistoryData

public void storeObjectiveLineHistoryData(@Nonnull
 ObjectiveLineHistoryData objectiveLineHistoryData,
 @Nonnull
 Set<UUID> playerUUIDs)

cancelObjective

public void cancelObjective(@Nonnull
 UUID objectiveUUID,
 @Nonnull
 Store<EntityStore> store)

untrackObjectiveForPlayer

public void untrackObjectiveForPlayer(@Nonnull
 Objective objective,
 @Nonnull
 UUID playerUUID)

addPlayerToExistingObjective

public void addPlayerToExistingObjective(@Nonnull
 Store<EntityStore> store,
 @Nonnull
 UUID playerUUID,
 @Nonnull
 UUID objectiveUUID)

removePlayerFromExistingObjective

public void removePlayerFromExistingObjective(@Nonnull
 Store<EntityStore> store,
 @Nonnull
 UUID playerUUID,
 @Nonnull
 UUID objectiveUUID)

getObjectiveDataDump

@Nonnull
public String getObjectiveDataDump()