Clarify nullability of ModelModifier.AfterBake
#3212
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Technici4n
approved these changes
Jul 21, 2023
apple502j
approved these changes
Jul 21, 2023
Null baked models are cached, but only in the inner cache, which is not accessible after all baking is finished. The term "cache" is also ambiguous, so its use has been removed.
Juuxel
approved these changes
Jul 22, 2023
modmuss50
approved these changes
Jul 24, 2023
modmuss50
pushed a commit
that referenced
this pull request
Jul 25, 2023
* Clarify nullability of AfterBake modifier * Fix documentation Null baked models are cached, but only in the inner cache, which is not accessible after all baking is finished. The term "cache" is also ambiguous, so its use has been removed. * Add breaks for v0 <0.4.0
cocona20xx
added a commit
to cocona20xx/quilted-fabric-api
that referenced
this pull request
Aug 1, 2023
- Involved manually copy-pasting in the changes from the following FAPI upstream commits: -- FabricMC#3222 (one-to-one) -- FabricMC#3216 (required some modification in FabricDynamicRegistryProvider to quiltify) -- FabricMC#3212 (one-to-one other than converting FMJ additions to QMJ) -- FabricMC#3219 does not have to be added as it is not an issue with QSL's 0.86.1 impl of the same concept - Removed/rewrote parts of the QFAPI impl of FAPI's Dynamic Registry API that are better supported by using QSL's equivalents - Applied checkstyle and licensing checks. No licensing changes were made, though checkstyle changes were.
EnnuiL
added a commit
to QuiltMC/quilted-fabric-api
that referenced
this pull request
Aug 1, 2023
* Model Loading API v1 (FabricMC#3145) This PR deprecates and supersedes the old `fabric-models-v0` module. ## Refactors compared to v0 ### Model loading hooks Mods now register a single `ModelLoadingPlugin` for any change they want to make to the model loading process. (Or multiple plugins if they want to). This replaces the old `ModelLoadingRegistry`. Here is an example: ```java ModelLoadingPlugin.register(pluginContext -> { // ResourceManager access is provided like in the v0 API, but in a central place, and can be used for shared processing in the plugin. ResourceManager manager = pluginContext.resourceManager(); // Model resource providers still exist, but they are called model resolvers now pluginContext.resolveModel().register(context -> { // ... }); }); ``` #### `ModelVariantProvider` -> `BlockStateResolver` `ModelVariantProvider` was heavily reworked, and is now replaced by the `BlockStateResolver`, with a much better defined contract. #### `ModelResourceProvider` -> `ModelResolver` The resource provider is mostly unchanged. The biggest difference is that it is now registered as an event listener. This allows mods to use event phases for ordering between conflicting ~~providers~~ resolvers. #### Removed custom exception Additionally, `ModelProviderException` could be thrown by a variant or resource provider in the v0 API. This was not explained in the documentation, and would according to the code stop further processing of the providers and log an error. In the new API, any `Exception` is caught and logged. If that happens, the other resolvers are still processed. There is no custom `Exception` subclass anymore. ### Helper method to get a `BakedModel` by `Identifier` from the manager The v0 had such a method in a helper class: `BakedModelManagerHelper#getBakedModel`. It is now interface-injected instead. See `FabricBakedModelManager`. ## New model wrapping hooks New hooks are added for the various needs of mods that want to override or wrap specific models. Thanks to @embeddedt for contributing an initial version of them! Here is an example of wrapping the gold model to remove the bottom quads, for example: ```java ModelLoadingPlugin.register(pluginContext -> { // remove bottom face of gold blocks pluginContext.modifyModelAfterBake().register(ModelModifier.WRAP_PHASE, (model, context) -> { if (context.identifier().getPath().equals("block/gold_block")) { return new DownQuadRemovingModel(model); } else { return model; } }); }); ``` There are 3 events, for the following use cases: - Wrapping `UnbakedModel`s right when they are loaded. This allows replacing them entirely in dependent models too. - Wrapping `UnbakedModel`s right before they are baked. This allows replacing them without affecting dependent models (which might not be expecting a model class change). - Wrapping `BakedModel`s right when they are baked. Multiple mods have implemented their own version of them. Providing them in Fabric API will make it easier on these mods, and will additionally allow optimization mods that perform on-demand model loading to simply fire the hooks themselves instead of working around injections performed by other mods. Co-authored-by: embeddedt <[email protected]> Co-authored-by: PepperCode1 <[email protected]> Co-authored-by: Juuz <[email protected]> * Add dynamic registry API (FabricMC#3163) * Add API for adding custom dynamic registries Closes FabricMC#1012, supersedes FabricMC#1031 and FabricMC#2719. * Add missing license headers * Clarify RegistryLoaderMixin namespace injection * Replace event with static registration, add skeleton for sorting registries * Fix typo * Refactor event phase sorting system for use with dynamic registries (#1) * Make minor changes to Technici4n's PR * Add test for nested dynamic objects * Revert "Add test for nested dynamic objects" This reverts commit 486e3e1. * Revert "Make minor changes to Technici4n's PR" This reverts commit 741bd52. * Revert "Refactor event phase sorting system for use with dynamic registries (#1)" This reverts commit bb7c8b8. * Remove sorting API * Add support for defaulted dynamic registries * Re-add test for nested dynamic objects * Add missing license headers * Fix typo * Remove defaulted dynamic registries; flatten registration methods * Remove last reference to registry sorting * Add option to skip syncing for empty dynregs * Update DynamicRegistrySyncOption docs Co-authored-by: Technici4n <[email protected]> * Address review feedback * Add registry namespace to tag paths for modded registries * Move dynamic registry tests into their own class for readibility * Finish DynamicRegistries doc * Only apply tag change to dynamic registries * Fix checkstyle * Update fabric-registry-sync-v0/src/main/java/net/fabricmc/fabric/api/event/registry/DynamicRegistries.java Co-authored-by: Technici4n <[email protected]> --------- Co-authored-by: Technici4n <[email protected]> * Fix incorrect behavior with ClientMessageEvents and CommandApi (FabricMC#3182) * Make event phase ordering logic usable in other contexts (internally only) (FabricMC#3183) * Make event phase ordering logic usable in other contexts (internally only) * Rename and move to toposort package * Fix crash when beehive is broken by fake player (FabricMC#3190) * Fix crash when beehive is broken by fake player When a beehive is broken, every nearby bee targets a random player. However, if there are no nearby players, the game crashes. This should not occur under normal (vanilla) conditions. However, if a beehive is broken by a fake player there are no players in range, and so we see a crash. * Checkstyle, my beloved * Remove public modifier * See see see * Fix Indigo handling of sculk sensor AO (FabricMC#3200) * Fix Indigo handling of sculk sensor AO. Fixes FabricMC#3153 * Split offset and mean formula lighting config options * Some more TAWs for block creation and block loot tables (FabricMC#3201) * Some more TAWs Added some TAWs for various methods in `Blocks` used to create certain types of blocks that mods may want to also create. Using these methods will allow them to ensure they have all the right block settings they need to stay consistent with vanilla blocks that use the same methods. * Add some fields from BlockLootTableGenerator useful fields from BlockLootTableGenerator. also cleaned up the datagen api's accesswidener file * Add the cherry grove to the floral biome tag (FabricMC#3202) * Ukrainian translations (FabricMC#3169) * Add files via upload * Add files via upload * A few transfer API improvements and deprecations (FabricMC#3204) * A few transfer API improvements and deprecations * Forward implementation of deprecated methods * Bump version * Start porting process for real this time Redid process of setting up QMJ and mixins.json for model_loading_v1, fixed registry sync access wideners First area of focus is going to be the new fapi dyn. registries, as they will likely require the most substantial work. * Implement compat with Fabric's Dynamic Registry API. * Implement compat with Fabric's Fabric Model Loading API (v1), replacing the old Model API (v0). Basically a drag-and-drop addition. * Remove mixin into QSL's DynamicMetaRegistryImpl that is not actively required, and in fact would potentially cause a breakage with QSL behavior. - Also began work on smaller compat changes, such as the FakePlayerTests gametest entry for fake player hive breakage. * Fix some QMJ related things * Run checkstyle and header application, apply fix to model-loading-api qmj * Revert weird change to RegistrySyncTest (blame codestyle auto-application?? I have no clue tbh) * Apply suggestions from code review Co-authored-by: Ennui Langeweile <[email protected]> * Upgrade to upstream FAPI 0.86.1 & QSL 6.1.0 - Involved manually copy-pasting in the changes from the following FAPI upstream commits: -- FabricMC#3222 (one-to-one) -- FabricMC#3216 (required some modification in FabricDynamicRegistryProvider to quiltify) -- FabricMC#3212 (one-to-one other than converting FMJ additions to QMJ) -- FabricMC#3219 does not have to be added as it is not an issue with QSL's 0.86.1 impl of the same concept - Removed/rewrote parts of the QFAPI impl of FAPI's Dynamic Registry API that are better supported by using QSL's equivalents - Applied checkstyle and licensing checks. No licensing changes were made, though checkstyle changes were. * Remove mixins removed in last commit from quilted_fabric_registry_sync_v0.mixins.json * Remove SaveLoadingMixin --------- Co-authored-by: Technici4n <[email protected]> Co-authored-by: embeddedt <[email protected]> Co-authored-by: PepperCode1 <[email protected]> Co-authored-by: Juuz <[email protected]> Co-authored-by: Kevin <[email protected]> Co-authored-by: Jonathan Coates <[email protected]> Co-authored-by: Shnupbups <[email protected]> Co-authored-by: maityyy <[email protected]> Co-authored-by: Un roman <[email protected]> Co-authored-by: modmuss50 <[email protected]> Co-authored-by: Ennui Langeweile <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The after bake modifier may receive a null baked model because
UnbakedModel#bakecan return a null baked model.Nullableannotations have been added where appropriate and the behavior of a null baked model has been explained in the modifier's documentation.Model Loading API v1 now contains a
"breaks"definition for Models v0 versions <0.4.0. Running v1 with v0 <0.4.0 causes errors that are very difficult to debug.