Skip to main content

Registries

All Faction API registries live in the factionapi namespace and are listed in FactionRegistries.Keys. Access a registry at runtime through FactionRegistries.<NAME>.get().

Code registries

Registered with a DeferredRegister (or the dedicated helpers) during mod construction. See Registering content for examples.

Registry keyTypeUsed forRegister with
factionapi:factionIFaction<?>All factions.DeferredFactionRegister#registerFaction(name, props -> …)
factionapi:skillsISkill<?>Player skills (nodes shown in skill trees).DeferredSkillRegister#registerSkill(name, props -> …)
factionapi:actionsIAction<?> / ILastingAction<?>Activatable player abilities (with cooldown, optional duration).DeferredActionRegister#registerAction(name, …)
factionapi:skill_point_providerISkillPointProviderComputes how many skill points a player has for a given skill tree.DeferredRegister
factionapi:faction_player_consumerFactionPlayerConsumerNamed Consumer<IFactionPlayer> callbacks – referenced by the task consumer reward and skill enable/disable consumables.DeferredRegister
factionapi:faction_player_boolean_supplierFactionPlayerBooleanSupplierNamed player predicates – referenced by the task boolean requirement.DeferredRegister
factionapi:minionIMinionEntry<?, ?>The minion type belonging to a faction (entity type, data factory, command arguments).DeferredRegister
factionapi:miniontasksIMinionTask<?, ?>Tasks a lord can assign to minions.DeferredRegister
factionapi:refinementIRefinementA single accessory effect (usually an attribute modifier).DeferredRegister
factionapi:refinement_setIRefinementSetA named group of refinements with a rarity, faction and optional slot restriction.DeferredRegister
factionapi:task_requirementMapCodec<? extends TaskRequirement.Requirement>Task requirement types (entity, item, stat, …). See Tasks.DeferredRegister
factionapi:task_rewardMapCodec<? extends TaskReward>Task reward types (item, lord_level, refinement, …).DeferredRegister
factionapi:task_unlockerMapCodec<? extends TaskUnlocker>Task unlocker types (level, lord_level, parent).DeferredRegister
factionapi:task_reward_instanceMapCodec<? extends ITaskRewardInstance>Serialized runtime state of a granted-but-not-collected reward.DeferredRegister
factionapi:food_behaviourIFactionFoodBehaviorExtra behaviour applied when a faction player eats a tagged food.DeferredRegister

Data pack registries

Populated from JSON (or datagen). Covered in the Data Packs section.

Registry keyTypePage
factionapi:tasksTaskTasks
factionapi:skill_treeISkillTreeSkill Trees
factionapi:skill_segmentISkillSegmentSkill Segments