Material Creation, Properties, Flags, and Modification documentation (#3912)

Co-authored-by: Jurre Groenendijk <[email protected]>

Author: Phoenixvine32908

docs/content/Modpacks/Changes/v7.2.0.md

@@ -15,9 +15,13 @@ in the MachineDefinition, you need to add `.modelProperty(GTMachineModelProperti
 
 ## Ranged inputs/outputs
 In recipes, you can now use:
+
 - `.itemInputsRanged(..., min, max)`
-- `.itemOutputssRanged(..., min, max)`
+
+- `.itemOutputsRanged(..., min, max)`
+
 - `.fluidInputsRanged(..., min, max)`
+
 - `.fluidOutputsRanged(..., min, max)`
 
 Where the inputs or outputs will be rolled inclusively from min to max.

…/Examples/Superheated_Pyrolyzing_Oven.md …acks/Examples/Example_Coil_Multiblock.mddocs/content/Modpacks/Examples/Superheated_Pyrolyzing_Oven.md renamed to docs/content/Modpacks/Examples/Example_Coil_Multiblock.md docs/content/Modpacks/Examples/Superheated_Pyrolyzing_Oven.md renamed to docs/content/Modpacks/Examples/Example_Coil_Multiblock.md

@@ -1,5 +1,5 @@
 ---
-title: "Superheated Pyrolyzing Oven"
+title: "Example Coil Multiblock"
 ---
 
 ### Superheated Pyrolyzing Oven Multiblock (by Phoenixvine)
@@ -105,4 +105,3 @@ Below is an example of a multiblock using the CoilWorkableElectricMultiblockMach
 
 
 
-

docs/content/Modpacks/Materials-and-Elements/01-Material-Creation.md

@@ -4,83 +4,49 @@ title: Material Creation
 
 
 Materials are in-game items or fluids. They can be dusts, ingots, gems, fluids and all their derivatives.
-To make a new material, write an `event.create()` call in the registering function, like in the examples.
-Write inside the parentheses the name of the material inside `''` or `""`.
-(**NOTE**: to add a material that is present on the periodic table, but doesn't have any in-game items/fluids, look below for how to do it)
+!!! note
+    To add a material that is present on the periodic table, but doesn't have any in-game items/fluids, look at the [material modification page](./Modifying-Existing-Materials.md).
 
 You can change the properties of the material by adding any combination of the following calls:
 
 - `.ingot()` will make the material have both an ingot and dust form.
 - `.dust()` will make the material have a dust form. Don't use this together with `.ingot()`.
-- `.gem()` will make the material have both a gem form and a dust form. Don't use those together with `.dust()` or `.ingot()`
+- `.gem()` will make the material have both a gem form and a dust form. Don't use those together with `.dust()` or `.ingot()`.
 - `.liquid()` will make the material have a liquid (fluid) form with liquid properties.
+- `.block()` will make the material have a placeable (block) fluid form. Requires `.liquid()`.
 - `.gas()` will make the material have a gas (fluid) form with gas properties.
 - `.plasma()` will make the material have a plasma (fluid) form with plasma properties.
 - `.polymer()` will make the material have a dust form with polymer properties.
+- `.ore()` will create an ore from the material.
+    - Optionally you can add any of these sets of parameters: 
+        1. `boolean isEmissive` -> `true` for emissive textures
+        2. `int oreMultiplier, int byproductMultiplier` -> how many crushed ores will be given from one raw ore and how many byproducts dusts will be given throughout the ore processing 
+        3. `int oreMultiplier, int byproductMultiplier, boolean isEmissive` -> see previous points
 - `.burnTime(int burnTime)` will turn the material into a furnace fuel.
 - `.fluidBurnTime(int burnTime)` defines how long the fluid of the material will burn.
 - `.components(component1, component2, ...)` describes the composition. The components are a list of elements of the following form: `'Kx material_name'`, where `K` is a positive integer.
+- `.element(element)` is similar to `.components()`, but is used when the material represents an element.
 - `.iconSet(set)` gives the material an icon set.
-- `.color(int colorCode)` gives the material a color. The color must be provided as a hex value in the following form: `0xNNNNNN`, where `N` are digits.
+- `.color(int colorCode)` gives the material a color. The color must be provided as a hex value in the following form: `0xRRGGBB`.
 - `.secondaryColor(int colorCode)` gives the material a secondary color. If this is not being called, the secondary value will default to white(0xffffff).
-- The secondary color is the overlay over the primary color on the material. This can be seen in the dust of a material, as the secondary color outline is visible. Rotors are another solid example.
-- `.flags(flag1, flag2, ...)` can be used to select certain properties of the material, like generating gears, or disabling decomposition.
-  Examples of use can be found in [Material Flags](https://gregtechceu.github.io/GregTech-Modern/Modpacks/Materials-and-Elements/Material-Flags/)
-- `.element(element)` -> similar to `.components()`, but is used when the material represents an element.
-- `.rotorStats(/* int */ power, /* int */ efficiency, /* float */ damage, /* int */ durability)` -> this will create a turbine rotor from this material
-  1. Power is the EU/t and fuel consumption multiplier the turbine gets when  equipped with this rotor.
-     This output varies depending on speed of turbine and rotor holder.
-  2. Efficiency is how well it handles fuel.
-     A smaller number will make it consume more fuel while a bigger number means it uses less fuel.
-     Actual efficiency: rotorEfficiency * holder Efficiency / 100
-  3. Damage is the amount of damage that happens to the player when opening the ui of a running turbine's rotor holder.
-  4. Durability is how much base durability it has.
-- Here are some examples of base gt rotors:
-  1. Titanium Rotor: .rotorStats(130, 115, 3.0, 1600)
-  2. HSS-S Rotor .rotorStats(250, 180, 7.0, 3000)
-- `.blastTemp()` is meant to be paired together with `.ingot()`. Will generate a EBF recipe (and an ABS recipe) based on the parameters you give it:
-    1. temperature -> dictates what coil tier it will require (check the coil tooltips for their max temperature).
-        If the temperature is below 1000, it will also generate a PBF recipe.
-        If temperature is above 1750, a hot ingot will be generated, this requiring a Vacuum Freezer.
-    2. (optional) gas tier -> can be `null` for none, `'low'` for nitrogen, `'mid'` for helium, `'high'` for argon, `'higher'` for neon or `'highest'` for krypton.
-    3. (optional) EU per tick -> the recipe voltage
-    4. (optional) duration in ticks -> how long the recipe should take
-- `.ore()` will create an ore from the material.
-  - Optionally you can add any of these sets of parameters: 
-    1. is emissive -> `true` for emissive textures
-    2. ore multiplier and byproduct multiplier -> how many crushed ores will be given from one raw ore and how many byproducts dusts will be given throughout the ore processing 
-    3. ore multiplier, byproduct multiplier, is emissive
-- `.washedIn()`
-- `.separatedIn()`
-- `.separatedInto()`
-- `.oreSmeltInto()`
-- `.polarizesInto()`
-- `.arcSmeltInto()`
-- `.maceratesInto()`
-- `.ingotSmeltInto()`
-- `.addOreByproducts()`
-- `.cableProperties()` generates wires and cables(if material is not a superconductor). The following parameter sets can be given:
-    1. Voltage, amperage, loss per block
-    2. Voltage, amperage, loss per block, is superconductor -> for a super conductor, set loss as 0 and is super conductor as true
-    3. Voltage, amperage, loss per block, is super conductor, critical temperature
-- `.fluidPipeProperties()`
-- `.itemPipeProperties()`
-- `.addDefaultEnchant()`
+    - The secondary color is the overlay over the primary color on the material. This can be seen in the dust of a material, as the secondary color outline is visible. Rotors are another solid example.
+- `.addDefaultEnchant(string EnchantName, int level)` gives the material a default enchant. 
 
 !!! tip "Harvest Level & Burn Time"
     For `.ingot()`, `.dust()` and `.gem()`, optionally you can put inside the parentheses any of these sets of parameters:
 
     1. harvest level (e.g. `.ingot(2)` will make the material have the harvest level of iron tools) 
     2. harvest level, burn time (e.g. `ingot(2, 2000)` will make the material have the harvest level of iron tools and will burn in furnaces as fuel for 2000 ticks or 100 seconds).
 
-!!! tip "Disabling Decomposition"
-    Depending on the composition, GT will autogenerate an electrolyzer or centrifuge recipe to decompose the material. You can block that by adding the disable decomposition flag. `DISABLE_DECOMPOSITION`
-
 !!! tip "Choosing EU/t"
     GT has some builtin constants to ease choosing the required EU/t:
+
     - `GTValues.V` for a full amp of power at the selected tier
+
     - `GTValues.VA` for a full amp, adjusted for cable loss
+
     - `GTValues.VH` for half an amp
+
     - `GTValues.VHA` for half an amp, adjusted for cable loss
 
     These values are arrays containing the respective EU/t values for each tier.  
@@ -91,51 +57,117 @@ You can change the properties of the material by adding any combination of the f
     ```
 
 ??? tip "Color Pickers"
-    To chose a color for your material, you can checkout https://www.w3schools.com/colors/colors_picker.asp
+    To chose a color for your material, you can checkout the [color picker](https://www.w3schools.com/colors/colors_picker.asp).
     After you select a color with the above tool, copy the 6 digits that follow the # under the color preview.
+
 ## Creating an Ingot
 
-```js title="ingot.js"
-GTCEuStartupEvents.registry('gtceu:material', event => {
-    event.create('andesite_alloy')
-        .ingot()
-        .components('1x andesite', '1x iron')
-        .color(0x839689).iconSet(GTMaterialIconSet.DULL)
-        .flags(GTMaterialFlags.GENERATE_PLATE, GTMaterialFlags.GENERATE_GEAR, GTMaterialFlags.GENERATE_SMALL_GEAR)
-})
-```
+=== "JavaScript"
+    ```js title="ingot.js"
+    GTCEuStartupEvents.registry('gtceu:material', event => {
+        event.create('andesite_alloy')
+            .ingot()
+            .components('1x andesite', '1x iron')
+            .color(0x839689).iconSet(GTMaterialIconSet.DULL)
+            .flags(GTMaterialFlags.GENERATE_PLATE, GTMaterialFlags.GENERATE_GEAR, GTMaterialFlags.GENERATE_SMALL_GEAR)
+    })
+    ```
+=== "Java"
+    ```java title="Ingot.java"
+    public static Material ANDESITE_ALLOY;
+    public static void register() {
+        ANDESITE_ALLOY = new Material.Builder(
+                your_mod_id.id("andesite_alloy"))
+                .ingot()
+                .components("1x andesite", "1x iron")
+                .color(0xFF0000).secondaryColor(0x840707).iconSet(GTMaterialIconSet.DULL)
+                .flags(MaterialFlags.GENERATE_PLATE, MaterialFlags.GENERATE_GEAR, MaterialFlags.GENERATE_SMALL_GEAR)
+                .buildAndRegister();
+        }
+    ```
 
-## Creating a Gem
+## Creating a Dust
 
-```js title="gem.js"
-GTCEuStartupEvents.registry('gtceu:material', event => {
-    event.create('purple_coal')
-        .gem(2, 4000) 
-        .element(GTElements.C) 
-        .ore(2, 3) 
-        .color(0x7D2DDB).iconSet(GTMaterialIconSet.LIGNITE)
-})
-```
+=== "JavaScript"
+    ```js title="dust.js"
+    GTCEuStartupEvents.registry('gtceu:material', event => {
+        event.create('mysterious_dust')
+            .dust() // The harvest level and burn time can be specified in the brackets. Example: `.dust(2, 4000)`
+            .color(0x7D2DDB)
+    })
+    ```
 
-## Creating a Dust
+=== "Java"
+    ```java title="Dust.java"
+    public static Material MYSTERIOUS_DUST;
+    public static void register() {
+        MYSTERIOUS_DUST = new Material.Builder(
+            your_mod_id.id("mysterious_dust"))
+            .dust() // The harvest level and burn time can be specified in the brackets. Example: `.dust(2, 4000)`
+            .color(0x7D2DDB)
+            .buildAndRegister();
+    }
+    ```
 
-```js title="dust.js"
-GTCEuStartupEvents.registry('gtceu:material', event => {
-    event.create('mysterious_dust')
-        .dust()
-        .cableProperties(GTValues.V[GTValues.LV], 69, 0, true) // (1)
-})
-```
+## Creating a Gem
+
+=== "JavaScript"
+    ```js title="gem.js"
+    GTCEuStartupEvents.registry('gtceu:material', event => {
+        event.create('purple_coal')
+            .gem(2, 4000) 
+            .element(GTElements.C) 
+            .ore(2, 3) 
+            .color(0x7D2DDB).iconSet(GTMaterialIconSet.LIGNITE)
 
-1. Voltage, Amperage, EU loss, Is Superconductor.
+    })
+    ```
+
+=== "Java"
+    ```java title="Gem.java"
+    public static Material PURPLE_COAL;
+    public static void register() {
+        PURPLE_COAL = new Material.Builder(
+            your_mod_id.id("purple_coal"))
+            .gem(2, 4000)
+            .element(GTElements.C)
+            .ore(2, 3) 
+            .color(0x7D2DDB).iconSet(GTMaterialIconSet.LIGNITE)
+            .buildAndRegister();
+        }
+    ```
 
 ## Creating a Fluid
 
-```js title="fluid.js"
-GTCEuStartupEvents.registry('gtceu:material', event => {
-    event.create('mysterious_ooze')
-        .fluid()
-        .color(0x500bbf)
-        .fluidTemp(69420) 
-})
-```
+=== "JavaScript"
+    ```js title="fluid.js"
+    GTCEuStartupEvents.registry('gtceu:material', event => {
+        event.create('mysterious_ooze')
+          .fluid() // Or .liquid(Int Temperature)
+          .color(0x500bbf)
+    })
+    ```
+
+=== "Java"
+    ```java title="Fluid.java"
+    public static Material MYSTERIOUS_OOZE;
+    public static void register() {
+        MYSTERIOUS_OOZE = new Material.Builder(
+            your_mod_id.id("mysterious_ooze"))
+            .fluid() // Or .liquid(Int Temperature)
+            .color(0x500bbf)
+            .buildAndRegister();
+        }
+    ```
+
+
+!!! tip "Further Material Information"
+    For more information on more fine grained material control, check out the pages below!
+
+For a full list of the flags, check out the [Material Flags page](./Material-Flags.md).
+
+For a full list of material properties, check out the [Material Properties page](./Material-Properties.md).
+
+For an explanation of tools, check out the [Tool Creation page](./Tool-Creation.md).
+
+For an explanation of custom icon sets and a list of existing ones, check out the [Icon Set page](./Material-Icon-Sets.md).