mirror of
https://github.com/FabricMC/fabric.git
synced 2024-11-27 01:55:41 -05:00
e747827905
* Improve loot table API Alternative to #629. - Deprecates all classes and methods that use outdated Yarn names. - Adds FabricLootTable and FabricLootTableBuilder to replace the LootSupplier naming variants. - Deprecates LootEntryTypeRegistry and LootJsonParser as their functionality is exposed in vanilla now. - Adds methods to FabricLootPoolBuilder for working with collections as builder parameters. - FabricLootPool and FabricLootTable/Supplier now return immutable lists instead of modifiable fixed-size ones. Still WIP: LootTableLoadingCallback uses the deprecated FabricLootSupplier. Update fabric-loot-tables-v1/src/main/java/net/fabricmc/fabric/api/loot/v1/FabricLootTableBuilder.java Co-authored-by: i509VCB <i509vcb@gmail.com> Fix compilation Create loot table API v2 Move incorrect classes and revert unnecessary change Add test for replacing loot tables Document FabricLootPools builder() -> create() Add accessor for LootPool.bonusRolls Add loot pool builder method for bonus rolls Use Blocks.DIRT.getLootTableId() instead of raw string in v1 loot test mod Make links in deprecation docs cleaner Make FabricLootPoolBuilder.copyFrom(pool, true) also copy bonus rolls ...and mention it in the javadoc Remove copyFrom from v2 builders It seems like a maintainability mess if Mojang ever decides to extend loot tables, and the chosen boolean flags are arbitrary. It also doesn't really have use cases apart from the internal use in the copyOf methods, and even then users can replicate its functionality with the other API methods. Rename 'supplier' to 'table' in LootManagerMixin Add 'stable' lifecycle to loot-table-api-v2, deprecate v1 Add internal comment for implementors about updates Cancel all remaining callbacks when a loot table is replaced Remove unused shadowed logger from LootManagerMixin Migrate subproject versioning to new system Start the AW migration Update test mod * Use interface injection * Fix some issues * Remove outdated bonusRolls test from LootTest It's a vanilla feature now. * Create transitive access widener module * Replace LootTableLoadingCallback with two events * Use friendlier exception message * Add resource source tracking * Add loot table sources * Add resource pack source for DefaultResourcePack$1 (anon resource) * Add license header * Make FabricResource an internal API in resource loader * Remove my TAW module * Add loot table-related TAWs * Run CI * Fix LootUtil.determineSource giving null values * Clarify LootUtil comment * Rename loot-table-api => loot-api + minor comment changes * Add README * Fix mixin file name * Use ImmutableMap.Builder instead of HashMap.computeIfAbsent in loot event impl * Prefix accessor methods with fabric_ to prevent conflicts with loot v1 * Document mixins * Document mixins more extensively * Improve NRMMixin comments * Change weird wording in FabricResourceImpl * Minor updates - Support new built-in mod respack source - Fix ResourceMixin comment - Add more docs to LootTableEvents.MODIFY - Add package-info * Add license header
29 lines
1.3 KiB
Markdown
29 lines
1.3 KiB
Markdown
# Fabric Loot API (v2)
|
|
|
|
This module includes APIs for modifying and creating loot tables.
|
|
|
|
## [Loot table events](src/main/java/net/fabricmc/fabric/api/loot/v2/LootTableEvents.java)
|
|
|
|
This class provides two events for modifying loot tables.
|
|
|
|
`LootTableEvents.REPLACE` runs first and lets you replace loot tables completely.
|
|
|
|
`LootTableEvents.MODIFY` runs after and lets you modify loot tables, including the ones created in `REPLACE`,
|
|
by adding new loot pools or loot functions to them.
|
|
|
|
### Loot table sources
|
|
|
|
Both events have access to a [loot table source](src/main/java/net/fabricmc/fabric/api/loot/v2/LootTableSource.java)
|
|
that you can use to check where a loot table is loaded from.
|
|
|
|
For example, you can use this to check if a loot table is from a user data pack and
|
|
not modify the user-provided data in your event.
|
|
|
|
## Enhanced loot table and loot pool builders
|
|
|
|
`LootTable.Builder` and `LootPool.Builder` implement
|
|
injected interfaces ([`FabricLootTableBuilder`](src/main/java/net/fabricmc/fabric/api/loot/v2/FabricLootTableBuilder.java)
|
|
and [`FabricLootPoolBuilder`](src/main/java/net/fabricmc/fabric/api/loot/v2/FabricLootPoolBuilder.java))
|
|
which have additional methods for dealing with already-built objects and collections of objects.
|
|
|
|
Those interfaces also have `copyOf` methods for creating copies of existing loot tables/pools as builders.
|