ObjectivePlugin

public class ObjectivePlugin extends JavaPlugin

The main plugin class for Objective. This plugin provides gameplay features for the Hytale server. Extend this class to create a plugin.

java.lang.Object > JavaPlugin > ObjectivePlugin

Field Summary

objectiveLocationMarkerModel

private Model objectiveLocationMarkerModel

Field objectiveLocationMarkerModel.

objectiveDataStore

private ObjectiveDataStore objectiveDataStore

Field objectiveDataStore.

entityModule

final EntityModule entityModule

Field entityModule.

modelAsset

final ModelAsset modelAsset

Field modelAsset.

asset

final ObjectiveAsset asset

Field asset.

objective

final Objective objective

Field objective.

setupResult

final boolean setupResult

Field setupResult.

assetTitleMessage

final Message assetTitleMessage

Field assetTitleMessage.

playerRefComponent

final PlayerRef playerRefComponent

Field playerRefComponent.

trackObjectivePacket

final TrackOrUpdateObjective trackObjectivePacket

Field trackObjectivePacket.

objectiveAssetId

final String objectiveAssetId

Field objectiveAssetId.

playerComponent

final Player playerComponent

Field playerComponent.

playerRefComponent2

final PlayerRef playerRefComponent2

Field playerRefComponent2.

uuidComponent

final UUIDComponent uuidComponent

Field uuidComponent.

playerConfigData

final PlayerConfigData playerConfigData

Field playerConfigData.

activeObjectiveUUIDs

final HashSet activeObjectiveUUIDs

Field activeObjectiveUUIDs.

objectiveLineAsset

final ObjectiveLineAsset objectiveLineAsset

Field objectiveLineAsset.

objectiveIds

final String[] objectiveIds

Field objectiveIds.

universe

final Universe universe

Field universe.

playerList

final HashSet playerList

Field playerList.

playerRef

final PlayerRef playerRef

Field playerRef.

playerReference

final Ref playerReference

Field playerReference.

objectiveLineIdMessage

final Message objectiveLineIdMessage

Field objectiveLineIdMessage.

objectiveLineHistoryData

final ObjectiveLineHistoryData objectiveLineHistoryData

Field objectiveLineHistoryData.

objectiveUUID

final UUID objectiveUUID

Field objectiveUUID.

nextObjectiveId

final String nextObjectiveId

Field nextObjectiveId.

nextObjectiveLineIds

final String[] nextObjectiveLineIds

Field nextObjectiveLineIds.

newObjective

final Objective newObjective

Field newObjective.

objectiveId

final String objectiveId

Field objectiveId.

store

final Store store

Field store.

world

final World world

Field world.

objectiveHistoryComponent

final ObjectiveHistoryComponent objectiveHistoryComponent

Field objectiveHistoryComponent.

completedObjectiveData

final ObjectiveHistoryData completedObjectiveData

Field completedObjectiveData.

objectiveLineId

final String objectiveLineId

Field objectiveLineId.

playerUUID

final UUID playerUUID

Field playerUUID.

completedObjectiveLineData

final ObjectiveLineHistoryData completedObjectiveLineData

Field completedObjectiveLineData.

currentTasks2

final ObjectiveTask[] currentTasks2

Field currentTasks2.

currentTasks

final ObjectiveTask[] currentTasks

Field currentTasks.

player

final Player player

Field player.

ref

final Ref ref

Field ref.

objectiveWorld

final World objectiveWorld

Field objectiveWorld.

query

final AndQuery query

Field query.

objectiveLocationMarkerComponent

final ObjectiveLocationMarker objectiveLocationMarkerComponent

Field objectiveLocationMarkerComponent.

objectiveLocationMarkerAsset

final ObjectiveLocationMarkerAsset objectiveLocationMarkerAsset

Field objectiveLocationMarkerAsset.

transformComponent

final TransformComponent transformComponent

Field transformComponent.

rotation

final Vector3f rotation

Field rotation.

modelComponent

final ModelComponent modelComponent

Field modelComponent.

oldModel

final Model oldModel

Field oldModel.

persistentModelComponent

final PersistentModel persistentModelComponent

Field persistentModelComponent.

newModel

final Model newModel

Field newModel.

entity

final LivingEntity entity

Field entity.

inventory

final CombinedItemContainer inventory

Field inventory.

itemStack

final ItemStack itemStack

Field itemStack.

objectiveAsset

final ObjectiveAsset objectiveAsset

Field objectiveAsset.

reference

final Ref reference

Field reference.

sb

final StringBuilder sb

Field sb.

dataStoreProvider

private DataStoreProvider dataStoreProvider

Field dataStoreProvider.

Method Detail

get

static ObjectivePlugin get ()

Method get.

ObjectivePlugin

public public ObjectivePlugin (@Nonnull final JavaPluginInit init)

Method ObjectivePlugin.

Parameters:
@Nonnull final JavaPluginInit init

getObjectiveHistoryComponentType

public ObjectiveHistoryComponent> getObjectiveHistoryComponentType ()

Method getObjectiveHistoryComponentType.

getObjectiveLocationMarkerModel

public Model getObjectiveLocationMarkerModel ()

Method getObjectiveLocationMarkerModel.

getObjectiveDataStore

public ObjectiveDataStore getObjectiveDataStore ()

Method getObjectiveDataStore.

setup

protected void setup ()

Method setup.

DefaultAssetMap

public new DefaultAssetMap ()

Method DefaultAssetMap.

ObjectiveDataStore

public new ObjectiveDataStore (this.config.get()

Method ObjectiveDataStore.

Parameters:
this.config.get( this.config.get(

ObjectiveCommand

public new ObjectiveCommand ()

Method ObjectiveCommand.

ObjectivePlayerSetupSystem

public new ObjectivePlayerSetupSystem (this.objectiveHistoryComponentType, Player.getComponentType()

Method ObjectivePlayerSetupSystem.

Parameters:
this.objectiveHistoryComponentType this.objectiveHistoryComponentType
Player.getComponentType( Player.getComponentType(

ObjectiveItemEntityRemovalSystem

public new ObjectiveItemEntityRemovalSystem ()

Method ObjectiveItemEntityRemovalSystem.

start

protected void start ()

Method start.

IllegalStateException

public new IllegalStateException (String.format("Default objective location marker model '%s' not found", "Objective_Location_Marker")

Method IllegalStateException.

Parameters:
String.format("Default objective location marker model '%s' not found"
"Objective_Location_Marker" "Objective_Location_Marker"

shutdown

protected void shutdown ()

Method shutdown.

getReachLocationMarkerComponentType

public ReachLocationMarker> getReachLocationMarkerComponentType ()

Method getReachLocationMarkerComponentType.

getObjectiveLocationMarkerComponentType

public ObjectiveLocationMarker> getObjectiveLocationMarkerComponentType ()

Method getObjectiveLocationMarkerComponentType.

registerTask

public void registerTask (final String id, final Class assetClass, final Codec assetCodec, final Class implementationClass, final Codec implementationCodec, final TriFunction generator)

Method registerTask.

Parameters:
final String id
final Class assetClass
final Codec assetCodec
final Class implementationClass
final Codec implementationCodec
final TriFunction generator

registerCompletion

public void registerCompletion (final String id, final Class assetClass, final Codec codec, final Function generator)

Method registerCompletion.

Parameters:
final String id
final Class assetClass
final Codec codec
final Function generator

createTask

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

Method createTask.

Parameters:
@Nonnull final ObjectiveTaskAsset task
final int taskSetIndex
final int taskIndex

createCompletion

public ObjectiveCompletion createCompletion (@Nonnull final ObjectiveCompletionAsset completionAsset)

Method createCompletion.

Parameters:
@Nonnull final ObjectiveCompletionAsset completionAsset

startObjective

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

Method startObjective.

Parameters:
@Nonnull final String objectiveId
@Nonnull final Set playerUUIDs
@Nonnull final UUID worldUUID
@Nullable final UUID markerUUID
@Nonnull final Store store

TrackOrUpdateObjective

public new TrackOrUpdateObjective (objective.toPacket()

Method TrackOrUpdateObjective.

Parameters:
objective.toPacket( objective.toPacket(

if

public else if (!this.canPlayerDoObjective(playerComponent, objectiveAssetId)

Method if.

Parameters:
!this.canPlayerDoObjective(playerComponent !this.canPlayerDoObjective(playerComponent
objectiveAssetId objectiveAssetId

canPlayerDoObjective

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

Method canPlayerDoObjective.

Parameters:
@Nonnull final Player player
@Nonnull final String objectiveAssetId

startObjectiveLine

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

Method startObjectiveLine.

Parameters:
@Nonnull final Store store
@Nonnull final String objectiveLineId
@Nonnull final Set playerUUIDs
@Nonnull final UUID worldUUID
@Nullable final UUID markerUUID

ObjectiveLineHistoryData

public new ObjectiveLineHistoryData (objectiveLineId, objectiveLineAsset.getCategory()

Method ObjectiveLineHistoryData.

Parameters:
objectiveLineId objectiveLineId
objectiveLineAsset.getCategory( objectiveLineAsset.getCategory(

canPlayerDoObjectiveLine

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

Method canPlayerDoObjectiveLine.

Parameters:
@Nonnull final Player player
@Nonnull final String objectiveLineId

objectiveCompleted

public void objectiveCompleted (@Nonnull final Objective objective, @Nonnull final Store store)

Method objectiveCompleted.

Parameters:
@Nonnull final Objective objective
@Nonnull final Store store

storeObjectiveHistoryData

public void storeObjectiveHistoryData (@Nonnull final Objective objective)

Method storeObjectiveHistoryData.

Parameters:
@Nonnull final Objective objective

storeObjectiveLineHistoryData

public void storeObjectiveLineHistoryData (@Nonnull final ObjectiveLineHistoryData objectiveLineHistoryData, @Nonnull final Set playerUUIDs)

Method storeObjectiveLineHistoryData.

Parameters:
@Nonnull final ObjectiveLineHistoryData objectiveLineHistoryData
@Nonnull final Set playerUUIDs

cancelObjective

public void cancelObjective (@Nonnull final UUID objectiveUUID, @Nonnull final Store store)

Method cancelObjective.

Parameters:
@Nonnull final UUID objectiveUUID
@Nonnull final Store store

untrackObjectiveForPlayer

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

Method untrackObjectiveForPlayer.

Parameters:
@Nonnull final Objective objective
@Nonnull final UUID playerUUID

UntrackObjective

public new UntrackObjective (objectiveUUID)

Method UntrackObjective.

Parameters:
objectiveUUID objectiveUUID

addPlayerToExistingObjective

public void addPlayerToExistingObjective (@Nonnull final Store store, @Nonnull final UUID playerUUID, @Nonnull final UUID objectiveUUID)

Method addPlayerToExistingObjective.

Parameters:
@Nonnull final Store store
@Nonnull final UUID playerUUID
@Nonnull final UUID objectiveUUID

removePlayerFromExistingObjective

public void removePlayerFromExistingObjective (@Nonnull final Store store, @Nonnull final UUID playerUUID, @Nonnull final UUID objectiveUUID)

Method removePlayerFromExistingObjective.

Parameters:
@Nonnull final Store store
@Nonnull final UUID playerUUID
@Nonnull final UUID objectiveUUID

onPlayerDisconnect

private void onPlayerDisconnect (@Nonnull final PlayerDisconnectEvent event)

Method onPlayerDisconnect.

Parameters:
@Nonnull final PlayerDisconnectEvent event

onObjectiveLineAssetLoaded

private void onObjectiveLineAssetLoaded (@Nonnull final LoadedAssetsEvent> event)

Method onObjectiveLineAssetLoaded.

Parameters:
@Nonnull final LoadedAssetsEvent> event

onObjectiveAssetLoaded

private void onObjectiveAssetLoaded (@Nonnull final LoadedAssetsEvent> event)

Method onObjectiveAssetLoaded.

Parameters:
@Nonnull final LoadedAssetsEvent> event

onObjectiveLocationMarkerChange

static void onObjectiveLocationMarkerChange (@Nonnull final LoadedAssetsEvent> event)

Method onObjectiveLocationMarkerChange.

Parameters:
@Nonnull final LoadedAssetsEvent> event

Model

public new Model (oldModel.getModelAssetId()

Method Model.

Parameters:
oldModel.getModelAssetId( oldModel.getModelAssetId(

ModelComponent

public new ModelComponent (newModel)

Method ModelComponent.

Parameters:
newModel newModel

onModelAssetChange

private void onModelAssetChange (@Nonnull final LoadedAssetsEvent> event)

Method onModelAssetChange.

Parameters:
@Nonnull final LoadedAssetsEvent> event

onLivingEntityInventoryChange

private void onLivingEntityInventoryChange (@Nonnull final LivingEntityInventoryChangeEvent event)

Method onLivingEntityInventoryChange.

Parameters:
@Nonnull final LivingEntityInventoryChangeEvent event

onWorldAdded

private void onWorldAdded (final AddWorldEvent event)

Method onWorldAdded.

Parameters:
final AddWorldEvent event

getObjectiveDataDump

public String getObjectiveDataDump ()

Method getObjectiveDataDump.

ObjectivePluginConfig

public public ObjectivePluginConfig ()

Method ObjectivePluginConfig.

getDataStoreProvider

public DataStoreProvider getDataStoreProvider ()

Method getDataStoreProvider.