This is a public, read-only report. Striff reads this repository's docs, turns each sentence that makes a claim about the code into a rule, and checks the rule against the code on the default branch. How this works
Each sentence below has a stale name: a type the default branch doesn't declare, or declares somewhere else. Edit the doc so it matches the code, or bring the type back.
GoneIGridHelper
Both owner and listener have to be passed together to IGridHelper to create a node to allow the listener to be reused while still having type-safe access to the owner.
The repository once had src/main/java/appeng/api/networking/IGridHelper.java. It doesn't now. Closest name there: GridHelper.
The AEKey class is the base for all keys, whether they represent items (AEItemKey) or fluids (AEFluidKey).
2 rules from this sentence
AEItemKey extends AEKey
Holds
AEFluidKey extends AEKey
Holds
Read Oct 2
Each type of key is represented by an instance of AEKeyType, which is accessible via AEKey.getType().
2 rules from this sentence
AEKey has a getType method
Holds
AEKey depends on AEKeyType
Holds
Read Oct 2
Keys can be saved to from NBT using toTagGeneric, which also stores a reference to their type so that AEKey.fromTagGeneric can restore the key of the correct type.
2 rules from this sentence
AEKey has toTagGeneric
Holds
AEKey has fromTagGeneric
Holds
Read Oct 2
The same mechanism can be used for packets with AEKey.writeToPacket and AEKey.readKey.
2 rules from this sentence
AEKey has writeToPacket
Holds
AEKey has readKey
Holds
Read Oct 2
They need to know their location and world when being created with IManagedGridNode.create(Level, BlockPos).
IManagedGridNode has a create method
Holds
Read Oct 2
To expose the actual IGridNode, it needs to be exposed by IManagedGridNode.getNode() through an appropriate way like capabilities.
IManagedGridNode has a getNode method
Holds
Read Oct 2
Services can be retrieved by calling IGrid#getService by passing the grid service's interface.
IGrid has getService
Holds
Read Oct 2
IGrid.getStorageService
IGrid has getStorageService
Holds
Read Oct 2
To create a custom upgrade card that behaves like the existing AE2 cards (i.e. it can be inserted into the network tool's toolbelt), use the utility function Upgrades#createUpgradeCardItem to create an item for your card.
Upgrades has a createUpgradeCardItem method
Holds
Read Oct 2
The Upgrades.add method allows you to link an upgrade card (represented by its Item) with a Machine (also represented by an item, usually a BlockItem or IPartItem).
Upgrades has an add method
Holds
Read Oct 2
For the machine version created by forMachine, you are responsible for saving the inventory yourself from the change callback.
UpgradeInventories has forMachine
Holds
Read Oct 2
For the item version created by forItem, the upgrade inventory will automatically save itself to the provided ´ItemStack` whenever its content changes.
UpgradeInventories has forItem
Holds
Read Oct 2
NoOpKeyFilter is provided in case you want all types of keys, otherwise there are the convenience filters AEItemKey.filter() and AEFluidKey.filter() to only retrieve items or fluids.
2 rules from this sentence
AEItemKey has a filter method
Holds
AEFluidKey has a filter method
Holds
Read Oct 2
Since storage has been unified across types, the storage service will now call mountInventories on the IStorageProvider service provided by any grid node and allow the node to "mount" storage into the network.
IStorageProvider has mountInventories
Holds
Read Oct 2
When the node wants to remove or add storage due to an external event or config change, it can request the storage to repeat the mounting process by calling IStorageGrid.refreshNodeStorageProvider or using the utility provided in IStorageProvider.requestUpdate.
IStorageProvider has requestUpdate
Holds
20 rules from 1 doc
See these where the change is. The browser extension puts a pull request's doc findings, and a diagram of what it changed, on the GitHub page itself, so the code and what your docs say about it are side by side.
