Fabric API Lookup #1234

Technici4n · 2020-12-21T01:21:27Z

Fabric API Lookup API v1

Introduction

This module allows Api instances to be associated with game objects without specifying how the association is implemented. This is useful when the same Api could be implemented more than once or implemented in different ways.

Many thanks to @grondag for providing the original concept (#1072).
Thanks also go to @i509VCB, @Pyrofab, @sfPlayer1 and the others who were involved with the design of this module.

This is the foundation upon which can be built for example a fluid transfer api (#1166). Closes #1199.

Flexible Api Querying

Block Api Usage example

Building blocks

This PR was changed a lot, please have a look at the README, the package info, and the javadoc for BlockApiLookup and ApiLookupMap for up-to-date documentation.

More usage examples

FastTransferLib (https://github.com/Technici4n/FastTransferLib) is an experiment to build an item, fluid and energy transfer api on top of this module. (Which was until recently called fabric-provider-api-v1.)

Missing things?

~~I could add an overload of BlockApiLookup#find with nullable BlockState and BlockEntity parameters, so that the caller can directly provide them if they are available for some reason.~~ Added in later commits.

There is no module to retrieve apis from items or entities yet because there were unsolved issues with those. The community can use the provided building blocks to experiment with their own implementations of ItemStackApiLookup and EntityApiLookup until the way forward becomes clear, but let's please not delay the BlockApiLookup because of that.

Yes it builds :)

Also includes stuff related to the util classes

…ters

CoolMineman

Has been nice to use and works well

i509VCB · 2021-02-22T00:26:22Z

...c-api-lookup-api-v1/src/main/java/net/fabricmc/fabric/api/lookup/v1/custom/ApiLookupMap.java

+ *     ＠Nullable
+ *     A find(ItemStack stack, C context);
+ *     // Expose the API for some item.
+ *     void register(ItemStackApiProvider<A, C> provider, Item item);


the reason checkstyle complained here is you need to use the html entity codes for < and >

Then it fails to render correctly as the {@code} tag already escapes them, I tried that first...

It won't render in IDE but the doclet will render it

gradlew javadoc was unable to render them correctly when I tried on my laptop - just disable the inspection and be done with it, there are more important things in life and javadoc escaping is weird anyway. :P

Fun fact: the ＠ symbol in the javadoc is not a regular @ 😆 (https://stackoverflow.com/a/46332643/13567109).

modmuss50 · 2021-02-22T00:38:40Z

Oops sorry @liach i didn’t mean to add you as a reviewer again. Feel free to though :)

liach

My previous questions are addressed already. Just a side note that when we add apiNote etc. command line tags, we should probably move <p>Note: to those tags.

Technici4n · 2021-02-22T00:47:17Z

I moved away from using @apiNote because gradlew javadoc tool didn't seem to recognize it.

liach · 2021-02-22T00:51:58Z

I moved away from using @apiNote because gradlew javadoc tool didn't seem to recognize it.

This is what you need https://github.com/FabricMC/yarn/blob/0025fbf845a27efa50d44ba1e2bac7c028eea57d/build.gradle#L722-L726

Technici4n · 2021-02-22T00:54:15Z

I moved away from using @apiNote because gradlew javadoc tool didn't seem to recognize it.

This is what you need https://github.com/FabricMC/yarn/blob/0025fbf845a27efa50d44ba1e2bac7c028eea57d/build.gradle#L722-L726

Ok that's interesting, will be good to have eventually.

grondag · 2021-02-28T06:56:12Z

I've scanned through this briefly and it seems consistent with the original intent and well-considered in its implementation. Nice job.

Would it support client-side lookups? From what I read it appeared it may be server-side only.

Technici4n · 2021-02-28T07:02:23Z

Thanks! Client-side lookups are possible, it's just that the BlockApiCache will not be usable with them because it takes a ServerWorld.
The regular BlockApiLookup takes a World and should work fine.

Player3324

Good now as far as I can tell. Thanks!

* Use "may not" instead of "cannot", and end sentences with a period. * Remove null checks for vararg parameters: passing a null vararg is unlikely and will cause an NPE directly anyway.

@grondag

# Fabric API Lookup API v1 ## Introduction This module allows Api instances to be associated with game objects without specifying how the association is implemented. This is useful when the same Api could be implemented more than once or implemented in different ways. Many thanks to @grondag for providing the original concept (#1072). Thanks also go to @i509VCB, @Pyrofab, @sfPlayer1 and the others who were involved with the design of this module. This is the foundation upon which can be built for example a fluid transfer api (#1166). Closes #1199. ## Flexible Api Querying ## Block Api Usage example ## Building blocks This PR was changed a lot, please have a look at the README, the package info, and the javadoc for `BlockApiLookup` and `ApiLookupMap` for up-to-date documentation. ## More usage examples FastTransferLib (https://github.com/Technici4n/FastTransferLib) is an experiment to build an item, fluid and energy transfer api on top of this module. (Which was until recently called `fabric-provider-api-v1`.) ## Missing things? ~~I could add an overload of `BlockApiLookup#find` with nullable `BlockState` and `BlockEntity` parameters, so that the caller can directly provide them if they are available for some reason.~~ Added in later commits. There is no module to retrieve apis from items or entities yet because there were unsolved issues with those. The community can use the provided building blocks to experiment with their own implementations of `ItemStackApiLookup` and `EntityApiLookup` until the way forward becomes clear, but let's please not delay the `BlockApiLookup` because of that. Co-authored-by: i509VCB <[email protected]> Co-authored-by: PepperBell <[email protected]> (cherry picked from commit dc716ea)

@grondag

# Fabric API Lookup API v1 ## Introduction This module allows Api instances to be associated with game objects without specifying how the association is implemented. This is useful when the same Api could be implemented more than once or implemented in different ways. Many thanks to @grondag for providing the original concept (FabricMC#1072). Thanks also go to @i509VCB, @Pyrofab, @sfPlayer1 and the others who were involved with the design of this module. This is the foundation upon which can be built for example a fluid transfer api (FabricMC#1166). Closes FabricMC#1199. ## Flexible Api Querying ## Block Api Usage example ## Building blocks This PR was changed a lot, please have a look at the README, the package info, and the javadoc for `BlockApiLookup` and `ApiLookupMap` for up-to-date documentation. ## More usage examples FastTransferLib (https://github.com/Technici4n/FastTransferLib) is an experiment to build an item, fluid and energy transfer api on top of this module. (Which was until recently called `fabric-provider-api-v1`.) ## Missing things? ~~I could add an overload of `BlockApiLookup#find` with nullable `BlockState` and `BlockEntity` parameters, so that the caller can directly provide them if they are available for some reason.~~ Added in later commits. There is no module to retrieve apis from items or entities yet because there were unsolved issues with those. The community can use the provided building blocks to experiment with their own implementations of `ItemStackApiLookup` and `EntityApiLookup` until the way forward becomes clear, but let's please not delay the `BlockApiLookup` because of that. Co-authored-by: i509VCB <[email protected]> Co-authored-by: PepperBell <[email protected]>

@grondag

# Fabric API Lookup API v1 ## Introduction This module allows Api instances to be associated with game objects without specifying how the association is implemented. This is useful when the same Api could be implemented more than once or implemented in different ways. Many thanks to @grondag for providing the original concept (FabricMC#1072). Thanks also go to @i509VCB, @Pyrofab, @sfPlayer1 and the others who were involved with the design of this module. This is the foundation upon which can be built for example a fluid transfer api (FabricMC#1166). Closes FabricMC#1199. ## Flexible Api Querying ## Block Api Usage example ## Building blocks This PR was changed a lot, please have a look at the README, the package info, and the javadoc for `BlockApiLookup` and `ApiLookupMap` for up-to-date documentation. ## More usage examples FastTransferLib (https://github.com/Technici4n/FastTransferLib) is an experiment to build an item, fluid and energy transfer api on top of this module. (Which was until recently called `fabric-provider-api-v1`.) ## Missing things? ~~I could add an overload of `BlockApiLookup#find` with nullable `BlockState` and `BlockEntity` parameters, so that the caller can directly provide them if they are available for some reason.~~ Added in later commits. There is no module to retrieve apis from items or entities yet because there were unsolved issues with those. The community can use the provided building blocks to experiment with their own implementations of `ItemStackApiLookup` and `EntityApiLookup` until the way forward becomes clear, but let's please not delay the `BlockApiLookup` because of that. Co-authored-by: i509VCB <[email protected]> Co-authored-by: PepperBell <[email protected]> (cherry picked from commit dc716ea)

i509VCB and others added 20 commits October 25, 2020 16:45

Implement the item and block providers for provider api.

c38d075

Yes it builds :)

NotNull is implicit; so remove instances of it

7a1ab86

Some javadoc for context key

e1f0ed2

Inline some api lookup return values

a9ba2a4

Add first iteration of provider api test mod

3bd4cde

Reorder no context field so static block is not needed.

85e56eb

Fix a bug related to testmod block entity not checking if it has a world

91980b6

Also includes stuff related to the util classes

Add block entity caches

8b48098

Add fallback providers

77d8821

Merge branch '1.16' into api-provider

10881ca

Inline ContextKey, remove ApiLookup, add Class<T> and Class<C> parame…

0aa755e

…ters

Add item fallback providers

fa81038

Add javadoc for BlockApiLookup

fd63147

Javadoc fixes, build.gradle update and version bump

64c61d8

Add a BlockState parameter to BlockApiProvider

58a1cb0

Bye items 🦀

4f149eb

Rename to fabric-api-lookup-api-v1 and add package-info.java

8d20007

Document all api classes, and fix the memory leak in the cache

d3b050d

Make docs a bit less insane

ed5f626

Revert build.gradle changes

0cd4e36

CoolMineman approved these changes Dec 21, 2020

View reviewed changes

i509VCB added enhancement New feature or request new module Pull requests that introduce new modules reviews needed This PR needs more reviews tests PR has tests labels Dec 21, 2020

i509VCB requested review from i509VCB, modmuss50, Player3324 and a team December 21, 2020 01:36

Add example code to javadoc

da3072b

i509VCB reviewed Feb 22, 2021

View reviewed changes

Documentation fixes

74b89fb

modmuss50 requested review from modmuss50 and liach February 22, 2021 00:38

liach approved these changes Feb 22, 2021

View reviewed changes

Technici4n changed the title ~~Fabric Api Lookup~~ Fabric API Lookup Feb 22, 2021

Technici4n mentioned this pull request Feb 24, 2021

Switch energy API TechReborn/TechReborn#2355

Closed

Player3324 approved these changes Mar 2, 2021

View reviewed changes

Player3324 added status: last call If you care, make yourself heard right away! and removed reviews needed This PR needs more reviews labels Mar 2, 2021

Fix checkstyle.xml typo

bbac8fd

Mysterious-Dev approved these changes Mar 2, 2021

View reviewed changes

marcus8448 approved these changes Mar 3, 2021

View reviewed changes

Technici4n added 2 commits March 4, 2021 15:11

Slightly improve non-nullability checks

4c5cead

Tidy null checks.

80a0ea3

* Use "may not" instead of "cannot", and end sentences with a period. * Remove null checks for vararg parameters: passing a null vararg is unlikely and will cause an NPE directly anyway.

modmuss50 added the status: merge me please Pull requests that are ready to merge label Mar 8, 2021

Fix tiny javadoc mistake

01a0035

modmuss50 merged commit dc716ea into FabricMC:1.16 Mar 8, 2021

This was referenced Mar 8, 2021

Add ItemApiLookup #1351

Closed

Add ItemApiLookup #1352

Merged

Fabric Transfer API: "fluid only" edition #1356

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fabric API Lookup #1234

Fabric API Lookup #1234

Uh oh!

Technici4n commented Dec 21, 2020 •

edited

Loading

Uh oh!

CoolMineman left a comment

Uh oh!

i509VCB Feb 22, 2021

Uh oh!

Technici4n Feb 22, 2021

Uh oh!

i509VCB Feb 22, 2021

Uh oh!

Technici4n Feb 22, 2021

Uh oh!

Technici4n Feb 22, 2021

Uh oh!

modmuss50 commented Feb 22, 2021

Uh oh!

liach left a comment

Uh oh!

Technici4n commented Feb 22, 2021 •

edited

Loading

Uh oh!

liach commented Feb 22, 2021

Uh oh!

Technici4n commented Feb 22, 2021

Uh oh!

grondag commented Feb 28, 2021

Uh oh!

Technici4n commented Feb 28, 2021

Uh oh!

Player3324 left a comment

Uh oh!

Uh oh!

Fabric API Lookup #1234

Fabric API Lookup #1234

Uh oh!

Conversation

Technici4n commented Dec 21, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Fabric API Lookup API v1

Introduction

Flexible Api Querying

Block Api Usage example

Building blocks

More usage examples

Missing things?

Uh oh!

CoolMineman left a comment

Choose a reason for hiding this comment

Uh oh!

i509VCB Feb 22, 2021

Choose a reason for hiding this comment

Uh oh!

Technici4n Feb 22, 2021

Choose a reason for hiding this comment

Uh oh!

i509VCB Feb 22, 2021

Choose a reason for hiding this comment

Uh oh!

Technici4n Feb 22, 2021

Choose a reason for hiding this comment

Uh oh!

Technici4n Feb 22, 2021

Choose a reason for hiding this comment

Uh oh!

modmuss50 commented Feb 22, 2021

Uh oh!

liach left a comment

Choose a reason for hiding this comment

Uh oh!

Technici4n commented Feb 22, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

liach commented Feb 22, 2021

Uh oh!

Technici4n commented Feb 22, 2021

Uh oh!

grondag commented Feb 28, 2021

Uh oh!

Technici4n commented Feb 28, 2021

Uh oh!

Player3324 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Technici4n commented Dec 21, 2020 •

edited

Loading

Technici4n commented Feb 22, 2021 •

edited

Loading