diff --git a/src/main/javadoc/overview.html b/src/main/javadoc/overview.html index 96c47577..662aa518 100644 --- a/src/main/javadoc/overview.html +++ b/src/main/javadoc/overview.html @@ -251,5 +251,34 @@ The code for placeBlock() and spawnHint() will be left as an exercise for the re
Please refer to {@link com.gtnewhorizon.structurelib.StructureEvent} to see what events are available.
++ Inventory Providers are classes that retrieve an Iterable of ItemStacks for examination, given an EntityPlayerMP as identifier. + They are also responsible for marking the relevant item container as dirty, so changes can be commited to disk properly when world save happens. + Examples include: main player inventory, vanilla ender chest, baubles inventory. StructureLib comes with main player inventory and vanilla ender chest built in. +
++ Stack Extractors are classes that retrieve items from another item. + Examples include: Forestry backpacks, ME network over ME Wireless Terminals. +
++Both of these are managed internally by {@link com.gtnewhorizon.structurelib.SortedRegistry}. +By default, elements registered will be sorted in lexicographical order in ascending order. +However, facilities in StructureLib will allow an end user to tweak these registries as their wish. +They can disable, reorder, reenable any element within the registry, either in game, at main menu or with the game stopped, +Their changes will be synced to server as well, should they be playing on a dedicated server. +
++ This has the following important implications +
+