Added usage syntax to the documentation for buildValidSubstitutes and buildSubstitutes

This commit is contained in:
PhlegethonAcheron 2022-03-20 15:41:25 -04:00
parent 8c2aae2ddc
commit 6aadd00e72

View File

@ -234,6 +234,8 @@ public final class Settings {
* A mapping of blocks to blocks treated as correct in their position * A mapping of blocks to blocks treated as correct in their position
* <p> * <p>
* If a schematic asks for a block on this mapping, all blocks on the mapped list will be accepted at that location as well * If a schematic asks for a block on this mapping, all blocks on the mapped list will be accepted at that location as well
* <p>
* Syntax same as <a href="https://baritone.leijurv.com/baritone/api/Settings.html#buildSubstitutes">buildSubstitutes</a>
*/ */
public final Setting<Map<Block, List<Block>>> buildValidSubstitutes = new Setting<>(new HashMap<>()); public final Setting<Map<Block, List<Block>>> buildValidSubstitutes = new Setting<>(new HashMap<>());
@ -241,6 +243,15 @@ public final class Settings {
* A mapping of blocks to blocks to be built instead * A mapping of blocks to blocks to be built instead
* <p> * <p>
* If a schematic asks for a block on this mapping, Baritone will place the first placeable block in the mapped list * If a schematic asks for a block on this mapping, Baritone will place the first placeable block in the mapped list
* <p>
* Usage Syntax:
* <pre>
* sourceblockA->blockToSubstituteA1,blockToSubstituteA2,...blockToSubstituteAN,sourceBlockB->blockToSubstituteB1,blockToSubstituteB2,...blockToSubstituteBN,...sourceBlockX->blockToSubstituteX1,blockToSubstituteX2...blockToSubstituteXN
* </pre>
* Example:
* <pre>
* stone->cobblestone,andesite,oak_planks->birch_planks,acacia_planks,glass
* </pre>
*/ */
public final Setting<Map<Block, List<Block>>> buildSubstitutes = new Setting<>(new HashMap<>()); public final Setting<Map<Block, List<Block>>> buildSubstitutes = new Setting<>(new HashMap<>());