Maintenance script: AnotherBackpackContent wiki

2026-10-19T13:44:57Z

AnotherBackpackContent wiki

New page

Other mods can find the backpacks a player carries and move items into or out of them. [[AnotherBackpackContent:Better Storage|Better Storage]] uses this for its Backpacks box.

== Overview ==
The public API is the class <code>com.cyberpiratepenguin.anotherbackpackcontent.api.BackpackAPI</code>. Everything outside the <code>api</code> package is internal and may change in any version.
{| class="wikitable"
! Member !! Purpose
|-
| <code>API_VERSION</code> || <code>int</code>, currently <code>1</code>. Goes up with every new method. Existing methods stay.
|-
| <code>isBackpack(ItemStack stack)</code> || Whether the stack is a backpack from this mod.
|-
| <code>backpacks(Ref<EntityStore> player, ComponentAccessor<EntityStore> accessor)</code> || The contents of every backpack the player carries, as a <code>List<ItemContainer></code>, in the order hotbar, inventory, backpack slots, utility slot.
|}

== Using the containers ==
* Each container carries the filter of its backpack. <code>addItemStack</code> and <code>moveItemStackFromSlot</code> only let in what belongs there.
* Every change is written into the backpack item right away. You don't need to save anything.
* The containers are the same instances an open backpack window and the auto-pickup use, so writing to them at the same time doesn't overwrite anything.
* Call the API from the '''world thread''' only.

== Depending on the mod ==
The signatures in <code>BackpackAPI</code> are stable. To keep your mod working without Another Backpack Content, call the API through reflection, the way Better Storage does, and list the mod as an optional dependency in your manifest:
<pre>
"OptionalDependencies": {
"com.cyberpiratepenguin:anotherbackpackcontent": "*"
}
</pre>

Check <code>API_VERSION</code> before you call a method that was added later.

== Item IDs ==
Backpack IDs follow the scheme <code>ABC_Backpack_<Kind>_<Size></code>:
* Kind: <code>Miner</code>, <code>Digger</code>, <code>Forester</code>, <code>Hunter</code>, <code>Builder</code>, <code>Adventurer</code>
* Size: <code>Small</code>, <code>Medium</code>, <code>Big</code>

For example <code>ABC_Backpack_Hunter_Big</code>. All backpacks carry the tags <code>Type: Utility</code> and <code>Family: Backpack</code>.

{{AnotherBackpackContent Nav}}

AnotherBackpackContent:Modding API - Revision history

Maintenance script: AnotherBackpackContent wiki