update docs for GroovyScript 1.3.0 (#52)

* update docs

* update vanilla

* update more unique docs

* enhance object mapper documentation

Author: WaitingIdly

docs/groovy-script/getting_started/groovy_log.md

@@ -27,9 +27,11 @@ This can help improve readability of the log file, yet may hide errors that stil
 ## Interacting
 
 
-There are six main ways to add messages to the log file.
+There are seven main ways to add messages to the log file.
 Each has a different purpose and level of severity.
 
+The most basic way is calling `log(String)`, which logs the message on the info channel.
+
 When adding messages to the log via these methods,
 the time, side, log channel, currently loaded script, and currently running line
 will be printed to the log file.
@@ -51,7 +53,7 @@ the [debug](./run_config.md#debug) option in the [`runConfig.json`](./run_config
 ### Info
 
 
-Called via `log.info(String)`, this indicates that the information is
+Called via either `log(String)` or `log.info(String)`, this indicates that the information is
 used to provide a record of the normal operation of the system.
 
 

docs/groovy-script/getting_started/object_mappers.md

@@ -66,3 +66,65 @@ Currently, the best way to observe what Object Mappers will do is to use the Lan
 :::
 
 - [All Vanilla Object Mappers](../minecraft/vanilla_object_mappers.md)
+
+
+## General Methods
+
+
+Many Object Mappers share the same set of the methods.
+Many of these methods utilize [Operator Overloading](../groovy/operators.md#operator-overloading),
+which allows things like `item(...)` to be an alias of `item.call(...)`.
+
+
+### Retrieval
+
+Using `call(...)` returns the relevant data of the Object Mapper,
+and is the primary purpose of an Object Mapper's existence.
+<br>
+Every Object Mapper has this capability, with the parameters varying based on the Object Mapper.
+
+See above for examples of this.
+
+
+### Default Value
+
+
+Using `call()` without any parameters will attempt to return
+the default value of the Object Mapper, presuming it exists.
+If it does not exist, `null` will be returned instead
+<br>
+Some Object Mappers have this functionality.
+
+::: info Example {id="example"}
+
+```groovy
+item()        // returns ItemStack.EMPTY
+block()       // returns Blocks.AIR
+creativeTab() // returns CreativeTabs.SEARCH
+```
+
+:::
+
+
+### Inversion
+
+
+Using `mod(...)` returns a String that can create the retrieval method
+of the parameter, presuming that the parameter is of the type that the Object Mapper returns.
+<br>
+The main purpose of this is to convert an object obtained through some means
+into text interpretable by GroovyScript.
+For some Object Mappers, there are multiple valid ways to retrieve the same object -
+in such a situation, the return value will only be one of those ways.
+<br>
+Most Object Mappers have this capability.
+
+::: info Example {id="example"}
+
+```groovy
+log(item % item('minecraft:clay')) // returns item('minecraft:clay')
+log(blockstate % blockstate('minecraft:log:0')) // returns blockstate('minecraft:log', 'axis=y', 'variant=oak')
+log(item % minecraft.getAllItems()) // returns a String for every item from vanilla minecraft
+```
+
+:::

docs/groovy-script/getting_started/run_config.md

@@ -79,23 +79,31 @@ It currently doesn't do anything special.
 If this is false all messages that logged to debug will not be logged.
 This setting is great for debugging, as it adds additional information to the [`groovy.log`](./groovy_log.md)
 and logs the line numbers in errors.
+<br>
+This also controls if [keybindings](../minecraft/keybindings.md) are bound by default.
 - Can be accessed in a script via `isDebug()`.
 
 ## `classes`
 
 This *was* an element used to control what files were loaded as class files
 prior to [GroovyScript 1.2.3](https://github.com/CleanroomMC/GroovyScript/tree/v1.2.3).
 
-::: info Failure {id="failure"}
+:::: info Warning {id="warning"}
 
-If `classes` is an element in your `runConfig.json` file, a fatal message will be logged
-and you **must** remove it in order to be able to launch.
+If `classes` is an element in your `runConfig.json` file, a error message will be logged.
 
 Instead, load your classes via one of the loaders - typically [`preInit`](#preinit).
 To migrate in this fashion, simply add `"classes/"` to the `preInit` loader.
 
+::: info Failure {id="failure"}
+
+Prior to [GroovyScript 1.3.0](https://github.com/CleanroomMC/GroovyScript/tree/v1.3.0)
+this would generate a fatal error, crashing the game.
+
 :::
 
+::::
+
 :::: details Prior to GroovyScript 1.2.3 {id="warning"}
 
 Files that contain a single class should be specified here.

docs/groovy-script/minecraft/helpers/command.md

@@ -16,9 +16,7 @@ Create custom commands, either generally or specifically for the client.
 Refer to this via any of the following:
 
 ```groovy:no-line-numbers {1}
-command/* Used as page default */ // [!code focus]
-Command
-minecraft.command
+minecraft.command/* Used as page default */ // [!code focus]
 minecraft.Command
 Minecraft.command
 Minecraft.Command
@@ -40,48 +38,48 @@ mods.minecraft.Command
 - Registers the given command to the client:
 
     ```groovy:no-line-numbers
-    command.registerClientCommand(ICommand)
+    minecraft.command.registerClientCommand(ICommand)
     ```
 
 - Registers the given command to the client in the format `name`, `command`, with `command` being a Closure taking 3 parameters, `MinecraftServer server`, `ICommandSender sender`, and `String... args`:
 
     ```groovy:no-line-numbers
-    command.registerClientCommand(String, SimpleCommand.ICommand)
+    minecraft.command.registerClientCommand(String, SimpleCommand.ICommand)
     ```
 
 - Registers the given command to the client in the format `name`, `usage`, `command`, with `command` being a Closure taking 3 parameters, `MinecraftServer server`, `ICommandSender sender`, and `String... args`:
 
     ```groovy:no-line-numbers
-    command.registerClientCommand(String, String, SimpleCommand.ICommand)
+    minecraft.command.registerClientCommand(String, String, SimpleCommand.ICommand)
     ```
 
 - Registers the given command to the given command handler, in the format `handler`, `command`:
 
     ```groovy:no-line-numbers
-    command.registerCommand(CommandHandler, ICommand)
+    minecraft.command.registerCommand(CommandHandler, ICommand)
     ```
 
 - Registers the given command:
 
     ```groovy:no-line-numbers
-    command.registerCommand(ICommand)
+    minecraft.command.registerCommand(ICommand)
     ```
 
 - Registers the given command in the format `name`, `command`, with `command` being a Closure taking 3 parameters, `MinecraftServer server`, `ICommandSender sender`, and `String... args`:
 
     ```groovy:no-line-numbers
-    command.registerCommand(String, SimpleCommand.ICommand)
+    minecraft.command.registerCommand(String, SimpleCommand.ICommand)
     ```
 
 - Registers the given command in the format `name`, `usage`, `command`, with `command` being a Closure taking 3 parameters, `MinecraftServer server`, `ICommandSender sender`, and `String... args`:
 
     ```groovy:no-line-numbers
-    command.registerCommand(String, String, SimpleCommand.ICommand)
+    minecraft.command.registerCommand(String, String, SimpleCommand.ICommand)
     ```
 
 :::::::::: details Example {open id="example"}
 ```groovy:no-line-numbers
-command.registerCommand('groovy_test', { server, sender, args -> sender.sendMessage('Hello from GroovyScript')})
+minecraft.command.registerCommand('groovy_test', { server, sender, args -> sender.sendMessage('Hello from GroovyScript')})
 ```
 
 ::::::::::

docs/groovy-script/minecraft/helpers/furnace.md

@@ -1,15 +1,19 @@
 ---
 title: "Furnace"
 titleTemplate: "Minecraft | CleanroomMC"
-description: "Converts an input item into an output itemstack after a set amount of time, with the ability to give experience and using fuel to run."
+description: "Converts an input item into an output itemstack after a configurable amount of time, with the ability to give experience and using fuel to run. Can also convert the item in the fuel slot."
 source_code_link: "https://github.com/CleanroomMC/GroovyScript/blob/master/src/main/java/com/cleanroommc/groovyscript/compat/vanilla/Furnace.java"
 ---
 
 # Furnace (Minecraft)
 
 ## Description
 
-Converts an input item into an output itemstack after a set amount of time, with the ability to give experience and using fuel to run.
+Converts an input item into an output itemstack after a configurable amount of time, with the ability to give experience and using fuel to run. Can also convert the item in the fuel slot.
+
+:::::::::: details Note {open id="note"}
+Fuel Conversion Recipes may not function as desired in all furnaces - only the vanilla furnace has specific support. By default the only recipe reproduces the vanilla behavior of a wet sponge converting an empty bucket into a water bucket.
+::::::::::
 
 ## Identifier
 
@@ -49,10 +53,30 @@ mods.minecraft.Furnace
     furnace.add(IIngredient, ItemStack, float)
     ```
 
+- Adds a recipe in the format `input`, `output`, `experience`, `time`:
+
+    ```groovy:no-line-numbers
+    furnace.add(IIngredient, ItemStack, float, int)
+    ```
+
+- Add the given recipe to the recipe list:
+
+    ```groovy:no-line-numbers
+    furnace.addFuelConversion(CustomFurnaceManager.FuelConversionRecipe)
+    ```
+
+- Add a conversion recipe in the format `smelted`, `fuel`, with `fuel` using an IIngredient transformer:
+
+    ```groovy:no-line-numbers
+    furnace.addFuelConversion(IIngredient, IIngredient)
+    ```
+
 :::::::::: details Example {open id="example"}
 ```groovy:no-line-numbers
 furnace.add(ore('ingotIron'), item('minecraft:diamond'))
 furnace.add(item('minecraft:nether_star'), item('minecraft:clay') * 64, 13)
+furnace.add(item('minecraft:diamond'), item('minecraft:clay'), 2, 50)
+furnace.addFuelConversion(item('minecraft:diamond'), item('minecraft:bucket').transform(item('minecraft:lava_bucket')))
 ```
 
 ::::::::::
@@ -91,10 +115,17 @@ Don't know what a builder is? Check [the builder info page](../../getting_starte
     output(Collection<ItemStack>)
     ```
 
-- `float`. Sets the experience rewarded for smelting the given input. Requires greater than or equal to 0. (Default `0.0f`).
+- `float`. Sets the experience rewarded for smelting the given input. Requires greater than or equal to 0. (Default `0.1f`).
 
     ```groovy:no-line-numbers
     exp(float)
+    experience(float)
+    ```
+
+- `int`. Sets the time in ticks the recipe takes. Requires greater than or equal to 1. (Default `200`).
+
+    ```groovy:no-line-numbers
+    time(int)
     ```
 
 ---
@@ -125,7 +156,7 @@ furnace.recipeBuilder()
 - Removes all recipes that match the given input:
 
     ```groovy:no-line-numbers
-    furnace.removeByInput(ItemStack)
+    furnace.removeByInput(IIngredient)
     ```
 
 - Removes all recipes that match the given output:
@@ -134,23 +165,49 @@ furnace.recipeBuilder()
     furnace.removeByOutput(IIngredient)
     ```
 
+- Removes the given recipe from the recipe list:
+
+    ```groovy:no-line-numbers
+    furnace.removeFuelConversion(CustomFurnaceManager.FuelConversionRecipe)
+    ```
+
+- Removes all conversion recipes with the given smelted item:
+
+    ```groovy:no-line-numbers
+    furnace.removeFuelConversionBySmeltedStack(ItemStack)
+    ```
+
 - Removes all registered recipes:
 
     ```groovy:no-line-numbers
     furnace.removeAll()
     ```
 
+- Removes all conversion recipes:
+
+    ```groovy:no-line-numbers
+    furnace.removeAllFuelConversions()
+    ```
+
 :::::::::: details Example {open id="example"}
 ```groovy:no-line-numbers
-furnace.removeByInput(item('minecraft:clay'))
+furnace.removeByInput(item('minecraft:clay:*'))
 furnace.removeByOutput(item('minecraft:brick'))
+furnace.removeFuelConversionBySmeltedStack(item('minecraft:sponge', 1))
 furnace.removeAll()
+furnace.removeAllFuelConversions()
 ```
 
 ::::::::::
 
 ## Getting the value of recipes
 
+- Iterates through every entry in the registry, with the ability to call remove on any element to remove it:
+
+    ```groovy:no-line-numbers
+    furnace.streamFuelConversions()
+    ```
+
 - Iterates through every entry in the registry, with the ability to call remove on any element to remove it:
 
     ```groovy:no-line-numbers

docs/groovy-script/minecraft/helpers/game_rule.md

@@ -20,12 +20,8 @@ GameRules are case-sensitive! Enable logging of new GameRules via `setWarnNewGam
 Refer to this via any of the following:
 
 ```groovy:no-line-numbers {2}
-gamerule
-game_rule/* Used as page default */ // [!code focus]
-gameRule
-GameRule
 minecraft.gamerule
-minecraft.game_rule
+minecraft.game_rule/* Used as page default */ // [!code focus]
 minecraft.gameRule
 minecraft.GameRule
 Minecraft.gamerule
@@ -60,12 +56,12 @@ mods.minecraft.GameRule
 - Sets if creating new GameRules logs a warning. Enable it if you need to check spelling/capitalization. Disabled by default:
 
     ```groovy:no-line-numbers
-    game_rule.setWarnNewGameRule(boolean)
+    minecraft.game_rule.setWarnNewGameRule(boolean)
     ```
 
 :::::::::: details Example {open id="example"}
 ```groovy:no-line-numbers
-game_rule.setWarnNewGameRule(true)
+minecraft.game_rule.setWarnNewGameRule(true)
 ```
 
 ::::::::::
@@ -75,19 +71,19 @@ game_rule.setWarnNewGameRule(true)
 - Adds a map of GameRule name to values:
 
     ```groovy:no-line-numbers
-    game_rule.add(Map<String, String>)
+    minecraft.game_rule.add(Map<String, String>)
     ```
 
 - Adds a new entry in the format `name`, `value`, with `value` being a String that can represent a number (`-1`, `5`) or boolean (`true`, `false`):
 
     ```groovy:no-line-numbers
-    game_rule.add(String, String)
+    minecraft.game_rule.add(String, String)
     ```
 
 :::::::::: details Example {open id="example"}
 ```groovy:no-line-numbers
-game_rule.add(['mobGriefing': 'false', 'keepInventory': 'true'])
-game_rule.add('doDaylightCycle', 'false')
+minecraft.game_rule.add(['mobGriefing': 'false', 'keepInventory': 'true'])
+minecraft.game_rule.add('doDaylightCycle', 'false')
 ```
 
 ::::::::::