Skip to content

Commit

Permalink
Finished type=enchantment documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
SHsuperCM committed Jan 16, 2022
1 parent ea60b6d commit 20c1e7b
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 6 deletions.
9 changes: 4 additions & 5 deletions docs/cit/cit_enchantment.md
Expand Up @@ -3,8 +3,6 @@

This page applies to CITs marked with `type=enchantment`.

## This section is not complete! It is still being written :/

CIT Enchantment replaces the purple glint texture that appears on enchanted items.
These glints can be layered, blended and even be placed on items without vanilla glints.

Expand All @@ -20,7 +18,7 @@ The CIT must match the item in that has its glint changed.
| Key | Value Type                       | Description | Default |
| --- | --- | --- | --- |
| `texture` | [**[Texture Asset](/cit/cit_base/#asset-resolution) <br> (`.png`)**]{Examples: &#10 texture=./my_textures/custom_glint.png &#10 texture=assets/minecraft/citresewn/cit/ench/glint_3 &#10 texture=minecraft:misc/my_cool_enchanted_item_glint.png|right} | Replaces the texture of this glint layer with the resolved texture. | None |
| `layer` | Any whole number | - | `0` |
| `layer` | Any whole number | The position of this glint in the order of layers. If two glints use the same layer, the one with the higher weight will render and the other will not. | `0` |
| `speed` | Any number | Multiplier for the glint's scroll speed. | `1.0` |
| `rotation` | Any number | Rotates the texture and scroll direction by the given degrees. | `0.0` |
| `duration` | Any number | Amount of time in seconds to pause on this cit when the used method is `cycle`. | `0.0` |
Expand Down Expand Up @@ -59,13 +57,14 @@ parameters that are passed onto OpenGL's `blendFuncSeparate` method.

This takes either 4 or 2 parameters with the alpha factors defaulting to `GL_ZERO, GL_ONE`. <br>
The parameters are separated by spaces and can be specified by using either a decimal constant,
a hexadecimal constant (with a `0x` prefix) or by a named GL11 constant name.
a hexadecimal constant (with a `0x` prefix) or *by a named GL11 constant name*.

Example:
```properties
# Ways of specifying a multiply blending function
# Ways of specifying a "multiply" blending function
blend=multiply
blend=GL_DST_COLOR GL_ONE_MINUS_SRC_ALPHA
blend=GL_DST_COLOR GL_ONE_MINUS_SRC_ALPHA GL_ZERO GL_ONE
blend=774 771
blend=0x306 0x303
```
2 changes: 1 addition & 1 deletion docs/cit/global.md
Expand Up @@ -20,5 +20,5 @@ All properties (and `cit.properties` itself) are optional.
| --- | --- | --- | --- |
| `useGlint` | [**Boolean**]{Either: &#10 true / false|right} | If false, removes the default glint texture from every item. | `true` |
| `cap` | Any positive whole number | Controls the maximum allowed layers of CIT Enchantments per item. | None |
| `method` | [**Literal**]{Either: &#10 average / layered / cycle|right} | Determines how different CIT Enchantments mix:<br>`average`:<br>`layered`:<br>`cycle`: | `average` |
| `method` | [**Literal**]{Either: &#10 average / layered / cycle|right} | Determines how visibility is controlled for CIT Enchantments. Values:<br><br>`average`: If the glint has an enchantment condition, its visibility will be determined by <br>`<enchantment level> / <total(levels)>`<br><br>`layered`: Same as average but the highest level is used instead of the total<br>`<enchantment level> / <max(levels)>`<br><br>`cycle`: Cycles through every glint layer in turn. The glint's `duration` property will pause on it for the specified duration. | `average` |
| `fade` | Any non-negative number | Amount of time in seconds to fade between CIT Enchantments when method is set to `cycle`. | `0.5` |

0 comments on commit 20c1e7b

Please sign in to comment.