Tool Property Page for the Wiki#3827
Tool Property Page for the Wiki#3827jurrejelle merged 65 commits intoGregTechCEu:1.20.1from Phoenixvine32908:pv/material_docs_update
Conversation
Co-authored-by: Jurre Groenendijk <jurre@jilles.com>
Co-authored-by: Jurre Groenendijk <jurre@jilles.com>
Co-authored-by: Jurre Groenendijk <jurre@jilles.com>
| @@ -25,7 +25,17 @@ You can change the properties of the material by adding any combination of the f | |||
| - `.secondaryColor(int colorCode)` gives the material a secondary color. If this is not being called, the secondary value will default to white(0xffffff). | |||
| - `.flags(flag1, flag2, ...)` can be used to select certain properties of the material, like generating gears, or disabling decomposition. | |||
There was a problem hiding this comment.
We need a list of valid Flags
There was a problem hiding this comment.
Those flags are in the flags page, the whole mat creation page needs reworked but that's a separate pr, only removed the tool part in it right now.
There was a problem hiding this comment.
Linked the page that shows examples.
| @@ -25,7 +25,17 @@ You can change the properties of the material by adding any combination of the f | |||
| - `.secondaryColor(int colorCode)` gives the material a secondary color. If this is not being called, the secondary value will default to white(0xffffff). | |||
There was a problem hiding this comment.
What makes SecondaryColor different from Primary, where does that color get used?
There was a problem hiding this comment.
100% should be explained in the material creation page pr, will make a note.
There was a problem hiding this comment.
Added a placeholder explanation for now.
| 5. 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. Tungsten Rotor .rotorStats(130, 115, 3.0, 2560) |
There was a problem hiding this comment.
Tungsten feels like a poor choice because 3 of its 4 stats are the same as Titanium. How about HSS-S?
There was a problem hiding this comment.
HSS-S does sound good, but gonna fix that in the material creation page pr probably.
There was a problem hiding this comment.
nevermind, simple thing I can fix now
| title: Tool Creation | ||
| --- | ||
|
|
||
| You can make tools out of materials you create by calling toolStats inside your material's code. |
There was a problem hiding this comment.
Switch the writing tone in this file from 2nd person ("You can make...") to no-person ("Tools can be made...")
| - Takes a decimal number eg.(5.6). | ||
| 2. attackDamage is the amount of damage per hit you deal to mobs/players. | ||
| - Also takes a decimal number. | ||
| 3. durability is how long it takes of use to breaks. |
There was a problem hiding this comment.
"Durability is the number of times the tool can be used before it breaks"
- Takes a positive whole number up to 2.147 billion (e.g 700)
- This applies to both crafting use and in-world use
- Crafting generally consumes 2 points of durability per use
There was a problem hiding this comment.
Thanks, that does help clarify.
| - `ignoreCraftingTools()` | ||
| - Disable crafting tools being made from this Material. | ||
| - `addEnchantmentForTools(enchantment, level)` | ||
| - Enchantment is the default enchantment applied on tool creation. |
There was a problem hiding this comment.
- Applies an Enchantment to every tool made from this material
[Add an example to show the code for it]
There was a problem hiding this comment.
I can add that onto the example that shows unbreakable tools, if that works.
There was a problem hiding this comment.
Added to extra tool flags example.
Phoenixvine32908
left a comment
There was a problem hiding this comment.
Fixed up some stuff and asked for clarification
| @@ -25,7 +25,17 @@ You can change the properties of the material by adding any combination of the f | |||
| - `.secondaryColor(int colorCode)` gives the material a secondary color. If this is not being called, the secondary value will default to white(0xffffff). | |||
There was a problem hiding this comment.
Added a placeholder explanation for now.
| @@ -25,7 +25,17 @@ You can change the properties of the material by adding any combination of the f | |||
| - `.secondaryColor(int colorCode)` gives the material a secondary color. If this is not being called, the secondary value will default to white(0xffffff). | |||
| - `.flags(flag1, flag2, ...)` can be used to select certain properties of the material, like generating gears, or disabling decomposition. | |||
There was a problem hiding this comment.
Linked the page that shows examples.
| - `ignoreCraftingTools()` | ||
| - Disable crafting tools being made from this Material. | ||
| - `addEnchantmentForTools(enchantment, level)` | ||
| - Enchantment is the default enchantment applied on tool creation. |
There was a problem hiding this comment.
Added to extra tool flags example.
docs/content/Modpacks/Materials-and-Elements/Tool_Properties.md
Outdated
Show resolved
Hide resolved
docs/content/Modpacks/Materials-and-Elements/Tool_Properties.md
Outdated
Show resolved
Hide resolved
docs/content/Modpacks/Materials-and-Elements/Tool_Properties.md
Outdated
Show resolved
Hide resolved
docs/content/Modpacks/Materials-and-Elements/01-Material-Creation.md
Outdated
Show resolved
Hide resolved
docs/content/Modpacks/Materials-and-Elements/01-Material-Creation.md
Outdated
Show resolved
Hide resolved
…ion.md Co-authored-by: Jurre Groenendijk <jurre@jilles.com>
Co-authored-by: Jurre Groenendijk <jurre@jilles.com>
Co-authored-by: Jurre Groenendijk <jurre@jilles.com>
Co-authored-by: Jurre Groenendijk <jurre@jilles.com>
…ion.md Co-authored-by: Jurre Groenendijk <jurre@jilles.com>
Phoenixvine32908
left a comment
There was a problem hiding this comment.
Updated to jurre's advice.
Co-authored-by: Jurre Groenendijk <jurre@jilles.com>
What
Adds a ToolProperties page to the kubejs docs to explain how you can make tools from existing/custom gt materials.
Implementation Details
Probably needs some formatting look overs.
Outcome
Help kubejs devs understand how to make tools for materials/add new tools to existing materials.
Potential Compatibility Issues
Should be none as this helps make tool creation clearer.