Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- ABANDONED - Enum constant in enum class com.ryankshah.questapi.api.quest.QuestState
- abandonQuest(ServerPlayer, Identifier) - Method in interface com.ryankshah.questapi.api.QuestManager
-
Abandons an
ACTIVEquest, discarding its progress and returning it toAVAILABLE/LOCKED. - abandonQuest(ServerPlayer, Identifier) - Method in class com.ryankshah.questapi.impl.QuestManagerImpl
- ACTIVE - Enum constant in enum class com.ryankshah.questapi.api.quest.QuestState
- AdvancementCondition - Class in com.ryankshah.questapi.api.quest.condition.impl
-
Requires the player to have completed a specific vanilla or datapack advancement.
- AdvancementCondition(Identifier) - Constructor for class com.ryankshah.questapi.api.quest.condition.impl.AdvancementCondition
- advancementId() - Method in class com.ryankshah.questapi.api.quest.condition.impl.AdvancementCondition
- advancementId() - Method in class com.ryankshah.questapi.api.quest.reward.impl.AdvancementReward
- AdvancementReward - Class in com.ryankshah.questapi.api.quest.reward.impl
-
Grants a specific vanilla or datapack advancement to the player, by awarding every one of its criteria - a single
PlayerAdvancements.award(AdvancementHolder, String)call only satisfies one criterion, so an advancement with several needs all of them awarded to actually complete. - AdvancementReward(Identifier) - Constructor for class com.ryankshah.questapi.api.quest.reward.impl.AdvancementReward
- amount() - Method in record class com.ryankshah.questapi.impl.network.payload.ServerboundDeliverItemsPayload
-
Returns the value of the
amountrecord component. - AnyOfCondition - Class in com.ryankshah.questapi.api.quest.condition.impl
-
Passes if any of its wrapped conditions pass, unlike a quest's top-level prerequisite list which requires all of them.
- AnyOfCondition(List) - Constructor for class com.ryankshah.questapi.api.quest.condition.impl.AnyOfCondition
- apply(QuestDataLoader.RawData, ResourceManager, ProfilerFiller) - Method in class com.ryankshah.questapi.impl.data.QuestDataLoader
- attachServer(MinecraftServer) - Method in interface com.ryankshah.questapi.api.QuestManager
-
Binds this manager to a running server so it can access world-backed persistence.
- attachServer(MinecraftServer) - Method in class com.ryankshah.questapi.impl.QuestManagerImpl
- autoActivate() - Method in class com.ryankshah.questapi.api.quest.Quest
-
If
true, this quest skips theAVAILABLEstate and becomesACTIVEthe moment its prerequisites are satisfied, without requiring the player to manually start it. - autoActivate(boolean) - Method in class com.ryankshah.questapi.api.quest.Quest.Builder
- AVAILABLE - Enum constant in enum class com.ryankshah.questapi.api.quest.QuestState
B
- baseline() - Method in class com.ryankshah.questapi.api.quest.objective.ObjectiveProgress
- biome() - Method in class com.ryankshah.questapi.api.quest.condition.impl.BiomeCondition
- BiomeCondition - Class in com.ryankshah.questapi.api.quest.condition.impl
-
Requires the player to currently be standing in a specific biome.
- BiomeCondition(ResourceKey) - Constructor for class com.ryankshah.questapi.api.quest.condition.impl.BiomeCondition
- block() - Method in class com.ryankshah.questapi.api.quest.objective.impl.MineBlockObjective
- block() - Method in class com.ryankshah.questapi.api.quest.objective.impl.PlaceBlockObjective
- BLOCK_PLACED - Static variable in class com.ryankshah.questapi.api.quest.objective.ObjectiveEventKeys
-
Fired when a player places a block.
- bootstrap() - Static method in class com.ryankshah.questapi.QuestApi
-
Called once by each loader's common init hook, before any mod registers its own quests.
- BreedAnimalsObjective - Class in com.ryankshah.questapi.api.quest.objective.impl
-
Poll-based objective tracking the vanilla
minecraft:animals_bredcustom statistic, relative to a baseline captured when the quest became active. - BreedAnimalsObjective(int) - Constructor for class com.ryankshah.questapi.api.quest.objective.impl.BreedAnimalsObjective
- build() - Method in class com.ryankshah.questapi.api.quest.Quest.Builder
- builder(Identifier) - Static method in class com.ryankshah.questapi.api.quest.Quest
- BuiltinContent - Class in com.ryankshah.questapi.impl
-
Registers every objective/reward/condition type that ships with the core API itself.
C
- captureBaseline(QuestContext) - Method in class com.ryankshah.questapi.api.quest.objective.impl.BreedAnimalsObjective
- captureBaseline(QuestContext) - Method in class com.ryankshah.questapi.api.quest.objective.impl.ConsumeItemObjective
- captureBaseline(QuestContext) - Method in class com.ryankshah.questapi.api.quest.objective.impl.CraftItemObjective
- captureBaseline(QuestContext) - Method in class com.ryankshah.questapi.api.quest.objective.impl.FishObjective
- captureBaseline(QuestContext) - Method in class com.ryankshah.questapi.api.quest.objective.impl.KillEntityObjective
- captureBaseline(QuestContext) - Method in class com.ryankshah.questapi.api.quest.objective.impl.MineBlockObjective
- captureBaseline(QuestContext) - Method in interface com.ryankshah.questapi.api.quest.objective.ObjectiveDefinition
-
Called once when the objective's quest becomes
ACTIVE. - categories() - Method in interface com.ryankshah.questapi.api.QuestRegistry
- categories() - Method in class com.ryankshah.questapi.client.ClientQuestDataCache
- categories() - Method in record class com.ryankshah.questapi.impl.data.QuestDataLoader.RawData
-
Returns the value of the
categoriesrecord component. - categories() - Method in record class com.ryankshah.questapi.impl.network.payload.ClientboundSyncDefinitionsPayload
-
Returns the value of the
categoriesrecord component. - categories() - Method in class com.ryankshah.questapi.impl.QuestRegistryImpl
- category() - Method in class com.ryankshah.questapi.client.gui.CategoryListEntry
- category(Identifier) - Method in class com.ryankshah.questapi.api.quest.Quest.Builder
- CATEGORY_COMBAT - Static variable in class com.ryankshah.questapi.example.ExampleQuests
- CATEGORY_DIAMONDS - Static variable in class com.ryankshah.questapi.example.ExampleQuests
- CATEGORY_EXPLORATION - Static variable in class com.ryankshah.questapi.example.ExampleQuests
- CATEGORY_FARM_AND_SEA - Static variable in class com.ryankshah.questapi.example.ExampleQuests
- CATEGORY_GETTING_STARTED - Static variable in class com.ryankshah.questapi.example.ExampleQuests
- CATEGORY_WORLD_EVENTS - Static variable in class com.ryankshah.questapi.example.ExampleQuests
- categoryId() - Method in class com.ryankshah.questapi.api.quest.Quest
- CategoryListEntry - Class in com.ryankshah.questapi.client.gui
-
A single entry in the
CategoryListWidgetsidebar. - CategoryListEntry(QuestCategory, boolean) - Constructor for class com.ryankshah.questapi.client.gui.CategoryListEntry
- CategoryListWidget - Class in com.ryankshah.questapi.client.gui
-
Scrollable sidebar of quest categories, replacing a fixed row of tabs so it never overflows the panel regardless of how many categories are registered.
- CategoryListWidget(Minecraft, int, int, int, int, Consumer) - Constructor for class com.ryankshah.questapi.client.gui.CategoryListWidget
- claimRewards(ServerPlayer, Identifier) - Method in interface com.ryankshah.questapi.api.QuestManager
-
Claims the rewards of a
COMPLETEDquest, granting everyQuestRewardexactly once and transitioning the quest toREWARDED. - claimRewards(ServerPlayer, Identifier) - Method in class com.ryankshah.questapi.impl.QuestManagerImpl
- clear() - Method in class com.ryankshah.questapi.client.ClientQuestDataCache
- CLEAR - Enum constant in enum class com.ryankshah.questapi.api.quest.condition.impl.WeatherCondition.WeatherType
- clearQuests() - Method in interface com.ryankshah.questapi.api.QuestRegistry
-
Removes every registered quest and category.
- clearQuests() - Method in class com.ryankshah.questapi.impl.QuestRegistryImpl
- ClientboundQuestCompletedPayload - Record Class in com.ryankshah.questapi.impl.network.payload
-
Sent to a client the moment one of their quests becomes
COMPLETED, purely to drive the completion sound and toast - separate fromClientboundSyncProgressPayloadso the GUI's progress cache and the one-shot feedback effect stay independent concerns. - ClientboundQuestCompletedPayload(Component) - Constructor for record class com.ryankshah.questapi.impl.network.payload.ClientboundQuestCompletedPayload
-
Creates an instance of a
ClientboundQuestCompletedPayloadrecord class. - ClientboundQuestUnlockedPayload - Record Class in com.ryankshah.questapi.impl.network.payload
-
Sent to a client the moment one of their quests becomes visible to them for the first time - newly
AVAILABLE, or straight toACTIVEfor anautoActivatequest - purely to drive a "new quest" sound and toast, separate fromClientboundSyncProgressPayload. - ClientboundQuestUnlockedPayload(Component) - Constructor for record class com.ryankshah.questapi.impl.network.payload.ClientboundQuestUnlockedPayload
-
Creates an instance of a
ClientboundQuestUnlockedPayloadrecord class. - ClientboundSyncDefinitionsPayload - Record Class in com.ryankshah.questapi.impl.network.payload
-
Sent to a client once, right after login (and again if dev-mode reloads quest definitions), carrying every registered category and quest definition so the default GUI never needs to ask the server for static content while it is open.
- ClientboundSyncDefinitionsPayload(List, List) - Constructor for record class com.ryankshah.questapi.impl.network.payload.ClientboundSyncDefinitionsPayload
-
Creates an instance of a
ClientboundSyncDefinitionsPayloadrecord class. - ClientboundSyncProgressPayload - Record Class in com.ryankshah.questapi.impl.network.payload
-
Sent to a client whenever their own quest progress changes server-side (login, objective progress, completion, reward claim, reset, ...), carrying a full snapshot of their
PlayerQuestData. - ClientboundSyncProgressPayload(PlayerQuestData) - Constructor for record class com.ryankshah.questapi.impl.network.payload.ClientboundSyncProgressPayload
-
Creates an instance of a
ClientboundSyncProgressPayloadrecord class. - ClientQuestDataCache - Class in com.ryankshah.questapi.client
-
Client-side cache of the last data synced from the server.
- ClientQuestNetworking - Class in com.ryankshah.questapi.client.network
-
Client-side packet handling logic and outgoing request helpers, shared by both loaders.
- codec() - Method in record class com.ryankshah.questapi.api.quest.condition.ConditionType
-
Returns the value of the
codecrecord component. - codec() - Method in record class com.ryankshah.questapi.api.quest.objective.ObjectiveType
-
Returns the value of the
codecrecord component. - codec() - Method in record class com.ryankshah.questapi.api.quest.reward.RewardType
-
Returns the value of the
codecrecord component. - codec(QuestRegistry) - Static method in class com.ryankshah.questapi.api.quest.condition.impl.AnyOfCondition
- CODEC - Static variable in class com.ryankshah.questapi.api.quest.condition.impl.AdvancementCondition
- CODEC - Static variable in class com.ryankshah.questapi.api.quest.condition.impl.BiomeCondition
- CODEC - Static variable in class com.ryankshah.questapi.api.quest.condition.impl.ExperienceLevelCondition
- CODEC - Static variable in class com.ryankshah.questapi.api.quest.condition.impl.ItemPossessionCondition
- CODEC - Static variable in class com.ryankshah.questapi.api.quest.condition.impl.QuestCompletedCondition
- CODEC - Static variable in class com.ryankshah.questapi.api.quest.condition.impl.TimeOfDayCondition
- CODEC - Static variable in class com.ryankshah.questapi.api.quest.condition.impl.WeatherCondition
- CODEC - Static variable in class com.ryankshah.questapi.api.quest.objective.impl.BreedAnimalsObjective
- CODEC - Static variable in class com.ryankshah.questapi.api.quest.objective.impl.CollectItemObjective
- CODEC - Static variable in class com.ryankshah.questapi.api.quest.objective.impl.ConsumeItemObjective
- CODEC - Static variable in class com.ryankshah.questapi.api.quest.objective.impl.CraftItemObjective
- CODEC - Static variable in class com.ryankshah.questapi.api.quest.objective.impl.DeliverItemObjective
- CODEC - Static variable in class com.ryankshah.questapi.api.quest.objective.impl.FishObjective
- CODEC - Static variable in class com.ryankshah.questapi.api.quest.objective.impl.KillEntityObjective
- CODEC - Static variable in class com.ryankshah.questapi.api.quest.objective.impl.MineBlockObjective
- CODEC - Static variable in class com.ryankshah.questapi.api.quest.objective.impl.PlaceBlockObjective
- CODEC - Static variable in class com.ryankshah.questapi.api.quest.objective.impl.TameEntityObjective
- CODEC - Static variable in class com.ryankshah.questapi.api.quest.objective.impl.VisitDimensionObjective
- CODEC - Static variable in class com.ryankshah.questapi.api.quest.objective.impl.VisitLocationObjective
- CODEC - Static variable in class com.ryankshah.questapi.api.quest.objective.ObjectiveProgress
- CODEC - Static variable in class com.ryankshah.questapi.api.quest.PlayerQuestData
- CODEC - Static variable in record class com.ryankshah.questapi.api.quest.QuestCategory
- CODEC - Static variable in class com.ryankshah.questapi.api.quest.QuestProgress
- CODEC - Static variable in class com.ryankshah.questapi.api.quest.reward.impl.AdvancementReward
- CODEC - Static variable in class com.ryankshah.questapi.api.quest.reward.impl.CommandReward
- CODEC - Static variable in class com.ryankshah.questapi.api.quest.reward.impl.EffectReward
- CODEC - Static variable in class com.ryankshah.questapi.api.quest.reward.impl.ExperienceReward
- CODEC - Static variable in class com.ryankshah.questapi.api.quest.reward.impl.ItemReward
- CODEC - Static variable in class com.ryankshah.questapi.impl.persistence.QuestSavedData
- CollectItemObjective - Class in com.ryankshah.questapi.api.quest.objective.impl
-
Poll-based objective satisfied while the player currently possesses at least
targetAmountof a given item, summed across their entire inventory (main, offhand and armor slots). - CollectItemObjective(Item, int) - Constructor for class com.ryankshah.questapi.api.quest.objective.impl.CollectItemObjective
- com.ryankshah.questapi - package com.ryankshah.questapi
- com.ryankshah.questapi.api - package com.ryankshah.questapi.api
- com.ryankshah.questapi.api.quest - package com.ryankshah.questapi.api.quest
- com.ryankshah.questapi.api.quest.condition - package com.ryankshah.questapi.api.quest.condition
- com.ryankshah.questapi.api.quest.condition.impl - package com.ryankshah.questapi.api.quest.condition.impl
- com.ryankshah.questapi.api.quest.event - package com.ryankshah.questapi.api.quest.event
- com.ryankshah.questapi.api.quest.objective - package com.ryankshah.questapi.api.quest.objective
- com.ryankshah.questapi.api.quest.objective.impl - package com.ryankshah.questapi.api.quest.objective.impl
- com.ryankshah.questapi.api.quest.reward - package com.ryankshah.questapi.api.quest.reward
- com.ryankshah.questapi.api.quest.reward.impl - package com.ryankshah.questapi.api.quest.reward.impl
- com.ryankshah.questapi.client - package com.ryankshah.questapi.client
- com.ryankshah.questapi.client.gui - package com.ryankshah.questapi.client.gui
- com.ryankshah.questapi.client.network - package com.ryankshah.questapi.client.network
- com.ryankshah.questapi.command - package com.ryankshah.questapi.command
- com.ryankshah.questapi.example - package com.ryankshah.questapi.example
- com.ryankshah.questapi.impl - package com.ryankshah.questapi.impl
- com.ryankshah.questapi.impl.data - package com.ryankshah.questapi.impl.data
- com.ryankshah.questapi.impl.network - package com.ryankshah.questapi.impl.network
- com.ryankshah.questapi.impl.network.payload - package com.ryankshah.questapi.impl.network.payload
- com.ryankshah.questapi.impl.persistence - package com.ryankshah.questapi.impl.persistence
- com.ryankshah.questapi.mixin - package com.ryankshah.questapi.mixin
- com.ryankshah.questapi.platform - package com.ryankshah.questapi.platform
- com.ryankshah.questapi.platform.services - package com.ryankshah.questapi.platform.services
- CommandReward - Class in com.ryankshah.questapi.api.quest.reward.impl
-
Executes a command as the rewarded player, e.g.
- CommandReward(String) - Constructor for class com.ryankshah.questapi.api.quest.reward.impl.CommandReward
- complete() - Method in class com.ryankshah.questapi.api.quest.objective.ObjectiveProgress
- COMPLETED - Enum constant in enum class com.ryankshah.questapi.api.quest.QuestState
- completedAt() - Method in class com.ryankshah.questapi.api.quest.QuestProgress
- conditionCodec() - Method in interface com.ryankshah.questapi.api.QuestRegistry
-
A
Codecthat dispatches on a condition's registered type, resolving nested conditions by type ID exactly likeQuest's own prerequisite list does. - conditionCodec(QuestRegistry) - Static method in class com.ryankshah.questapi.impl.network.QuestCodecs
- conditions() - Method in class com.ryankshah.questapi.api.quest.condition.impl.AnyOfCondition
- ConditionType<C> - Record Class in com.ryankshah.questapi.api.quest.condition
-
A registered kind of condition, pairing its identifier with the
MapCodecused to (de)serialize instances of this type. - ConditionType(Identifier, MapCodec) - Constructor for record class com.ryankshah.questapi.api.quest.condition.ConditionType
-
Creates an instance of a
ConditionTyperecord class. - ConsumeItemObjective - Class in com.ryankshah.questapi.api.quest.objective.impl
-
Poll-based objective tracking the vanilla
Stats.ITEM_USEDstatistic for a specific item, relative to a baseline captured when the quest became active. - ConsumeItemObjective(Item, int) - Constructor for class com.ryankshah.questapi.api.quest.objective.impl.ConsumeItemObjective
- copy() - Method in class com.ryankshah.questapi.api.quest.objective.ObjectiveProgress
- copy() - Method in class com.ryankshah.questapi.api.quest.PlayerQuestData
-
Deep copy, safe to hand to something that will read it later (or on another thread) without racing further mutations - e.g.
- copy() - Method in class com.ryankshah.questapi.api.quest.QuestProgress
-
Deep copy, safe to hand to something that will read it later (or on another thread) without racing further mutations - e.g.
- CraftItemObjective - Class in com.ryankshah.questapi.api.quest.objective.impl
-
Poll-based objective tracking the vanilla
Stats.ITEM_CRAFTEDstatistic for a specific item, relative to a baseline captured when the quest became active. - CraftItemObjective(Item, int) - Constructor for class com.ryankshah.questapi.api.quest.objective.impl.CraftItemObjective
- current() - Method in class com.ryankshah.questapi.api.quest.objective.ObjectiveProgress
D
- data() - Method in record class com.ryankshah.questapi.impl.network.payload.ClientboundSyncProgressPayload
-
Returns the value of the
datarecord component. - dataFor(ServerPlayer) - Method in interface com.ryankshah.questapi.api.QuestManager
- dataFor(ServerPlayer) - Method in class com.ryankshah.questapi.impl.QuestManagerImpl
- defaultResetMode() - Static method in class com.ryankshah.questapi.impl.DevConfig
-
The reset mode a repeatable quest resolves to when it does not specify its own via
Quest.Builder#repeatable(ResetMode, int). - DeliverItemObjective - Class in com.ryankshah.questapi.api.quest.objective.impl
-
Push-based objective completed by explicitly delivering (surrendering) items to the quest via the default GUI's "deliver" action or the
/quests delivercommand, rather than merely holding them. - DeliverItemObjective(Item, int) - Constructor for class com.ryankshah.questapi.api.quest.objective.impl.DeliverItemObjective
- deliverItems(ServerPlayer, Identifier, int, int) - Method in interface com.ryankshah.questapi.api.QuestManager
-
Removes
amountmatching items from the player's inventory and reports them delivered to the given quest objective. - deliverItems(ServerPlayer, Identifier, int, int) - Method in class com.ryankshah.questapi.impl.QuestManagerImpl
- describe() - Method in class com.ryankshah.questapi.api.quest.condition.impl.AdvancementCondition
- describe() - Method in class com.ryankshah.questapi.api.quest.condition.impl.AnyOfCondition
- describe() - Method in class com.ryankshah.questapi.api.quest.condition.impl.BiomeCondition
- describe() - Method in class com.ryankshah.questapi.api.quest.condition.impl.ExperienceLevelCondition
- describe() - Method in class com.ryankshah.questapi.api.quest.condition.impl.ItemPossessionCondition
- describe() - Method in class com.ryankshah.questapi.api.quest.condition.impl.QuestCompletedCondition
- describe() - Method in class com.ryankshah.questapi.api.quest.condition.impl.TimeOfDayCondition
- describe() - Method in class com.ryankshah.questapi.api.quest.condition.impl.WeatherCondition
- describe() - Method in interface com.ryankshah.questapi.api.quest.condition.QuestCondition
-
Short human-readable description shown in the GUI while the quest is locked, e.g.
- describe() - Method in class com.ryankshah.questapi.api.quest.objective.impl.BreedAnimalsObjective
- describe() - Method in class com.ryankshah.questapi.api.quest.objective.impl.CollectItemObjective
- describe() - Method in class com.ryankshah.questapi.api.quest.objective.impl.ConsumeItemObjective
- describe() - Method in class com.ryankshah.questapi.api.quest.objective.impl.CraftItemObjective
- describe() - Method in class com.ryankshah.questapi.api.quest.objective.impl.DeliverItemObjective
- describe() - Method in class com.ryankshah.questapi.api.quest.objective.impl.FishObjective
- describe() - Method in class com.ryankshah.questapi.api.quest.objective.impl.KillEntityObjective
- describe() - Method in class com.ryankshah.questapi.api.quest.objective.impl.MineBlockObjective
- describe() - Method in class com.ryankshah.questapi.api.quest.objective.impl.PlaceBlockObjective
- describe() - Method in class com.ryankshah.questapi.api.quest.objective.impl.TameEntityObjective
- describe() - Method in class com.ryankshah.questapi.api.quest.objective.impl.VisitDimensionObjective
- describe() - Method in class com.ryankshah.questapi.api.quest.objective.impl.VisitLocationObjective
- describe() - Method in interface com.ryankshah.questapi.api.quest.objective.ObjectiveDefinition
-
Human-readable description of the objective, e.g.
- describe() - Method in class com.ryankshah.questapi.api.quest.reward.impl.AdvancementReward
- describe() - Method in class com.ryankshah.questapi.api.quest.reward.impl.CommandReward
- describe() - Method in class com.ryankshah.questapi.api.quest.reward.impl.EffectReward
- describe() - Method in class com.ryankshah.questapi.api.quest.reward.impl.ExperienceReward
- describe() - Method in class com.ryankshah.questapi.api.quest.reward.impl.ItemReward
- describe() - Method in interface com.ryankshah.questapi.api.quest.reward.QuestReward
-
Human-readable description shown in the rewards panel, e.g.
- description() - Method in class com.ryankshah.questapi.api.quest.Quest
- description(Component) - Method in class com.ryankshah.questapi.api.quest.Quest.Builder
- detachServer() - Method in interface com.ryankshah.questapi.api.QuestManager
-
Unbinds this manager from the server.
- detachServer() - Method in class com.ryankshah.questapi.impl.QuestManagerImpl
- DevConfig - Class in com.ryankshah.questapi.impl
-
Smallest-sensible development configuration mechanism, shared by both loaders.
- dimensionId() - Method in class com.ryankshah.questapi.api.quest.objective.impl.VisitDimensionObjective
- displayName() - Method in record class com.ryankshah.questapi.api.quest.QuestCategory
-
Returns the value of the
displayNamerecord component.
E
- EffectReward - Class in com.ryankshah.questapi.api.quest.reward.impl
-
Applies a potion/mob effect to the player.
- EffectReward(Holder, int, int) - Constructor for class com.ryankshah.questapi.api.quest.reward.impl.EffectReward
- empty() - Static method in class com.ryankshah.questapi.api.quest.objective.ObjectiveProgress
- empty(UUID) - Static method in class com.ryankshah.questapi.api.quest.PlayerQuestData
- ENTITY_TAMED - Static variable in class com.ryankshah.questapi.api.quest.objective.ObjectiveEventKeys
-
Fired when a player tames an animal.
- entityType() - Method in class com.ryankshah.questapi.api.quest.objective.impl.KillEntityObjective
- equals(Object) - Method in record class com.ryankshah.questapi.api.quest.condition.ConditionType
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.ryankshah.questapi.api.quest.objective.ObjectiveType
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.ryankshah.questapi.api.quest.QuestCategory
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.ryankshah.questapi.api.quest.QuestContext
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.ryankshah.questapi.api.quest.reward.RewardType
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.ryankshah.questapi.impl.data.QuestDataLoader.RawData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.ryankshah.questapi.impl.network.payload.ClientboundQuestCompletedPayload
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.ryankshah.questapi.impl.network.payload.ClientboundQuestUnlockedPayload
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.ryankshah.questapi.impl.network.payload.ClientboundSyncDefinitionsPayload
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.ryankshah.questapi.impl.network.payload.ClientboundSyncProgressPayload
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.ryankshah.questapi.impl.network.payload.ServerboundAbandonQuestPayload
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.ryankshah.questapi.impl.network.payload.ServerboundClaimRewardPayload
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.ryankshah.questapi.impl.network.payload.ServerboundDeliverItemsPayload
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.ryankshah.questapi.impl.network.payload.ServerboundRequestSyncPayload
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.ryankshah.questapi.impl.network.payload.ServerboundStartQuestPayload
-
Indicates whether some other object is "equal to" this one.
- evaluate(QuestContext, ObjectiveProgress, Identifier, int) - Method in class com.ryankshah.questapi.api.quest.objective.impl.BreedAnimalsObjective
- evaluate(QuestContext, ObjectiveProgress, Identifier, int) - Method in class com.ryankshah.questapi.api.quest.objective.impl.CollectItemObjective
- evaluate(QuestContext, ObjectiveProgress, Identifier, int) - Method in class com.ryankshah.questapi.api.quest.objective.impl.ConsumeItemObjective
- evaluate(QuestContext, ObjectiveProgress, Identifier, int) - Method in class com.ryankshah.questapi.api.quest.objective.impl.CraftItemObjective
- evaluate(QuestContext, ObjectiveProgress, Identifier, int) - Method in class com.ryankshah.questapi.api.quest.objective.impl.DeliverItemObjective
- evaluate(QuestContext, ObjectiveProgress, Identifier, int) - Method in class com.ryankshah.questapi.api.quest.objective.impl.FishObjective
- evaluate(QuestContext, ObjectiveProgress, Identifier, int) - Method in class com.ryankshah.questapi.api.quest.objective.impl.KillEntityObjective
- evaluate(QuestContext, ObjectiveProgress, Identifier, int) - Method in class com.ryankshah.questapi.api.quest.objective.impl.MineBlockObjective
- evaluate(QuestContext, ObjectiveProgress, Identifier, int) - Method in class com.ryankshah.questapi.api.quest.objective.impl.PlaceBlockObjective
- evaluate(QuestContext, ObjectiveProgress, Identifier, int) - Method in class com.ryankshah.questapi.api.quest.objective.impl.TameEntityObjective
- evaluate(QuestContext, ObjectiveProgress, Identifier, int) - Method in class com.ryankshah.questapi.api.quest.objective.impl.VisitDimensionObjective
- evaluate(QuestContext, ObjectiveProgress, Identifier, int) - Method in class com.ryankshah.questapi.api.quest.objective.impl.VisitLocationObjective
- evaluate(QuestContext, ObjectiveProgress, Identifier, int) - Method in interface com.ryankshah.questapi.api.quest.objective.ObjectiveDefinition
-
Computes the new absolute progress amount for this objective.
- ExampleQuests - Class in com.ryankshah.questapi.example
-
Example quest tree registered only when
DevConfig.isDevMode()istrue. - ExperienceLevelCondition - Class in com.ryankshah.questapi.api.quest.condition.impl
-
Requires the player to be at least a given experience level.
- ExperienceLevelCondition(int) - Constructor for class com.ryankshah.questapi.api.quest.condition.impl.ExperienceLevelCondition
- ExperienceReward - Class in com.ryankshah.questapi.api.quest.reward.impl
-
Grants experience points to the player.
- ExperienceReward(int) - Constructor for class com.ryankshah.questapi.api.quest.reward.impl.ExperienceReward
- extractContent(GuiGraphicsExtractor, int, int, boolean, float) - Method in class com.ryankshah.questapi.client.gui.CategoryListEntry
- extractContent(GuiGraphicsExtractor, int, int, boolean, float) - Method in class com.ryankshah.questapi.client.gui.QuestListEntry
- extractListBackground(GuiGraphicsExtractor) - Method in class com.ryankshah.questapi.client.gui.CategoryListWidget
- extractListBackground(GuiGraphicsExtractor) - Method in class com.ryankshah.questapi.client.gui.QuestListWidget
- extractListSeparators(GuiGraphicsExtractor) - Method in class com.ryankshah.questapi.client.gui.CategoryListWidget
- extractListSeparators(GuiGraphicsExtractor) - Method in class com.ryankshah.questapi.client.gui.QuestListWidget
- extractRenderState(GuiGraphicsExtractor, int, int, float) - Method in class com.ryankshah.questapi.client.gui.QuestScreen
F
- finalizeAndRegister() - Method in class com.ryankshah.questapi.impl.data.QuestDataLoader
-
Decodes whatever the most recent reload produced and (re)registers it, replacing whatever this loader registered last time.
- FishObjective - Class in com.ryankshah.questapi.api.quest.objective.impl
-
Poll-based objective tracking the vanilla
minecraft:fish_caughtcustom statistic, relative to a baseline captured when the quest became active. - FishObjective(int) - Constructor for class com.ryankshah.questapi.api.quest.objective.impl.FishObjective
G
- get(Identifier) - Method in class com.ryankshah.questapi.api.quest.PlayerQuestData
- getCategory(Identifier) - Method in interface com.ryankshah.questapi.api.QuestRegistry
- getCategory(Identifier) - Method in class com.ryankshah.questapi.impl.QuestRegistryImpl
- getConditionType(Identifier) - Method in interface com.ryankshah.questapi.api.QuestRegistry
- getConditionType(Identifier) - Method in class com.ryankshah.questapi.impl.QuestRegistryImpl
- getConfigDirectory() - Method in interface com.ryankshah.questapi.platform.services.IPlatformHelper
-
The loader's shared configuration directory (e.g.
- getEnvironmentName() - Method in interface com.ryankshah.questapi.platform.services.IPlatformHelper
- getNarration() - Method in class com.ryankshah.questapi.client.gui.CategoryListEntry
- getNarration() - Method in class com.ryankshah.questapi.client.gui.QuestListEntry
- getObjectiveType(Identifier) - Method in interface com.ryankshah.questapi.api.QuestRegistry
- getObjectiveType(Identifier) - Method in class com.ryankshah.questapi.impl.QuestRegistryImpl
- getOrCreate(UUID) - Method in class com.ryankshah.questapi.impl.persistence.QuestSavedData
- getOrCreate(Identifier) - Method in class com.ryankshah.questapi.api.quest.PlayerQuestData
- getPlatformName() - Method in interface com.ryankshah.questapi.platform.services.IPlatformHelper
-
Gets the name of the current platform.
- getProgress(Identifier) - Method in class com.ryankshah.questapi.client.ClientQuestDataCache
- getProgress(ServerPlayer, Identifier) - Method in interface com.ryankshah.questapi.api.QuestManager
- getProgress(ServerPlayer, Identifier) - Method in class com.ryankshah.questapi.impl.QuestManagerImpl
- getQuest(Identifier) - Method in interface com.ryankshah.questapi.api.QuestRegistry
- getQuest(Identifier) - Method in class com.ryankshah.questapi.client.ClientQuestDataCache
- getQuest(Identifier) - Method in class com.ryankshah.questapi.impl.QuestRegistryImpl
- getRewardType(Identifier) - Method in interface com.ryankshah.questapi.api.QuestRegistry
- getRewardType(Identifier) - Method in class com.ryankshah.questapi.impl.QuestRegistryImpl
- getRowWidth() - Method in class com.ryankshah.questapi.client.gui.CategoryListWidget
- getRowWidth() - Method in class com.ryankshah.questapi.client.gui.QuestListWidget
- getState(Identifier) - Method in class com.ryankshah.questapi.client.ClientQuestDataCache
- getState(ServerPlayer, Identifier) - Method in interface com.ryankshah.questapi.api.QuestManager
-
Returns the current lifecycle state of a quest for a player.
- getState(ServerPlayer, Identifier) - Method in class com.ryankshah.questapi.impl.QuestManagerImpl
- grant(QuestContext) - Method in class com.ryankshah.questapi.api.quest.reward.impl.AdvancementReward
- grant(QuestContext) - Method in class com.ryankshah.questapi.api.quest.reward.impl.CommandReward
- grant(QuestContext) - Method in class com.ryankshah.questapi.api.quest.reward.impl.EffectReward
- grant(QuestContext) - Method in class com.ryankshah.questapi.api.quest.reward.impl.ExperienceReward
- grant(QuestContext) - Method in class com.ryankshah.questapi.api.quest.reward.impl.ItemReward
- grant(QuestContext) - Method in interface com.ryankshah.questapi.api.quest.reward.QuestReward
-
Grants this reward to the player.
H
- handleAbandonQuest(ServerPlayer, Identifier) - Static method in class com.ryankshah.questapi.impl.network.QuestNetworking
- handleClaimReward(ServerPlayer, Identifier) - Static method in class com.ryankshah.questapi.impl.network.QuestNetworking
- handleDeliverItems(ServerPlayer, Identifier, int, int) - Static method in class com.ryankshah.questapi.impl.network.QuestNetworking
- handleQuestCompleted(Component) - Static method in class com.ryankshah.questapi.client.network.ClientQuestNetworking
- handleQuestUnlocked(Component) - Static method in class com.ryankshah.questapi.client.network.ClientQuestNetworking
- handleRequestSync(ServerPlayer) - Static method in class com.ryankshah.questapi.impl.network.QuestNetworking
- handleStartQuest(ServerPlayer, Identifier) - Static method in class com.ryankshah.questapi.impl.network.QuestNetworking
- handleSyncDefinitions(List, List) - Static method in class com.ryankshah.questapi.client.network.ClientQuestNetworking
- handleSyncProgress(PlayerQuestData) - Static method in class com.ryankshah.questapi.client.network.ClientQuestNetworking
- hasData() - Method in class com.ryankshah.questapi.client.ClientQuestDataCache
- hashCode() - Method in record class com.ryankshah.questapi.api.quest.condition.ConditionType
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.ryankshah.questapi.api.quest.objective.ObjectiveType
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.ryankshah.questapi.api.quest.QuestCategory
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.ryankshah.questapi.api.quest.QuestContext
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.ryankshah.questapi.api.quest.reward.RewardType
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.ryankshah.questapi.impl.data.QuestDataLoader.RawData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.ryankshah.questapi.impl.network.payload.ClientboundQuestCompletedPayload
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.ryankshah.questapi.impl.network.payload.ClientboundQuestUnlockedPayload
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.ryankshah.questapi.impl.network.payload.ClientboundSyncDefinitionsPayload
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.ryankshah.questapi.impl.network.payload.ClientboundSyncProgressPayload
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.ryankshah.questapi.impl.network.payload.ServerboundAbandonQuestPayload
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.ryankshah.questapi.impl.network.payload.ServerboundClaimRewardPayload
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.ryankshah.questapi.impl.network.payload.ServerboundDeliverItemsPayload
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.ryankshah.questapi.impl.network.payload.ServerboundRequestSyncPayload
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.ryankshah.questapi.impl.network.payload.ServerboundStartQuestPayload
-
Returns a hash code value for this object.
I
- icon() - Method in class com.ryankshah.questapi.api.quest.objective.impl.BreedAnimalsObjective
- icon() - Method in class com.ryankshah.questapi.api.quest.objective.impl.CollectItemObjective
- icon() - Method in class com.ryankshah.questapi.api.quest.objective.impl.ConsumeItemObjective
- icon() - Method in class com.ryankshah.questapi.api.quest.objective.impl.CraftItemObjective
- icon() - Method in class com.ryankshah.questapi.api.quest.objective.impl.DeliverItemObjective
- icon() - Method in class com.ryankshah.questapi.api.quest.objective.impl.FishObjective
- icon() - Method in class com.ryankshah.questapi.api.quest.objective.impl.KillEntityObjective
- icon() - Method in class com.ryankshah.questapi.api.quest.objective.impl.MineBlockObjective
- icon() - Method in class com.ryankshah.questapi.api.quest.objective.impl.PlaceBlockObjective
- icon() - Method in class com.ryankshah.questapi.api.quest.objective.impl.TameEntityObjective
- icon() - Method in class com.ryankshah.questapi.api.quest.objective.impl.VisitDimensionObjective
- icon() - Method in class com.ryankshah.questapi.api.quest.objective.impl.VisitLocationObjective
- icon() - Method in interface com.ryankshah.questapi.api.quest.objective.ObjectiveDefinition
-
Icon rendered next to this objective in the default GUI.
- icon() - Method in class com.ryankshah.questapi.api.quest.Quest
- icon() - Method in record class com.ryankshah.questapi.api.quest.QuestCategory
-
Returns the value of the
iconrecord component. - icon() - Method in class com.ryankshah.questapi.api.quest.reward.impl.AdvancementReward
- icon() - Method in class com.ryankshah.questapi.api.quest.reward.impl.CommandReward
- icon() - Method in class com.ryankshah.questapi.api.quest.reward.impl.EffectReward
- icon() - Method in class com.ryankshah.questapi.api.quest.reward.impl.ExperienceReward
- icon() - Method in class com.ryankshah.questapi.api.quest.reward.impl.ItemReward
- icon() - Method in interface com.ryankshah.questapi.api.quest.reward.QuestReward
-
Icon rendered next to this reward in the default GUI.
- icon(ItemStack) - Method in class com.ryankshah.questapi.api.quest.Quest.Builder
- id() - Method in record class com.ryankshah.questapi.api.quest.condition.ConditionType
-
Returns the value of the
idrecord component. - id() - Method in record class com.ryankshah.questapi.api.quest.objective.ObjectiveType
-
Returns the value of the
idrecord component. - id() - Method in class com.ryankshah.questapi.api.quest.Quest
- id() - Method in record class com.ryankshah.questapi.api.quest.QuestCategory
-
Returns the value of the
idrecord component. - id() - Method in record class com.ryankshah.questapi.api.quest.reward.RewardType
-
Returns the value of the
idrecord component. - ID - Static variable in class com.ryankshah.questapi.impl.data.QuestDataLoader
- IN_GAME_DAY - Enum constant in enum class com.ryankshah.questapi.api.quest.ResetMode
-
Resets after a fixed number of in-game days have elapsed since the quest was last claimed, measured against the world's age (total elapsed ticks / 24000).
- INetworkHelper - Interface in com.ryankshah.questapi.platform.services
-
Loader-specific abstraction over sending custom payloads.
- init() - Method in class com.ryankshah.questapi.client.gui.QuestScreen
- INSTANCE - Static variable in class com.ryankshah.questapi.client.ClientQuestDataCache
- IPlatformHelper - Interface in com.ryankshah.questapi.platform.services
- isDevelopmentEnvironment() - Method in interface com.ryankshah.questapi.platform.services.IPlatformHelper
-
Check if the game is currently in a development environment.
- isDevMode() - Static method in class com.ryankshah.questapi.impl.DevConfig
- isModLoaded(String) - Method in interface com.ryankshah.questapi.platform.services.IPlatformHelper
-
Checks if a mod with the given id is loaded.
- isPauseScreen() - Method in class com.ryankshah.questapi.client.gui.QuestScreen
- item() - Method in class com.ryankshah.questapi.api.quest.objective.impl.CollectItemObjective
- item() - Method in class com.ryankshah.questapi.api.quest.objective.impl.ConsumeItemObjective
- item() - Method in class com.ryankshah.questapi.api.quest.objective.impl.CraftItemObjective
- item() - Method in class com.ryankshah.questapi.api.quest.objective.impl.DeliverItemObjective
- ITEM_DELIVERED - Static variable in class com.ryankshah.questapi.api.quest.objective.ObjectiveEventKeys
-
Fired when a player delivers items to a quest via the GUI or a command.
- ItemPossessionCondition - Class in com.ryankshah.questapi.api.quest.condition.impl
-
Requires the player to currently possess at least
amountof a given item, e.g. - ItemPossessionCondition(Item, int) - Constructor for class com.ryankshah.questapi.api.quest.condition.impl.ItemPossessionCondition
- ItemReward - Class in com.ryankshah.questapi.api.quest.reward.impl
-
Grants a stack of items to the player, placed directly in their inventory or dropped at their feet if the inventory is full.
- ItemReward(ItemStack) - Constructor for class com.ryankshah.questapi.api.quest.reward.impl.ItemReward
K
- KillEntityObjective - Class in com.ryankshah.questapi.api.quest.objective.impl
-
Poll-based objective tracking the vanilla
Stats.ENTITY_KILLEDstatistic for a specific entity type, relative to a baseline captured when the quest became active. - KillEntityObjective(EntityType, int) - Constructor for class com.ryankshah.questapi.api.quest.objective.impl.KillEntityObjective
L
- level() - Method in class com.ryankshah.questapi.api.quest.condition.impl.ExperienceLevelCondition
- level() - Method in record class com.ryankshah.questapi.api.quest.QuestContext
- listeners() - Static method in class com.ryankshah.questapi.api.quest.event.QuestEvents
- load() - Static method in class com.ryankshah.questapi.impl.DevConfig
- load(Class) - Static method in class com.ryankshah.questapi.platform.Services
- locked() - Static method in class com.ryankshah.questapi.api.quest.QuestProgress
- LOCKED - Enum constant in enum class com.ryankshah.questapi.api.quest.QuestState
- LOG - Static variable in class com.ryankshah.questapi.QuestApi
M
- manager() - Method in record class com.ryankshah.questapi.api.quest.QuestContext
-
Returns the value of the
managerrecord component. - manager() - Static method in class com.ryankshah.questapi.QuestApi
-
The server-authoritative runtime manager responsible for player quest progress.
- markDirty() - Method in class com.ryankshah.questapi.impl.persistence.QuestSavedData
- MineBlockObjective - Class in com.ryankshah.questapi.api.quest.objective.impl
-
Poll-based objective tracking the vanilla
Stats.BLOCK_MINEDstatistic for a specific block, relative to a baseline captured when the quest became active so that blocks mined before starting the quest do not count. - MineBlockObjective(Block, int) - Constructor for class com.ryankshah.questapi.api.quest.objective.impl.MineBlockObjective
- MOD - Static variable in class com.ryankshah.questapi.example.ExampleQuests
-
Namespace shared by every piece of bundled example content, Java-registered or datapack-JSON-sourced alike, so
QuestDataLoadercan apply the same dev-mode gate to the bundled example JSON quest as this class applies to itself. - MOD_ID - Static variable in class com.ryankshah.questapi.QuestApi
- MOD_NAME - Static variable in class com.ryankshah.questapi.QuestApi
- mouseClicked(MouseButtonEvent, boolean) - Method in class com.ryankshah.questapi.client.gui.QuestScreen
N
O
- objective(int) - Method in class com.ryankshah.questapi.api.quest.QuestProgress
- objective(ObjectiveDefinition) - Method in class com.ryankshah.questapi.api.quest.Quest.Builder
- objectiveCodec(QuestRegistry) - Static method in class com.ryankshah.questapi.impl.network.QuestCodecs
- ObjectiveDefinition - Interface in com.ryankshah.questapi.api.quest.objective
-
Static, immutable description of a single quest objective.
- ObjectiveEventKeys - Class in com.ryankshah.questapi.api.quest.objective
-
Well-known event keys used to drive push-based
ObjectiveDefinition.evaluate(QuestContext, ObjectiveProgress, Identifier, int)calls. - objectiveIndex() - Method in record class com.ryankshah.questapi.impl.network.payload.ServerboundDeliverItemsPayload
-
Returns the value of the
objectiveIndexrecord component. - ObjectiveProgress - Class in com.ryankshah.questapi.api.quest.objective
-
Mutable, per-player runtime progress for a single objective within an active
QuestProgress. - ObjectiveProgress(int, int, boolean) - Constructor for class com.ryankshah.questapi.api.quest.objective.ObjectiveProgress
- objectives() - Method in class com.ryankshah.questapi.api.quest.Quest
- objectives() - Method in class com.ryankshah.questapi.api.quest.QuestProgress
- objectives(List) - Method in class com.ryankshah.questapi.api.quest.Quest.Builder
- ObjectiveType<D> - Record Class in com.ryankshah.questapi.api.quest.objective
-
A registered kind of objective, pairing its identifier with the
MapCodecused to (de)serialize definitions of this type, e.g. - ObjectiveType(Identifier, MapCodec) - Constructor for record class com.ryankshah.questapi.api.quest.objective.ObjectiveType
-
Creates an instance of a
ObjectiveTyperecord class. - objectiveTypes() - Method in interface com.ryankshah.questapi.api.QuestRegistry
- objectiveTypes() - Method in class com.ryankshah.questapi.impl.QuestRegistryImpl
- of(Identifier, Component, ItemStack) - Static method in record class com.ryankshah.questapi.api.quest.QuestCategory
- onObjectiveCompleted(ServerPlayer, Quest, int) - Method in interface com.ryankshah.questapi.api.quest.event.QuestEventListener
- onObjectiveProgressChanged(ServerPlayer, Quest, int, ObjectiveProgress) - Method in interface com.ryankshah.questapi.api.quest.event.QuestEventListener
- onObjectiveProgressChanged(ServerPlayer, Quest, int, ObjectiveProgress) - Method in class com.ryankshah.questapi.impl.network.QuestSyncListener
- onPlayerJoined(ServerPlayer) - Static method in class com.ryankshah.questapi.impl.network.QuestNetworking
- onQuestCompleted(ServerPlayer, Quest) - Method in interface com.ryankshah.questapi.api.quest.event.QuestEventListener
- onQuestCompleted(ServerPlayer, Quest) - Method in class com.ryankshah.questapi.impl.network.QuestSyncListener
- onQuestRegistered(Quest) - Method in interface com.ryankshah.questapi.api.quest.event.QuestEventListener
-
Fired once when a quest is added to the registry, typically during mod initialization.
- onQuestReset(ServerPlayer, Quest) - Method in interface com.ryankshah.questapi.api.quest.event.QuestEventListener
- onQuestReset(ServerPlayer, Quest) - Method in class com.ryankshah.questapi.impl.network.QuestSyncListener
- onQuestStarted(ServerPlayer, Quest) - Method in interface com.ryankshah.questapi.api.quest.event.QuestEventListener
- onQuestStarted(ServerPlayer, Quest) - Method in class com.ryankshah.questapi.impl.network.QuestSyncListener
- onQuestUnlocked(ServerPlayer, Quest) - Method in interface com.ryankshah.questapi.api.quest.event.QuestEventListener
-
Fired once when a quest becomes visible to a player for the first time - either newly
AVAILABLE, or jumping straight toACTIVEfor anautoActivatequest. - onQuestUnlocked(ServerPlayer, Quest) - Method in class com.ryankshah.questapi.impl.network.QuestSyncListener
- onRewardClaimed(ServerPlayer, Quest) - Method in interface com.ryankshah.questapi.api.quest.event.QuestEventListener
- onRewardClaimed(ServerPlayer, Quest) - Method in class com.ryankshah.questapi.impl.network.QuestSyncListener
- open() - Static method in class com.ryankshah.questapi.client.gui.QuestScreen
P
- PlaceBlockObjective - Class in com.ryankshah.questapi.api.quest.objective.impl
-
Push-based objective counting blocks placed by the player.
- PlaceBlockObjective(Block, int) - Constructor for class com.ryankshah.questapi.api.quest.objective.impl.PlaceBlockObjective
- PLATFORM - Static variable in class com.ryankshah.questapi.platform.Services
- player() - Method in record class com.ryankshah.questapi.api.quest.QuestContext
-
Returns the value of the
playerrecord component. - playerId() - Method in class com.ryankshah.questapi.api.quest.PlayerQuestData
- PlayerQuestData - Class in com.ryankshah.questapi.api.quest
-
All quest progress for a single player, keyed by quest ID.
- PlayerQuestData(UUID, Map) - Constructor for class com.ryankshah.questapi.api.quest.PlayerQuestData
- prepare(ResourceManager, ProfilerFiller) - Method in class com.ryankshah.questapi.impl.data.QuestDataLoader
- prerequisites() - Method in class com.ryankshah.questapi.api.quest.Quest
- progress() - Method in class com.ryankshah.questapi.api.quest.PlayerQuestData
- pushObjectiveEvent(ServerPlayer, Identifier, int) - Method in interface com.ryankshah.questapi.api.QuestManager
-
Reports a push-based event (block placed, animal tamed, custom third-party events, ...) to every active objective across every active quest for this player.
- pushObjectiveEvent(ServerPlayer, Identifier, int) - Method in class com.ryankshah.questapi.impl.QuestManagerImpl
Q
- quest() - Method in class com.ryankshah.questapi.client.gui.QuestListEntry
- Quest - Class in com.ryankshah.questapi.api.quest
-
Immutable, static definition of a quest: its identity, presentation, objectives, rewards and unlock conditions.
- Quest.Builder - Class in com.ryankshah.questapi.api.quest
- QuestApi - Class in com.ryankshah.questapi
-
Static entry point holding mod-wide constants and the shared registry/manager singletons.
- QuestCategory - Record Class in com.ryankshah.questapi.api.quest
-
A named grouping of quests shown as a tab/column in the default quest GUI.
- QuestCategory(Identifier, Component, ItemStack, int) - Constructor for record class com.ryankshah.questapi.api.quest.QuestCategory
-
Creates an instance of a
QuestCategoryrecord class. - questCodec(QuestRegistry) - Static method in class com.ryankshah.questapi.impl.network.QuestCodecs
- QuestCodecs - Class in com.ryankshah.questapi.impl.network
-
Builds registry-backed dispatch
Codecs for the extensible objective/reward/condition types, and the fullQuestcodec used to synchronise quest definitions to clients. - QuestCommands - Class in com.ryankshah.questapi.command
-
Development-only debug commands for exercising the quest lifecycle without playing through it.
- QuestCompletedCondition - Class in com.ryankshah.questapi.api.quest.condition.impl
-
Requires another quest to have been completed (rewards claimed) before this one unlocks.
- QuestCompletedCondition(Identifier) - Constructor for class com.ryankshah.questapi.api.quest.condition.impl.QuestCompletedCondition
- QuestCondition - Interface in com.ryankshah.questapi.api.quest.condition
-
A predicate a player must satisfy for a quest to unlock (become
AVAILABLEinstead ofLOCKED). - QuestContext - Record Class in com.ryankshah.questapi.api.quest
-
Execution context handed to objective evaluators, reward grants and quest conditions.
- QuestContext(ServerPlayer, QuestManager) - Constructor for record class com.ryankshah.questapi.api.quest.QuestContext
-
Creates an instance of a
QuestContextrecord class. - QuestDataLoader - Class in com.ryankshah.questapi.impl.data
-
Loads quest categories and quest definitions from datapacks, as an alternative (or complement) to registering them in Java.
- QuestDataLoader() - Constructor for class com.ryankshah.questapi.impl.data.QuestDataLoader
- QuestDataLoader.RawData - Record Class in com.ryankshah.questapi.impl.data
- QuestEventListener - Interface in com.ryankshah.questapi.api.quest.event
-
Hook interface for observing quest lifecycle events from other mods.
- QuestEvents - Class in com.ryankshah.questapi.api.quest.event
-
Minimal, loader-independent event bus for
QuestEventListeners. - QuestGuiText - Class in com.ryankshah.questapi.client.gui
-
Shared text helpers for the default GUI.
- questId() - Method in record class com.ryankshah.questapi.impl.network.payload.ServerboundAbandonQuestPayload
-
Returns the value of the
questIdrecord component. - questId() - Method in record class com.ryankshah.questapi.impl.network.payload.ServerboundClaimRewardPayload
-
Returns the value of the
questIdrecord component. - questId() - Method in record class com.ryankshah.questapi.impl.network.payload.ServerboundDeliverItemsPayload
-
Returns the value of the
questIdrecord component. - questId() - Method in record class com.ryankshah.questapi.impl.network.payload.ServerboundStartQuestPayload
-
Returns the value of the
questIdrecord component. - QuestListEntry - Class in com.ryankshah.questapi.client.gui
-
A single row in the
QuestListWidget, showing a quest's icon, title and a coloured state marker (locked/available/active/completed/rewarded). - QuestListEntry(Quest, QuestState) - Constructor for class com.ryankshah.questapi.client.gui.QuestListEntry
- QuestListWidget - Class in com.ryankshah.questapi.client.gui
-
The scrollable list of quests within the currently selected category.
- QuestListWidget(Minecraft, int, int, int, int, Consumer) - Constructor for class com.ryankshah.questapi.client.gui.QuestListWidget
- QuestManager - Interface in com.ryankshah.questapi.api
-
Server-authoritative runtime orchestrator for player quest progress.
- QuestManagerImpl - Class in com.ryankshah.questapi.impl
- QuestManagerImpl(QuestRegistry) - Constructor for class com.ryankshah.questapi.impl.QuestManagerImpl
- QuestNetworking - Class in com.ryankshah.questapi.impl.network
-
Server-side packet handling logic shared by both loaders.
- QuestProgress - Class in com.ryankshah.questapi.api.quest
-
Mutable, per-player runtime state for a single quest.
- QuestProgress(QuestState, Map, long, long, long, long) - Constructor for class com.ryankshah.questapi.api.quest.QuestProgress
- QuestRegistry - Interface in com.ryankshah.questapi.api
-
The static side of the Questing API: quest definitions, categories, and the extensible type registries for objectives, rewards and conditions.
- QuestRegistryImpl - Class in com.ryankshah.questapi.impl
- QuestRegistryImpl() - Constructor for class com.ryankshah.questapi.impl.QuestRegistryImpl
- QuestReward - Interface in com.ryankshah.questapi.api.quest.reward
-
Static description of something granted to a player when they claim a completed quest.
- quests() - Method in interface com.ryankshah.questapi.api.QuestRegistry
- quests() - Method in class com.ryankshah.questapi.client.ClientQuestDataCache
- quests() - Method in record class com.ryankshah.questapi.impl.data.QuestDataLoader.RawData
-
Returns the value of the
questsrecord component. - quests() - Method in record class com.ryankshah.questapi.impl.network.payload.ClientboundSyncDefinitionsPayload
-
Returns the value of the
questsrecord component. - quests() - Method in class com.ryankshah.questapi.impl.QuestRegistryImpl
- QuestSavedData - Class in com.ryankshah.questapi.impl.persistence
-
Server-wide persistent storage for every player's quest progress, attached to the server via
MinecraftServer#getDataStorage()rather than to any single dimension so that progress is independent of which world a player last stood in. - QuestSavedData() - Constructor for class com.ryankshah.questapi.impl.persistence.QuestSavedData
- QuestScreen - Class in com.ryankshah.questapi.client.gui
-
The default quest book GUI.
- QuestScreen() - Constructor for class com.ryankshah.questapi.client.gui.QuestScreen
- questsInCategory(Identifier) - Method in interface com.ryankshah.questapi.api.QuestRegistry
- questsInCategory(Identifier) - Method in class com.ryankshah.questapi.client.ClientQuestDataCache
- questsInCategory(Identifier) - Method in class com.ryankshah.questapi.impl.QuestRegistryImpl
- QuestState - Enum Class in com.ryankshah.questapi.api.quest
-
The lifecycle state of a single quest for a single player.
- QuestSyncListener - Class in com.ryankshah.questapi.impl.network
-
Bridges the loader-independent
QuestEventListenercallbacks to network sync, so thatQuestManagerImplitself never needs to know networking exists. - QuestSyncListener() - Constructor for class com.ryankshah.questapi.impl.network.QuestSyncListener
- questTitle() - Method in record class com.ryankshah.questapi.impl.network.payload.ClientboundQuestCompletedPayload
-
Returns the value of the
questTitlerecord component. - questTitle() - Method in record class com.ryankshah.questapi.impl.network.payload.ClientboundQuestUnlockedPayload
-
Returns the value of the
questTitlerecord component. - QuestTrackerHud - Class in com.ryankshah.questapi.client.gui
-
Renders the player's pinned quest (see
ClientQuestDataCache.toggleTracked(Identifier)) in the top right corner of the HUD, so its objectives stay visible without reopening the quest book.
R
- RAIN - Enum constant in enum class com.ryankshah.questapi.api.quest.condition.impl.WeatherCondition.WeatherType
- RawData(Map, Map) - Constructor for record class com.ryankshah.questapi.impl.data.QuestDataLoader.RawData
-
Creates an instance of a
RawDatarecord class. - refreshAvailability(ServerPlayer) - Method in interface com.ryankshah.questapi.api.QuestManager
-
Recomputes LOCKED/AVAILABLE state for every registered quest against this player's current progress, auto-activating any quest marked
autoActivatewhose prerequisites now pass. - refreshAvailability(ServerPlayer) - Method in class com.ryankshah.questapi.impl.QuestManagerImpl
- register(CommandDispatcher) - Static method in class com.ryankshah.questapi.command.QuestCommands
- register(QuestEventListener) - Static method in class com.ryankshah.questapi.api.quest.event.QuestEvents
- registerAll() - Static method in class com.ryankshah.questapi.example.ExampleQuests
-
Registers the example quest tree.
- registerAll(QuestRegistry) - Static method in class com.ryankshah.questapi.impl.BuiltinContent
- registerCategory(QuestCategory) - Method in interface com.ryankshah.questapi.api.QuestRegistry
- registerCategory(QuestCategory) - Method in class com.ryankshah.questapi.impl.QuestRegistryImpl
- registerConditionType(ConditionType) - Method in interface com.ryankshah.questapi.api.QuestRegistry
- registerConditionType(ConditionType) - Method in class com.ryankshah.questapi.impl.QuestRegistryImpl
- registerObjectiveType(ObjectiveType) - Method in interface com.ryankshah.questapi.api.QuestRegistry
- registerObjectiveType(ObjectiveType) - Method in class com.ryankshah.questapi.impl.QuestRegistryImpl
- registerQuest(Quest) - Method in interface com.ryankshah.questapi.api.QuestRegistry
- registerQuest(Quest) - Method in class com.ryankshah.questapi.impl.QuestRegistryImpl
- registerRewardType(RewardType) - Method in interface com.ryankshah.questapi.api.QuestRegistry
- registerRewardType(RewardType) - Method in class com.ryankshah.questapi.impl.QuestRegistryImpl
- registry() - Static method in class com.ryankshah.questapi.QuestApi
-
The registry of static quest/objective/reward/condition type definitions.
- removeCategory(Identifier) - Method in interface com.ryankshah.questapi.api.QuestRegistry
-
Removes a single category, e.g.
- removeCategory(Identifier) - Method in class com.ryankshah.questapi.impl.QuestRegistryImpl
- removeQuest(Identifier) - Method in interface com.ryankshah.questapi.api.QuestRegistry
-
Removes a single quest, e.g.
- removeQuest(Identifier) - Method in class com.ryankshah.questapi.impl.QuestRegistryImpl
- render(GuiGraphicsExtractor, DeltaTracker) - Static method in class com.ryankshah.questapi.client.gui.QuestTrackerHud
- repeatable() - Method in class com.ryankshah.questapi.api.quest.Quest
-
If
true, this quest automatically returns toAVAILABLEsome time after being rewarded, instead of staying in the terminalREWARDEDstate forever. - repeatable(int) - Method in class com.ryankshah.questapi.api.quest.Quest.Builder
-
Marks this quest repeatable, resetting
amounthours or in-game days (depending on the server's configured defaultResetMode) after it was last claimed. - repeatable(ResetMode, int) - Method in class com.ryankshah.questapi.api.quest.Quest.Builder
-
Marks this quest repeatable with an explicit
ResetMode, overriding the server's configured default for this quest only. - requestAbandonQuest(Identifier) - Static method in class com.ryankshah.questapi.client.network.ClientQuestNetworking
- requestClaimReward(Identifier) - Static method in class com.ryankshah.questapi.client.network.ClientQuestNetworking
- requestDeliverItems(Identifier, int, int) - Static method in class com.ryankshah.questapi.client.network.ClientQuestNetworking
- requestStartQuest(Identifier) - Static method in class com.ryankshah.questapi.client.network.ClientQuestNetworking
- requestSync() - Static method in class com.ryankshah.questapi.client.network.ClientQuestNetworking
- requiredQuestId() - Method in class com.ryankshah.questapi.api.quest.condition.impl.QuestCompletedCondition
- requires(QuestCondition) - Method in class com.ryankshah.questapi.api.quest.Quest.Builder
- requires(List) - Method in class com.ryankshah.questapi.api.quest.Quest.Builder
- requiresDay() - Method in class com.ryankshah.questapi.api.quest.condition.impl.TimeOfDayCondition
- resetAmount() - Method in class com.ryankshah.questapi.api.quest.Quest
-
The cooldown length: hours if the resolved
ResetModeisResetMode.WALL_CLOCK, in-game days if it isResetMode.IN_GAME_DAY. - resetMode() - Method in class com.ryankshah.questapi.api.quest.Quest
-
How this quest's cooldown is measured, or
nullto use the server's configured default (seequestapi.properties). - ResetMode - Enum Class in com.ryankshah.questapi.api.quest
-
How a repeatable quest's cooldown is measured, see
Quest.Builder.repeatable(ResetMode, int). - resetQuest(ServerPlayer, Identifier) - Method in interface com.ryankshah.questapi.api.QuestManager
-
Fully resets a quest to
LOCKED/AVAILABLEregardless of its current state, discarding all progress and reward-claim status. - resetQuest(ServerPlayer, Identifier) - Method in class com.ryankshah.questapi.impl.QuestManagerImpl
- revision() - Method in class com.ryankshah.questapi.client.ClientQuestDataCache
-
Bumped every time new data arrives from the server.
- reward(QuestReward) - Method in class com.ryankshah.questapi.api.quest.Quest.Builder
- rewardClaimed() - Method in class com.ryankshah.questapi.api.quest.QuestProgress
- rewardCodec(QuestRegistry) - Static method in class com.ryankshah.questapi.impl.network.QuestCodecs
- REWARDED - Enum constant in enum class com.ryankshah.questapi.api.quest.QuestState
- rewardedAt() - Method in class com.ryankshah.questapi.api.quest.QuestProgress
- rewardedAtDay() - Method in class com.ryankshah.questapi.api.quest.QuestProgress
-
The world's in-game day count (see
QuestManagerImpl#currentGameDay) at the moment this quest was last rewarded. - rewards() - Method in class com.ryankshah.questapi.api.quest.Quest
- rewards(List) - Method in class com.ryankshah.questapi.api.quest.Quest.Builder
- RewardType<R> - Record Class in com.ryankshah.questapi.api.quest.reward
-
A registered kind of reward, pairing its identifier with the
MapCodecused to (de)serialize instances of this type. - RewardType(Identifier, MapCodec) - Constructor for record class com.ryankshah.questapi.api.quest.reward.RewardType
-
Creates an instance of a
RewardTyperecord class.
S
- sendDefinitions(ServerPlayer) - Static method in class com.ryankshah.questapi.impl.network.QuestNetworking
- sendProgress(ServerPlayer) - Static method in class com.ryankshah.questapi.impl.network.QuestNetworking
- sendQuestCompleted(ServerPlayer, Quest) - Static method in class com.ryankshah.questapi.impl.network.QuestNetworking
- sendQuestUnlocked(ServerPlayer, Quest) - Static method in class com.ryankshah.questapi.impl.network.QuestNetworking
- sendToPlayer(ServerPlayer, CustomPacketPayload) - Method in interface com.ryankshah.questapi.platform.services.INetworkHelper
- sendToServer(CustomPacketPayload) - Method in interface com.ryankshah.questapi.platform.services.INetworkHelper
- server() - Method in record class com.ryankshah.questapi.api.quest.QuestContext
- ServerboundAbandonQuestPayload - Record Class in com.ryankshah.questapi.impl.network.payload
-
Requests that the server abandon an
ACTIVEquest for the sending player. - ServerboundAbandonQuestPayload(Identifier) - Constructor for record class com.ryankshah.questapi.impl.network.payload.ServerboundAbandonQuestPayload
-
Creates an instance of a
ServerboundAbandonQuestPayloadrecord class. - ServerboundClaimRewardPayload - Record Class in com.ryankshah.questapi.impl.network.payload
-
Requests that the server claim the rewards of a
COMPLETEDquest for the sending player. - ServerboundClaimRewardPayload(Identifier) - Constructor for record class com.ryankshah.questapi.impl.network.payload.ServerboundClaimRewardPayload
-
Creates an instance of a
ServerboundClaimRewardPayloadrecord class. - ServerboundDeliverItemsPayload - Record Class in com.ryankshah.questapi.impl.network.payload
-
Requests that the server remove
amountitems from the sending player's inventory and credit them to a delivery objective. - ServerboundDeliverItemsPayload(Identifier, int, int) - Constructor for record class com.ryankshah.questapi.impl.network.payload.ServerboundDeliverItemsPayload
-
Creates an instance of a
ServerboundDeliverItemsPayloadrecord class. - ServerboundRequestSyncPayload - Record Class in com.ryankshah.questapi.impl.network.payload
-
Asks the server to resend both quest definitions and the sending player's progress, e.g.
- ServerboundRequestSyncPayload() - Constructor for record class com.ryankshah.questapi.impl.network.payload.ServerboundRequestSyncPayload
-
Creates an instance of a
ServerboundRequestSyncPayloadrecord class. - ServerboundStartQuestPayload - Record Class in com.ryankshah.questapi.impl.network.payload
-
Requests that the server manually start an
AVAILABLEquest for the sending player. - ServerboundStartQuestPayload(Identifier) - Constructor for record class com.ryankshah.questapi.impl.network.payload.ServerboundStartQuestPayload
-
Creates an instance of a
ServerboundStartQuestPayloadrecord class. - ServerPlayerGameModeMixin - Class in com.ryankshah.questapi.mixin
-
There is no vanilla statistic or cross-loader event fired specifically when a player places a block (unlike mining, which increments
Stats.BLOCK_MINEDautomatically), soPlaceBlockObjectiveis driven from here instead. - ServerPlayerGameModeMixin() - Constructor for class com.ryankshah.questapi.mixin.ServerPlayerGameModeMixin
- Services - Class in com.ryankshah.questapi.platform
-
Locates the platform-specific implementation of each service interface via Java's
ServiceLoader. - setBaseline(int) - Method in class com.ryankshah.questapi.api.quest.objective.ObjectiveProgress
- setCategories(List, ClientQuestDataCache) - Method in class com.ryankshah.questapi.client.gui.CategoryListWidget
- setCompletedAt(long) - Method in class com.ryankshah.questapi.api.quest.QuestProgress
- setDefinitions(List, List) - Method in class com.ryankshah.questapi.client.ClientQuestDataCache
- setProgress(PlayerQuestData) - Method in class com.ryankshah.questapi.client.ClientQuestDataCache
- setQuests(List, ClientQuestDataCache) - Method in class com.ryankshah.questapi.client.gui.QuestListWidget
- setRewardedAt(long) - Method in class com.ryankshah.questapi.api.quest.QuestProgress
- setRewardedAtDay(long) - Method in class com.ryankshah.questapi.api.quest.QuestProgress
- setSelected(CategoryListEntry) - Method in class com.ryankshah.questapi.client.gui.CategoryListWidget
- setSelected(QuestListEntry) - Method in class com.ryankshah.questapi.client.gui.QuestListWidget
- setStartedAt(long) - Method in class com.ryankshah.questapi.api.quest.QuestProgress
- setState(QuestState) - Method in class com.ryankshah.questapi.api.quest.QuestProgress
- sortOrder() - Method in class com.ryankshah.questapi.api.quest.Quest
-
Lower values are displayed first within a category.
- sortOrder() - Method in record class com.ryankshah.questapi.api.quest.QuestCategory
-
Returns the value of the
sortOrderrecord component. - sortOrder(int) - Method in class com.ryankshah.questapi.api.quest.Quest.Builder
- startedAt() - Method in class com.ryankshah.questapi.api.quest.QuestProgress
- startQuest(ServerPlayer, Identifier) - Method in interface com.ryankshah.questapi.api.QuestManager
-
Manually starts an
AVAILABLEquest, transitioning it toACTIVEand capturing baselines for its poll-based objectives. - startQuest(ServerPlayer, Identifier) - Method in class com.ryankshah.questapi.impl.QuestManagerImpl
- state() - Method in class com.ryankshah.questapi.api.quest.QuestProgress
- stateColor(QuestState) - Static method in class com.ryankshah.questapi.client.gui.QuestGuiText
-
Consistent colour for a quest's state, used by both the quest list rows and the detail panel.
- stateLabel(Quest, QuestState) - Static method in class com.ryankshah.questapi.client.gui.QuestGuiText
- STREAM_CODEC - Static variable in record class com.ryankshah.questapi.impl.network.payload.ClientboundQuestCompletedPayload
- STREAM_CODEC - Static variable in record class com.ryankshah.questapi.impl.network.payload.ClientboundQuestUnlockedPayload
- STREAM_CODEC - Static variable in record class com.ryankshah.questapi.impl.network.payload.ClientboundSyncDefinitionsPayload
- STREAM_CODEC - Static variable in record class com.ryankshah.questapi.impl.network.payload.ClientboundSyncProgressPayload
- STREAM_CODEC - Static variable in record class com.ryankshah.questapi.impl.network.payload.ServerboundAbandonQuestPayload
- STREAM_CODEC - Static variable in record class com.ryankshah.questapi.impl.network.payload.ServerboundClaimRewardPayload
- STREAM_CODEC - Static variable in record class com.ryankshah.questapi.impl.network.payload.ServerboundDeliverItemsPayload
- STREAM_CODEC - Static variable in record class com.ryankshah.questapi.impl.network.payload.ServerboundRequestSyncPayload
- STREAM_CODEC - Static variable in record class com.ryankshah.questapi.impl.network.payload.ServerboundStartQuestPayload
T
- TamableAnimalMixin - Class in com.ryankshah.questapi.mixin
-
There is no cross-loader vanilla event fired when a player tames an animal, so
TameEntityObjectiveis driven from here instead, identically on Fabric and NeoForge. - TamableAnimalMixin() - Constructor for class com.ryankshah.questapi.mixin.TamableAnimalMixin
- TameEntityObjective - Class in com.ryankshah.questapi.api.quest.objective.impl
-
Push-based objective completed by taming any number of animals.
- TameEntityObjective(int) - Constructor for class com.ryankshah.questapi.api.quest.objective.impl.TameEntityObjective
- targetAmount() - Method in class com.ryankshah.questapi.api.quest.objective.impl.BreedAnimalsObjective
- targetAmount() - Method in class com.ryankshah.questapi.api.quest.objective.impl.CollectItemObjective
- targetAmount() - Method in class com.ryankshah.questapi.api.quest.objective.impl.ConsumeItemObjective
- targetAmount() - Method in class com.ryankshah.questapi.api.quest.objective.impl.CraftItemObjective
- targetAmount() - Method in class com.ryankshah.questapi.api.quest.objective.impl.DeliverItemObjective
- targetAmount() - Method in class com.ryankshah.questapi.api.quest.objective.impl.FishObjective
- targetAmount() - Method in class com.ryankshah.questapi.api.quest.objective.impl.KillEntityObjective
- targetAmount() - Method in class com.ryankshah.questapi.api.quest.objective.impl.MineBlockObjective
- targetAmount() - Method in class com.ryankshah.questapi.api.quest.objective.impl.PlaceBlockObjective
- targetAmount() - Method in class com.ryankshah.questapi.api.quest.objective.impl.TameEntityObjective
- targetAmount() - Method in class com.ryankshah.questapi.api.quest.objective.impl.VisitDimensionObjective
- targetAmount() - Method in class com.ryankshah.questapi.api.quest.objective.impl.VisitLocationObjective
- targetAmount() - Method in interface com.ryankshah.questapi.api.quest.objective.ObjectiveDefinition
-
The amount of progress required to complete this objective.
- test(QuestContext) - Method in class com.ryankshah.questapi.api.quest.condition.impl.AdvancementCondition
- test(QuestContext) - Method in class com.ryankshah.questapi.api.quest.condition.impl.AnyOfCondition
- test(QuestContext) - Method in class com.ryankshah.questapi.api.quest.condition.impl.BiomeCondition
- test(QuestContext) - Method in class com.ryankshah.questapi.api.quest.condition.impl.ExperienceLevelCondition
- test(QuestContext) - Method in class com.ryankshah.questapi.api.quest.condition.impl.ItemPossessionCondition
- test(QuestContext) - Method in class com.ryankshah.questapi.api.quest.condition.impl.QuestCompletedCondition
- test(QuestContext) - Method in class com.ryankshah.questapi.api.quest.condition.impl.TimeOfDayCondition
- test(QuestContext) - Method in class com.ryankshah.questapi.api.quest.condition.impl.WeatherCondition
- test(QuestContext) - Method in interface com.ryankshah.questapi.api.quest.condition.QuestCondition
- THUNDER - Enum constant in enum class com.ryankshah.questapi.api.quest.condition.impl.WeatherCondition.WeatherType
- tick() - Method in class com.ryankshah.questapi.client.gui.QuestScreen
- TICK - Static variable in class com.ryankshah.questapi.api.quest.objective.ObjectiveEventKeys
-
Fired periodically (roughly once per second) for every player with active quests.
- tickObjectives(ServerPlayer) - Method in interface com.ryankshah.questapi.api.QuestManager
-
Re-evaluates every poll-based objective of every
ACTIVEquest for this player. - tickObjectives(ServerPlayer) - Method in class com.ryankshah.questapi.impl.QuestManagerImpl
- TimeOfDayCondition - Class in com.ryankshah.questapi.api.quest.condition.impl
-
Requires the player's current dimension to be in daytime or nighttime, per
Level.isBrightOutside()/isDarkOutside()- always false for a dimension with a fixed time (the Nether, the End), matching vanilla's own definition of "day". - TimeOfDayCondition(boolean) - Constructor for class com.ryankshah.questapi.api.quest.condition.impl.TimeOfDayCondition
- title() - Method in class com.ryankshah.questapi.api.quest.Quest
- title(Component) - Method in class com.ryankshah.questapi.api.quest.Quest.Builder
- toggleTracked(Identifier) - Method in class com.ryankshah.questapi.client.ClientQuestDataCache
-
Pins
questIdto the HUD tracker, or unpins it if it's already the tracked quest. - toString() - Method in record class com.ryankshah.questapi.api.quest.condition.ConditionType
-
Returns a string representation of this record class.
- toString() - Method in record class com.ryankshah.questapi.api.quest.objective.ObjectiveType
-
Returns a string representation of this record class.
- toString() - Method in record class com.ryankshah.questapi.api.quest.QuestCategory
-
Returns a string representation of this record class.
- toString() - Method in record class com.ryankshah.questapi.api.quest.QuestContext
-
Returns a string representation of this record class.
- toString() - Method in record class com.ryankshah.questapi.api.quest.reward.RewardType
-
Returns a string representation of this record class.
- toString() - Method in record class com.ryankshah.questapi.impl.data.QuestDataLoader.RawData
-
Returns a string representation of this record class.
- toString() - Method in record class com.ryankshah.questapi.impl.network.payload.ClientboundQuestCompletedPayload
-
Returns a string representation of this record class.
- toString() - Method in record class com.ryankshah.questapi.impl.network.payload.ClientboundQuestUnlockedPayload
-
Returns a string representation of this record class.
- toString() - Method in record class com.ryankshah.questapi.impl.network.payload.ClientboundSyncDefinitionsPayload
-
Returns a string representation of this record class.
- toString() - Method in record class com.ryankshah.questapi.impl.network.payload.ClientboundSyncProgressPayload
-
Returns a string representation of this record class.
- toString() - Method in record class com.ryankshah.questapi.impl.network.payload.ServerboundAbandonQuestPayload
-
Returns a string representation of this record class.
- toString() - Method in record class com.ryankshah.questapi.impl.network.payload.ServerboundClaimRewardPayload
-
Returns a string representation of this record class.
- toString() - Method in record class com.ryankshah.questapi.impl.network.payload.ServerboundDeliverItemsPayload
-
Returns a string representation of this record class.
- toString() - Method in record class com.ryankshah.questapi.impl.network.payload.ServerboundRequestSyncPayload
-
Returns a string representation of this record class.
- toString() - Method in record class com.ryankshah.questapi.impl.network.payload.ServerboundStartQuestPayload
-
Returns a string representation of this record class.
- trackedQuestId() - Method in class com.ryankshah.questapi.client.ClientQuestDataCache
-
The quest currently pinned to the in-game HUD tracker, or
nullif none is pinned. - type() - Method in record class com.ryankshah.questapi.impl.network.payload.ClientboundQuestCompletedPayload
- type() - Method in record class com.ryankshah.questapi.impl.network.payload.ClientboundQuestUnlockedPayload
- type() - Method in record class com.ryankshah.questapi.impl.network.payload.ClientboundSyncDefinitionsPayload
- type() - Method in record class com.ryankshah.questapi.impl.network.payload.ClientboundSyncProgressPayload
- type() - Method in record class com.ryankshah.questapi.impl.network.payload.ServerboundAbandonQuestPayload
- type() - Method in record class com.ryankshah.questapi.impl.network.payload.ServerboundClaimRewardPayload
- type() - Method in record class com.ryankshah.questapi.impl.network.payload.ServerboundDeliverItemsPayload
- type() - Method in record class com.ryankshah.questapi.impl.network.payload.ServerboundRequestSyncPayload
- type() - Method in record class com.ryankshah.questapi.impl.network.payload.ServerboundStartQuestPayload
- type(QuestRegistry) - Static method in class com.ryankshah.questapi.api.quest.condition.impl.AnyOfCondition
- TYPE - Static variable in class com.ryankshah.questapi.api.quest.condition.impl.AdvancementCondition
- TYPE - Static variable in class com.ryankshah.questapi.api.quest.condition.impl.BiomeCondition
- TYPE - Static variable in class com.ryankshah.questapi.api.quest.condition.impl.ExperienceLevelCondition
- TYPE - Static variable in class com.ryankshah.questapi.api.quest.condition.impl.ItemPossessionCondition
- TYPE - Static variable in class com.ryankshah.questapi.api.quest.condition.impl.QuestCompletedCondition
- TYPE - Static variable in class com.ryankshah.questapi.api.quest.condition.impl.TimeOfDayCondition
- TYPE - Static variable in class com.ryankshah.questapi.api.quest.condition.impl.WeatherCondition
- TYPE - Static variable in class com.ryankshah.questapi.api.quest.objective.impl.BreedAnimalsObjective
- TYPE - Static variable in class com.ryankshah.questapi.api.quest.objective.impl.CollectItemObjective
- TYPE - Static variable in class com.ryankshah.questapi.api.quest.objective.impl.ConsumeItemObjective
- TYPE - Static variable in class com.ryankshah.questapi.api.quest.objective.impl.CraftItemObjective
- TYPE - Static variable in class com.ryankshah.questapi.api.quest.objective.impl.DeliverItemObjective
- TYPE - Static variable in class com.ryankshah.questapi.api.quest.objective.impl.FishObjective
- TYPE - Static variable in class com.ryankshah.questapi.api.quest.objective.impl.KillEntityObjective
- TYPE - Static variable in class com.ryankshah.questapi.api.quest.objective.impl.MineBlockObjective
- TYPE - Static variable in class com.ryankshah.questapi.api.quest.objective.impl.PlaceBlockObjective
- TYPE - Static variable in class com.ryankshah.questapi.api.quest.objective.impl.TameEntityObjective
- TYPE - Static variable in class com.ryankshah.questapi.api.quest.objective.impl.VisitDimensionObjective
- TYPE - Static variable in class com.ryankshah.questapi.api.quest.objective.impl.VisitLocationObjective
- TYPE - Static variable in class com.ryankshah.questapi.api.quest.reward.impl.AdvancementReward
- TYPE - Static variable in class com.ryankshah.questapi.api.quest.reward.impl.CommandReward
- TYPE - Static variable in class com.ryankshah.questapi.api.quest.reward.impl.EffectReward
- TYPE - Static variable in class com.ryankshah.questapi.api.quest.reward.impl.ExperienceReward
- TYPE - Static variable in class com.ryankshah.questapi.api.quest.reward.impl.ItemReward
- TYPE - Static variable in record class com.ryankshah.questapi.impl.network.payload.ClientboundQuestCompletedPayload
- TYPE - Static variable in record class com.ryankshah.questapi.impl.network.payload.ClientboundQuestUnlockedPayload
- TYPE - Static variable in record class com.ryankshah.questapi.impl.network.payload.ClientboundSyncDefinitionsPayload
- TYPE - Static variable in record class com.ryankshah.questapi.impl.network.payload.ClientboundSyncProgressPayload
- TYPE - Static variable in record class com.ryankshah.questapi.impl.network.payload.ServerboundAbandonQuestPayload
- TYPE - Static variable in record class com.ryankshah.questapi.impl.network.payload.ServerboundClaimRewardPayload
- TYPE - Static variable in record class com.ryankshah.questapi.impl.network.payload.ServerboundDeliverItemsPayload
- TYPE - Static variable in record class com.ryankshah.questapi.impl.network.payload.ServerboundRequestSyncPayload
- TYPE - Static variable in record class com.ryankshah.questapi.impl.network.payload.ServerboundStartQuestPayload
- TYPE - Static variable in class com.ryankshah.questapi.impl.persistence.QuestSavedData
- TYPE_ID - Static variable in class com.ryankshah.questapi.api.quest.condition.impl.AdvancementCondition
- TYPE_ID - Static variable in class com.ryankshah.questapi.api.quest.condition.impl.AnyOfCondition
- TYPE_ID - Static variable in class com.ryankshah.questapi.api.quest.condition.impl.BiomeCondition
- TYPE_ID - Static variable in class com.ryankshah.questapi.api.quest.condition.impl.ExperienceLevelCondition
- TYPE_ID - Static variable in class com.ryankshah.questapi.api.quest.condition.impl.ItemPossessionCondition
- TYPE_ID - Static variable in class com.ryankshah.questapi.api.quest.condition.impl.QuestCompletedCondition
- TYPE_ID - Static variable in class com.ryankshah.questapi.api.quest.condition.impl.TimeOfDayCondition
- TYPE_ID - Static variable in class com.ryankshah.questapi.api.quest.condition.impl.WeatherCondition
- TYPE_ID - Static variable in class com.ryankshah.questapi.api.quest.objective.impl.BreedAnimalsObjective
- TYPE_ID - Static variable in class com.ryankshah.questapi.api.quest.objective.impl.CollectItemObjective
- TYPE_ID - Static variable in class com.ryankshah.questapi.api.quest.objective.impl.ConsumeItemObjective
- TYPE_ID - Static variable in class com.ryankshah.questapi.api.quest.objective.impl.CraftItemObjective
- TYPE_ID - Static variable in class com.ryankshah.questapi.api.quest.objective.impl.DeliverItemObjective
- TYPE_ID - Static variable in class com.ryankshah.questapi.api.quest.objective.impl.FishObjective
- TYPE_ID - Static variable in class com.ryankshah.questapi.api.quest.objective.impl.KillEntityObjective
- TYPE_ID - Static variable in class com.ryankshah.questapi.api.quest.objective.impl.MineBlockObjective
- TYPE_ID - Static variable in class com.ryankshah.questapi.api.quest.objective.impl.PlaceBlockObjective
- TYPE_ID - Static variable in class com.ryankshah.questapi.api.quest.objective.impl.TameEntityObjective
- TYPE_ID - Static variable in class com.ryankshah.questapi.api.quest.objective.impl.VisitDimensionObjective
- TYPE_ID - Static variable in class com.ryankshah.questapi.api.quest.objective.impl.VisitLocationObjective
- TYPE_ID - Static variable in class com.ryankshah.questapi.api.quest.reward.impl.AdvancementReward
- TYPE_ID - Static variable in class com.ryankshah.questapi.api.quest.reward.impl.CommandReward
- TYPE_ID - Static variable in class com.ryankshah.questapi.api.quest.reward.impl.EffectReward
- TYPE_ID - Static variable in class com.ryankshah.questapi.api.quest.reward.impl.ExperienceReward
- TYPE_ID - Static variable in class com.ryankshah.questapi.api.quest.reward.impl.ItemReward
- typeId() - Method in class com.ryankshah.questapi.api.quest.condition.impl.AdvancementCondition
- typeId() - Method in class com.ryankshah.questapi.api.quest.condition.impl.AnyOfCondition
- typeId() - Method in class com.ryankshah.questapi.api.quest.condition.impl.BiomeCondition
- typeId() - Method in class com.ryankshah.questapi.api.quest.condition.impl.ExperienceLevelCondition
- typeId() - Method in class com.ryankshah.questapi.api.quest.condition.impl.ItemPossessionCondition
- typeId() - Method in class com.ryankshah.questapi.api.quest.condition.impl.QuestCompletedCondition
- typeId() - Method in class com.ryankshah.questapi.api.quest.condition.impl.TimeOfDayCondition
- typeId() - Method in class com.ryankshah.questapi.api.quest.condition.impl.WeatherCondition
- typeId() - Method in interface com.ryankshah.questapi.api.quest.condition.QuestCondition
- typeId() - Method in class com.ryankshah.questapi.api.quest.objective.impl.BreedAnimalsObjective
- typeId() - Method in class com.ryankshah.questapi.api.quest.objective.impl.CollectItemObjective
- typeId() - Method in class com.ryankshah.questapi.api.quest.objective.impl.ConsumeItemObjective
- typeId() - Method in class com.ryankshah.questapi.api.quest.objective.impl.CraftItemObjective
- typeId() - Method in class com.ryankshah.questapi.api.quest.objective.impl.DeliverItemObjective
- typeId() - Method in class com.ryankshah.questapi.api.quest.objective.impl.FishObjective
- typeId() - Method in class com.ryankshah.questapi.api.quest.objective.impl.KillEntityObjective
- typeId() - Method in class com.ryankshah.questapi.api.quest.objective.impl.MineBlockObjective
- typeId() - Method in class com.ryankshah.questapi.api.quest.objective.impl.PlaceBlockObjective
- typeId() - Method in class com.ryankshah.questapi.api.quest.objective.impl.TameEntityObjective
- typeId() - Method in class com.ryankshah.questapi.api.quest.objective.impl.VisitDimensionObjective
- typeId() - Method in class com.ryankshah.questapi.api.quest.objective.impl.VisitLocationObjective
- typeId() - Method in interface com.ryankshah.questapi.api.quest.objective.ObjectiveDefinition
-
The registered
ObjectiveTypeidentifier for this definition. - typeId() - Method in class com.ryankshah.questapi.api.quest.reward.impl.AdvancementReward
- typeId() - Method in class com.ryankshah.questapi.api.quest.reward.impl.CommandReward
- typeId() - Method in class com.ryankshah.questapi.api.quest.reward.impl.EffectReward
- typeId() - Method in class com.ryankshah.questapi.api.quest.reward.impl.ExperienceReward
- typeId() - Method in class com.ryankshah.questapi.api.quest.reward.impl.ItemReward
- typeId() - Method in interface com.ryankshah.questapi.api.quest.reward.QuestReward
U
- updateCurrent(int, int) - Method in class com.ryankshah.questapi.api.quest.objective.ObjectiveProgress
-
Updates the current progress amount, clamping to the objective's target and recomputing the completion flag.
V
- valueOf(String) - Static method in enum class com.ryankshah.questapi.api.quest.condition.impl.WeatherCondition.WeatherType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.ryankshah.questapi.api.quest.QuestState
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.ryankshah.questapi.api.quest.ResetMode
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.ryankshah.questapi.api.quest.condition.impl.WeatherCondition.WeatherType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.ryankshah.questapi.api.quest.QuestState
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.ryankshah.questapi.api.quest.ResetMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- VisitDimensionObjective - Class in com.ryankshah.questapi.api.quest.objective.impl
-
Poll-based exploration objective satisfied once the player is present in a specific dimension.
- VisitDimensionObjective(Identifier) - Constructor for class com.ryankshah.questapi.api.quest.objective.impl.VisitDimensionObjective
- VisitLocationObjective - Class in com.ryankshah.questapi.api.quest.objective.impl
-
Poll-based exploration objective satisfied once the player comes within
radiusblocks of a target position in a specific dimension. - VisitLocationObjective(Identifier, BlockPos, int, Component) - Constructor for class com.ryankshah.questapi.api.quest.objective.impl.VisitLocationObjective
W
- WALL_CLOCK - Enum constant in enum class com.ryankshah.questapi.api.quest.ResetMode
-
Resets a fixed number of real hours after the quest was last claimed, checked against system time.
- weather() - Method in class com.ryankshah.questapi.api.quest.condition.impl.WeatherCondition
- WeatherCondition - Class in com.ryankshah.questapi.api.quest.condition.impl
-
Requires the player's current dimension to be experiencing a specific kind of weather.
- WeatherCondition(WeatherCondition.WeatherType) - Constructor for class com.ryankshah.questapi.api.quest.condition.impl.WeatherCondition
- WeatherCondition.WeatherType - Enum Class in com.ryankshah.questapi.api.quest.condition.impl
- withSortOrder(int) - Method in record class com.ryankshah.questapi.api.quest.QuestCategory
All Classes and Interfaces|All Packages|Constant Field Values