mirror of https://github.com/FabricMC/fabric.git synced 2024-11-23 16:18:29 -05:00

History

modmuss d48ec150ba Some checks failed Build / build (21-ubuntu) (push) Has been cancelled Details Build / client_test (push) Has been cancelled Details Build / server_test (push) Has been cancelled Details Build / check_resources (push) Has been cancelled Details 24w36a (#4068 ) * 24w36a * Some fixes * More work * Fixes * Update yarn * Update fabric loader * Bump versions		2024-09-05 11:42:30 +01:00
..
src	24w36a (#4068 )	2024-09-05 11:42:30 +01:00
build.gradle	Port to 24w33a (#4033 )	2024-08-18 19:16:27 +01:00
README.md	Entity API Lookup (#1836 )	2021-12-03 13:38:35 +00:00

README.md

Fabric API Lookup API (v1)

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. See also the package-info.java file.

What we call an API is any object that can be offered or queried, possibly by different mods, to be used in an agreed-upon manner.
This module allows flexible retrieving of such APIs, represented by the generic type A, from blocks in the world or from item stacks.
It also provides building blocks for defining custom ways of retrieving APIs from other game objects.

Retrieving APIs from blocks

See the javadoc of BlockApiLookup for a full usage example.

`BlockApiLookup`

The primary way of querying API instances for blocks in the world. It exposes a find function to retrieve an API instance, and multiple register* functions to register APIs for blocks and block entities.

Instances can be obtained using the get function.

`BlockApiCache`

A BlockApiLookup bound to a position and a server world, allowing much faster repeated API queries.

Retrieving APIs from items

See the javadoc of ItemApiLookup for a full usage example.

`ItemApiLookup`

The way to query API instances from item stacks. It exposes a find function to retrieve an API instance, and multiple register* functions to register APIs for items.

Retrieving APIs from entities

See the javadoc of EntityApiLookup for a full usage example.

`EntityApiLookup`

The way to query API instances from entities. Exposes a find function to retrieve an API instance, and multiple register* functions to register APIs for entity types.

Retrieving APIs from custom objects

The subpackage custom provides helper classes to accelerate implementations of ApiLookups for custom objects, similar to the existing BlockApiLookup, but with different query parameters.

`ApiLookupMap`

A map meant to be used as the backing storage for custom ApiLookup instances, to implement a custom equivalent of BlockApiLookup#get.

`ApiProviderMap`

A fast thread-safe copy-on-write map meant to be used as the backing storage for registered providers.