Skip to content

Commit 9167fec

Browse files
JuiceyBeansJuiceyBeans
committed
Minor tweaks
1 parent caa7ec2 commit 9167fec

File tree

3 files changed

+62
-60
lines changed

3 files changed

+62
-60
lines changed

‎docs/content/Addons/Materials-and-Elements/Material-Creation.md‎

Lines changed: 18 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -27,39 +27,39 @@ public static final Material MyCustomMaterial = new Material.Builder(ExampleMod.
2727

2828
You can change the properties of the material by adding any combination of the following builder options:
2929

30-
- `.ingot()` will make the material have both an ingot and dust form.
30+
- `.ingot()` -> Makes the material have both an ingot and dust form.
3131

32-
- `.dust()` will make the material have only a dust form, and no ingot. Don't use this together with `.ingot()`.
32+
- `.dust()` -> Makes the material have only a dust form, and no ingot. Don't use this together with `.ingot()`.
3333

34-
- `.gem()` will make the material have both a gem form and a dust form, but no ingot. Don't use those together with `.dust()` or `.ingot()`
34+
- `.gem()` -> Makes the material have both a gem form and a dust form, but no ingot. Don't use those together with `.dust()` or `.ingot()`
3535

36-
- `.liquid()` will make the material have a liquid (fluid) form with liquid properties.
36+
- `.liquid()` -> Makes the material have a liquid (fluid) form with liquid properties.
3737

38-
- `.gas()` will make the material have a gas (fluid) form with gas properties.
38+
- `.gas()` -> Makes the material have a gas (fluid) form with gas properties.
3939

40-
- `.plasma()` will make the material have a plasma (fluid) form with plasma properties.
40+
- `.plasma()` -> Makes the material have a plasma (fluid) form with plasma properties.
4141

42-
- `.polymer()` will make the material have a dust form with polymer properties. Additionally dusts of polymer materials are called pulps instead in-game
42+
- `.polymer()` -> Makes the material have a dust form with polymer properties. Additionally dusts of polymer materials are called pulps instead in-game
4343

44-
- `.burnTime(int burnTime)` will turn the material into a furnace fuel.
44+
- `.burnTime(int burnTime)` -> Turns the material into a furnace fuel.
4545

46-
- `.fluidBurnTime(int burnTime)` defines how long the fluid of the material will burn in a generator
46+
- `.fluidBurnTime(int burnTime)` -> Defines how long the fluid of the material will burn in a generator
4747

48-
- `.components(Material component1, Material component2, ...)` describes the composition. The components are a list of elements of the following form: `Material material, int amount`, where `K` is a positive integer.
48+
- `.components(Material component1, Material component2, ...)` -> Describes the composition. The components are a list of elements of the following form: `Material material, int amount`, where `K` is a positive integer.
4949

50-
- `.iconSet(MaterialIconSet iconSet)` gives the material an icon set. Read more about icon sets [here](Material-Icon-Sets-And-Types.md)
50+
- `.iconSet(MaterialIconSet iconSet)` -> Sets the MaterialIconSet. Read more about icon sets [here](Material-Icon-Sets-And-Types.md)
5151

52-
- `.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.
52+
- `.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.
5353

54-
- `.secondaryColor(int colorCode)` gives the material a secondary color. If this is not being called, the secondary value will default to white(0xffffff).
54+
- `.secondaryColor(int colorCode)` -> Gives the material a secondary color. If this is not being called, the secondary value will default to white(0xffffff).
5555

56-
- `.flags(MaterialFlag flag1, MaterialFlag flag2, ...)` can be used to select certain properties of the material, like generating gears, or disabling decomposition.
56+
- `.flags(MaterialFlag flag1, MaterialFlag flag2, ...)` -> Can be used to select certain properties of the material, like generating gears, or disabling decomposition.
5757

58-
- `.element(Element element)` -> similar to `.components()`, but is used when the material represents an element.
58+
- `.element(Element element)` -> Similar to `.components()`, but is used when the material represents an element.
5959

60-
- `.rotorStats(int speed, int efficiency, float damage, int durability)` -> this will create a turbine rotor from this material.
60+
- `.rotorStats(int speed, int efficiency, float damage, int durability)` -> Creates a turbine rotor from this material.
6161

62-
- `.blastTemp(int temp)` is meant to be paired together with `.ingot()`. Will generate a EBF recipe (and an ABS recipe) based on the parameters you give it:
62+
- `.blastTemp(int temp)` -> Meant to be paired together with `.ingot()`. This will generate a EBF recipe (and an ABS recipe) based on the parameters you give it:
6363
1. `temp` -> dictates what coil tier it will require (check the coil tooltips for their max temperature).
6464
If the temperature is below 1000, it will also generate a PBF recipe.
6565
If temperature is above 1750, a hot ingot will be generated, this requiring a Vacuum Freezer.
@@ -91,10 +91,7 @@ You can change the properties of the material by adding any combination of the f
9191

9292
- `.addOreByproducts()`
9393

94-
- `.cableProperties()` generates wires and cables(if material is not a superconductor). The following parameter sets can be given:
95-
1. Voltage, amperage, loss per block
96-
2. Voltage, amperage, loss per block, is superconductor -> for a super conductor, set loss as 0 and is super conductor as true
97-
3. Voltage, amperage, loss per block, is super conductor, critical temperature
94+
- `.cableProperties()` -> Generates wires and cables (if material is not a superconductor). See [cable property](Material-Properties.md#cable-property)
9895

9996
- `.toolProperties()`
10097

‎docs/content/Addons/Materials-and-Elements/Material-Icon-Sets-And-Types.md‎

Lines changed: 22 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,13 @@ title: Icon Sets and Icon Types
33
---
44

55

6-
# Icon Sets
6+
## Icon Sets
77

8-
The material system uses icon sets to determine the textures of generated blocks and items. Each icon set contains an icon type which is the texture applied for a specific item. For example, the denes plate for a custom material could have the `METALLIC` icon set, and since its TagPrefix is `plateDense`, it would have the `plateDense` icon set applied to it. The path for the texture applied would be `assets/gtceu/item/material_sets/metallic/plate_dense.png`
8+
The material system uses icon sets to determine the textures of generated blocks and items. Each icon set contains icon types, which are the textures applied for a specific [TagPrefix item](TagPrefixes-and-the-power-of-.setIgnored().md#).
99

10-
## Available Icon Sets
10+
For example, the dense plate item for a custom material could have the `METALLIC` icon set, and since its TagPrefix is `plateDense`, it would have the `plateDense` icon type from the `METALLIC` icon set applied to it. The path for the texture applied would be `assets/gtceu/item/material_sets/metallic/plate_dense.png`
11+
12+
### Available Icon Sets
1113

1214
The following icon sets are available by default:
1315

@@ -37,20 +39,26 @@ The following icon sets are available by default:
3739
- `MaterialIconSet.FLUID`
3840
- `MaterialIconSet.RADIOACTIVE`
3941

40-
## Custom Icon Sets
4142

42-
Custom iconsets can be specified as well:
43+
### Custom Icon Sets
44+
45+
Custom icon sets can be created:
4346

4447
```java title="ModIconSets.java"
45-
public static final MaterialIconType MY_ICON_SET = new MaterialIconType("my_icon_set");
48+
public static final MaterialIconSet MY_ICON_SET = new MaterialIconSet("my_icon_set", METALLIC);
4649
```
4750

51+
`MaterialIconSet()` can have the following additional parameters:
52+
53+
- `MaterialIconSet parentIconset` -> Specify an icon set to inherit missing textures from. Useful if you want to only add a couple of icon types to an icon set, and use preexisting icon types for the rest of the set. All of GregTech's material icon sets inherit another icon set, excluding `DULL`, `METALLIC`, `FINE`, and `FLUID`. By default, this is `DULL`
54+
- `boolean isRootIconset` -> specify whether this icon set is a root icon set ie it has no parent icon sets. Any missing textures will not inherit a texture from the parent icon set, and will be a null texture.
55+
4856

49-
# Icon Types
57+
## Icon Types
5058

51-
Icon types are the textures used for TagPrefix item such as dusts, plates, rods, etc. Each icon type belongs to an icon set.
59+
Icon types are the textures used for TagPrefix items such as dusts, plates, rods, etc. Each icon type belongs to an icon set.
5260

53-
## Available Icon Types
61+
### Available Icon Types
5462

5563
The following icon types are available by default:
5664

@@ -122,14 +130,10 @@ The following icon types are available by default:
122130
- `MaterialIconType.wire`
123131

124132

125-
## Custom Icon Sets
133+
### Custom Icon Types
126134

127-
Custom iconsets can be specified as well:
135+
Custom icon types can be specified as well:
128136

129-
```java title="ModIconSets.java"
130-
public static final MaterialIconSet MY_ICON_SET = new MaterialIconSet("my_icon_set", METALLIC);
131-
```
132-
133-
`MaterialIconSet()` can have the following additional parameters:
134-
- `MaterialIconSet parentIconset` -> specify an icon set to inherit missing textures from. Useful if you want to only add a couple of icon types to an icon set, and use preexisting icon types for the rest of the set. All of GregTech's material icon sets inherit another icon set, excluding `DULL`, `METALLIC`, `FINE`, and `FLUID`
135-
- `boolean isRootIconset` -> specify whether this icon set is a root icon set ie it has no parent icon sets. Any missing textures will not inherit a texture from the parent icon set, and will be a null texture.
137+
```java title="ModIconTypes.java"
138+
public static final MaterialIconType MY_ICON_TYPE = new MaterialIconType("my_icon_type");
139+
```

‎docs/content/Addons/Materials-and-Elements/Material-Properties.md‎

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -59,15 +59,15 @@ The full list of material properties and their related attributes is too expansi
5959
3. Sets the Vacuum Freezer recipe to run at 120 EU/t for 50 seconds
6060
4. Returns 1700K (as a long)
6161

62-
## `DustProperty#dust`
62+
## `DustProperty`
6363
- `.dust(int harvestLevel, int burnTime)` -> Used for creating a material with a dust
6464
1. (optional) `int harvestLevel` -> Sets the harvest level for the material's ore and other related
6565
2. (optional) `int burnTime` -> Sets the material to a furnace fuel and its burn time as well
6666

6767
!!! warning
6868
Using `.dust()` throws an `IllegalArgumentException` if a `DustProperty` has already been added to this Material from another source
6969

70-
## `Fluid Pipe Property`
70+
## `FluidPipeProperties`
7171
- `.fluidPipeProperties(int maxTemp, int throughput, boolean gasProof, boolean acidProof, boolean cryoProof, boolean plasmaProof)` -> Creates a fluid pipe from this material
7272
1. `int maxTemp` -> The maximum temperature of fluid that this pipe can handle before breaking the pipe and voiding fluids.
7373
2. `int throughput` -> The rate at which fluid can flow through this pipe.
@@ -76,12 +76,12 @@ The full list of material properties and their related attributes is too expansi
7676
5. (optional) `boolean cryoProof` -> Allow this pipe to hold cryogenic fluids (below 120K). If false, the pipe will break and void all fluids.
7777
6. (optional) `boolean plasmaProof` -> Allow this pipe can hold plasmas. If false, the pipe will break and void all fluids. Plasma-capable pipes do not care about temperature.
7878

79-
## `Item Pipe Property`
79+
## `ItemPipeProperties`
8080
- `.itemPipeProperties(int priority, int stacksPerSecond)` -> this will create an item pipe from this material
8181
1. `int priority` -> Priority of this Item Pipe, used for the standard routing mode.
8282
2. `int stacksPerSecond` -> How many stacks of items can be moved per second (20 ticks).
8383

84-
## `Rotor Property`
84+
## `RotorProperty`
8585
- `.rotorStats(int power, int efficiency, float damage, int durability)` -> this will create a turbine rotor from this material
8686
1. `int power` -> EU/t generated by the turbine when equipped with this rotor. This output varies depending on speed of turbine and rotor holder.
8787
2. `int efficiency` -> Rate of consumption of provided fuel. The more efficient the rotor, the less fuel consumed per cycle. Actual efficiency can be calculated using the formula `rotorEfficiency * holderEfficiency / 100`
@@ -95,37 +95,38 @@ The full list of material properties and their related attributes is too expansi
9595
1. 130 EU/t, 1.15x rotor efficiency, 3 damage, 1600 durability
9696

9797
## `Cable Property`
98-
- .cableProperties(long voltage, int amperage, int lossPerBlock, boolean isSuperconductor)
98+
- .cableProperties(long voltage, int amperage, int lossPerBlock, boolean isSuperconductor, int criticalTemperature)
9999
1. `long voltage` -> The voltage tier of this Cable. Should conform to standard GregTech voltage tiers.
100100
2. `int amperage` -> The amperage of this Cable. Should be greater than zero.
101101
3. `int loss` -> The loss-per-block of this Cable. A value of zero here will still have loss as wires.
102102
4. (optional) `boolean isSuperconductor` -> Whether this Material is a Superconductor. If so, cables will NOT be generated and wires will have zero cable loss.
103+
5. (optional) `int criticalTemperature` -> NYI. Temperature below which the superconductor functions without cable loss.
103104

104-
## Fluid Properties
105+
## FluidProperty
105106

106107
### `Fluid Block Property`
107108
- Add `.block()` into the builder of a liquid material to allow this material to be placeable.
108109

109-
## `Ingot Property`
110-
- `.polarizesInto(string newMaterial)`
111-
- `string newMaterial` -> Is what is obtained through polarizing the material.
112-
- `.arcSmeltInto(string newMaterial)`
113-
- `string newMaterial` -> Is what is obtained through arc smelting the material.
114-
- `.macerateInto(string newMaterial)`
115-
- `string newMaterial` -> Is what is obtained through macerating the material.
116-
- `.ingotSmeltInto(string newMaterial)`
117-
- `string newMaterial` -> Is what is obtained when smelting a material's ingot.
118-
119-
## `Ore Property`
110+
## `IngotProperty`
111+
- `.polarizesInto(String newMaterial)`
112+
- `String newMaterial` -> Is what is obtained through polarizing the material.
113+
- `.arcSmeltInto(String newMaterial)`
114+
- `String newMaterial` -> Is what is obtained through arc smelting the material.
115+
- `.macerateInto(String newMaterial)`
116+
- `String newMaterial` -> Is what is obtained through macerating the material.
117+
- `.ingotSmeltInto(String newMaterial)`
118+
- `String newMaterial` -> Is what is obtained when smelting a material's ingot.
119+
120+
## `OreProperty`
120121
- `.addOreByproducts()` is an "open" list of extra byproduct materials.
121122
1. Is the material when going crushed -> impure in macerator, or impure dust to dust in centrifuge
122123
2. Is the material when going crushed->refined in thermal centrifuge, or crushed to dust in macerator, or pure dust to dust in centrifuge
123124
3. Is the material when going from refined to dust in macerator,
124125
4. Is the material when going from crushed ore to purified or in chem bath(works only if you have a getWashedIn material)
125-
- `.washedIn(string fluid)`
126-
- `string fluid` Is what fluid it uses for if it has the ore prop and is making crushed->refined. For example, the sodium persulfate and mercury ore washing recipes.
126+
- `.washedIn(String fluid)`
127+
- `String fluid` Is what fluid it uses for if it has the ore prop and is making crushed->refined. For example, the sodium persulfate and mercury ore washing recipes.
127128
- `.separatedInto(list material)`
128129
- `list material` Is the list of materials that are obtained when processing purified dusts in the centrifuge.
129-
- `.oreSmeltInto(string material)`
130-
- `string material` Is what is obtained through directly smelting the ore.
130+
- `.oreSmeltInto(String material)`
131+
- `String material` Is what is obtained through directly smelting the ore.
131132

0 commit comments

Comments
 (0)