Tinted Textures - Revision history

Paint Ninja: Add Groovy language code examples

2021-11-17T16:56:43Z

Add Groovy language code examples

ChampionAsh5357: Update to 1.17

2021-08-02T17:51:25Z

Update to 1.17

Ferri Arnus: /* IBlockColor / IItemColor */

2021-06-29T22:23:12Z

IBlockColor / IItemColor

SciWhiz12: SciWhiz12 moved page Coloring textures dynamically to Tinted Textures: less adverb, more descriptive

2021-01-11T05:06:07Z

SciWhiz12 moved page Tinted Textures to Tinted Textures: less adverb, more descriptive

Unbekannt: Inital Import dokuwiki

2020-10-24T19:57:12Z

Inital Import dokuwiki

New page

Many blocks and items in vanilla change their texture color depending on where they are, such as grass. Models support specifying “tint indices” on faces, which are integers that can then be handled by <code>IBlockColor</code>s and <code>IItemColor</code>s. See the wiki for information on how tint indices are defined in vanilla models.

=== IBlockColor / IItemColor ===
Both of these are single-method interfaces. <code>IBlockColor</code> takes an <code>IBlockState</code>, an (<code>nullable</code>) <code>IBlockDisplayReader</code>, and a (<code>nullable</code>) <code>BlockPos</code>. <code>IItemColor</code> takes an <code>ItemStack</code>. Both of them take a parameter <code>tintIndex</code>, which is the tint index of the face being colored. Both of them return an <code>int</code>, a color multiplier. This int is treated as four unsigned bytes, alpha, red, green, and blue, in that order, from most significant byte to least. For each pixel in the tinted face, the value of each color channel is <code><nowiki>(int)((float)base * multiplier / 255)</nowiki></code>, where <code>base</code> is the original value for the channel, and <code>multiplier</code> is the associated byte from the color multiplier. Note that blocks do not use the alpha channel. For example, the grass texture, untinted, looks white and gray. The <code>IBlockColor</code> and <code>IItemColor</code> for grass return color multipliers with low red and blue components, but high alpha and green components, (at least in warm biomes) so when the multiplication is performed, the green is brought out and the red/blue diminished.

If an item inherits from the <code><nowiki>builtin/generated</nowiki></code> model, each layer (“layer0”, “layer1”, etc.) has a tint index corresponding to its layer index.

=== Creating Color Handlers ===
<code>IBlockColor</code>s need to be registered to the <code>BlockColors</code> instance of the game. <code>BlockColors</code> can be acquired through <code>ColorHandlerEvent$Block</code>, and an <code>IBlockColor</code> can be registered by <code><nowiki>BlockColors#register</nowiki></code>. Note that this does not cause the <code>BlockItem</code> for the given block to be colored. <code>BlockItem</code> are items and need to colored with an <code>IItemColor</code>.
<syntaxhighlight lang="java">
public void registerBlockColors(ColorHandlerEvent.Block event){
event.getBlockColors().register(myIBlockColor, coloredBlock1, coloredBlock2, ...);
}
</syntaxhighlight>
<code>IItemColor</code>s need to be registered to the <code>ItemColors</code> instance of the game. <code>ItemColors</code> can be acquired through <code><nowiki>ColorHandlerEvent$Item()</nowiki></code>, and an <code>IItemColor</code> can be registered by <code><nowiki>ItemColors#register</nowiki></code>. This method is overloaded to also take <code>Block</code>s, which simply registers the color handler for the item <code><nowiki>Block#asItem</nowiki></code> (i.e. the block’s <code>BlockItem</code>).
<syntaxhighlight lang="java">
public void registerItemColors(ColorHandlerEvent.Item event){
event.getItemColors().register(myIItemColor, coloredItem1, coloredItem2, ...);
}
</syntaxhighlight>
This registration must be done client-side, in the initialization phase.

@@ Line 8: / Line 8: @@
 === Creating Color Handlers ===
 <code>BlockColor</code>s need to be registered to the <code>BlockColors</code> instance of the game. <code>BlockColors</code> can be acquired through <code>ColorHandlerEvent$Block</code>, and an <code>BlockColor</code> can be registered by <code><nowiki>BlockColors#register</nowiki></code>. Note that this does not cause the <code>BlockItem</code> for the given block to be colored. <code>BlockItem</code> are items and need to colored with an <code>ItemColor</code>.
-<syntaxhighlight lang="java">
+{{Template:Tabs/Code_Snippets
-public void registerBlockColors(ColorHandlerEvent.Block event){
+|java=public void registerBlockColors(final ColorHandlerEvent.Block event) {
      event.getBlockColors().register(myBlockColor, coloredBlock1, coloredBlock2, ...);
+}
-</syntaxhighlight>
+|groovy=void registerBlockColors(final ColorHandlerEvent.Block event) {
 <code>ItemColor</code>s need to be registered to the <code>ItemColors</code> instance of the game. <code>ItemColors</code> can be acquired through <code><nowiki>ColorHandlerEvent$Item</nowiki></code>, and an <code>ItemColor</code> can be registered by <code><nowiki>ItemColors#register</nowiki></code>. This method is overloaded to also take <code>Block</code>s, which simply registers the color handler for the item <code><nowiki>Block#asItem</nowiki></code> (i.e. the block’s <code>BlockItem</code>).
-<syntaxhighlight lang="java">
+{{Template:Tabs/Code_Snippets
-public void registerItemColors(ColorHandlerEvent.Item event){
+|java=public void registerItemColors(final ColorHandlerEvent.Item event) {
      event.getItemColors().register(myItemColor, coloredItem1, coloredItem2, ...);
+}
-</syntaxhighlight>
+|groovy=void registerBlockColors(final ColorHandlerEvent.Item event) {
 This registration must be done client-side, in the initialization phase.

@@ Line 4: / Line 4: @@
 Both of these are single-method interfaces. <code>IBlockColor</code> takes an <code>IBlockState</code>, an (<code>nullable</code>) <code>IBlockDisplayReader</code>, and a (<code>nullable</code>) <code>BlockPos</code>. <code>IItemColor</code> takes an <code>ItemStack</code>. Both of them take a parameter <code>tintIndex</code>, which is the tint index of the face being colored. Both of them return an <code>int</code>, a color multiplier. This int is treated as four unsigned bytes, alpha, red, green, and blue, in that order, from most significant byte to least. For each pixel in the tinted face, the value of each color channel is <code><nowiki>(int)((float)base * multiplier / 255)</nowiki></code>, where <code>base</code> is the original value for the channel, and <code>multiplier</code> is the associated byte from the color multiplier. Note that blocks do not use the alpha channel. For example, the grass texture, untinted, looks white and gray. The <code>IBlockColor</code> and <code>IItemColor</code> for grass return color multipliers with low red and blue components, but high alpha and green components, (at least in warm biomes) so when the multiplication is performed, the green is brought out and the red/blue diminished.
-If an item inherits from the <code><nowiki>builtin/generated</nowiki></code> model, each layer (“layer0”, “layer1”, etc.) has a tint index corresponding to its layer index.
+If an item inherits from the <code><nowiki>builtin/generated</nowiki></code> model, each layer (“layer0”, “layer1”, etc.) has a tint index corresponding to its layer index. For blocks, the “particle” layer is index 0.
 === Creating Color Handlers ===

← Older revision	Revision as of 05:06, 11 January 2021
(No difference)