Colours Are Cool 🌈 #7246

cheeezburga · 2024-12-08T04:47:40Z

Description

This PR adds a few colour manipulation expressions and functions. There might be more to come in another PR, because there's plenty left which can still be included, but these seemed (to me) like the important-ish ones. Find below a list of new syntax:

Hex expression: returns the hex code a colour. Very useful when trying to colour strings or compare colours
Blend expression: blends colours together
Complement expression: returns the complement of a colour(s), optionally using HSL adjustments
shade function: shades a colour by a given amount, optionally using HSL adjustments
tint function: tints a colour by a given amount, optionally using HSL adjustments
colourBrightness function: adjusts the brightness of a colour by a given amount. This is similar to, but not the same as, the shade and tint functions
grayscale function: converts a colour to its grayscale equivalent
sepiatone function: converts a colour to its sepiatone equivalent

This PR also adds channel as an option in ExprARGB.

I used this script to do some basic testing in the early stages of the PR, so feel free to try it:

on load:
    set {block} to "█"
    set {blocks} to {block} repeated 10 times

function hexTest():
    loop all colours:
        broadcast "%loop-value%: %hex of loop-value%"

function blendTest(colour1: colour, colour2: colour):
    set {_asHex1} to hex of {_colour1}
    set {_asHex2} to hex of {_colour2}
    send action bar (formatted "Testing blending of %{_asHex1}%%{blocks}% &fto %{_asHex2}%%{blocks}%") to all players
    loop integers from 0 to 100:
        set {_blendedColour} to {_colour1} blended with {_colour2} by a factor of loop-value
        set {_asHex} to hex of {_blendedColour}
        send title (formatted "%{_asHex}%%{blocks}%") to all players for 2 ticks with fade in 0 ticks and fade out 0 ticks
        send "%{_blendedColour}%: %loop-value%" to all players
        wait 1 tick

function complementTest(colour: colour):
    set {_asHex} to hex of {_colour}
    send action bar (formatted "Testing complement of %{_asHex}%%{blocks}%") to all players
    send title (formatted "%{_asHex}%%{blocks}%") to all players for 2 seconds with fade in 0 ticks and fade out 0 ticks
    wait 39 ticks
    set {_complement} to complement of {_colour}
    set {_asHex} to hex of {_complement}
    send title (formatted "%{_asHex}%%{blocks}%") to all players for 2 seconds with fade in 0 ticks and fade out 0 ticks
    wait 39 ticks
    set {_complement} to hsl complement of {_colour}
    set {_asHex} to hex of {_complement}
    send title (formatted "%{_asHex}%%{blocks}%") to all players for 2 seconds with fade in 0 ticks and fade out 0 ticks

function shadeTest(colour: colour):
    set {_asHex} to hex of {_colour}
    send action bar (formatted "Testing shading of %{_asHex}%%{blocks}%") to all players
    loop 100 times:
        set {_shadedColour} to shade({_colour}, loop-value)
        set {_asHex} to hex of {_shadedColour}
        send title (formatted "%{_asHex}%%{blocks}%") to all players for 2 ticks with fade in 0 ticks and fade out 0 ticks
        send {_shadedColour} to all players
        wait 1 tick

function tintTest(colour: colour):
    set {_asHex} to hex of {_colour}
    send action bar (formatted "Testing tinting of %{_asHex}%%{blocks}%") to all players
    loop 100 times:
        set {_tintedColour} to tint({_colour}, loop-value)
        set {_asHex} to hex of {_tintedColour}
        send title (formatted "%{_asHex}%%{blocks}%") to all players for 2 ticks with fade in 0 ticks and fade out 0 ticks
        send {_tintedColour} to all players
        wait 1 tick

function brightnessTest(colour: colour):
    set {_asHex} to hex of {_colour}
    send action bar (formatted "Testing brightness of %{_asHex}%%{blocks}%") to all players
    loop integers from -100 to 100:
        set {_tintedColour} to colourBrightness({_colour}, loop-value)
        set {_asHex} to hex of {_tintedColour}
        send title (formatted "%{_asHex}%%{blocks}%") to all players for 2 ticks with fade in 0 ticks and fade out 0 ticks
        send {_tintedColour} to all players
        wait 1 tick
    
function grayscaleTest(colour: colour):
    set {_asHex} to hex of {_colour}
    send action bar (formatted "Testing grayscale of shading of %{_asHex}%%{blocks}%") to all players
    loop 100 times:
        set {_shadedColour} to shade({_colour}, loop-value)
        set {_grayscale} to grayscale({_shadedColour})
        set {_asHex} to hex of {_grayscale}
        send title (formatted "%{_asHex}%%{blocks}%") to all players for 2 ticks with fade in 0 ticks and fade out 0 ticks
        send {_shadedColour} to all players
        wait 1 tick

function sepiatoneTest(colour: colour):
    set {_asHex} to hex of {_colour}
    send action bar (formatted "Testing sepiatone of shading of %{_asHex}%%{blocks}%") to all players
    loop 100 times:
        set {_shadedColour} to shade({_colour}, loop-value)
        set {_sepia} to sepiatone({_shadedColour})
        set {_asHex} to hex of {_sepia}
        send title (formatted "%{_asHex}%%{blocks}%") to all players for 2 ticks with fade in 0 ticks and fade out 0 ticks
        send {_shadedColour} to all players
        wait 1 tick

Target Minecraft Versions: any
Requirements: none
Related Issues: none

- Also fixes blending util method using old, wrong scale

sovdeeth

nice work

src/main/java/org/skriptlang/skript/misc/colours/ColourModule.java

src/main/java/org/skriptlang/skript/misc/colours/ColourUtils.java

sovdeeth · 2024-12-08T05:04:33Z

src/main/java/org/skriptlang/skript/misc/colours/ColourUtils.java

+	public static float[] rgbToHsl(Color color) {
+		float r = color.getRed() / 255f;
+		float g = color.getGreen() / 255f;
+		float b = color.getBlue() / 255f;
+		float max = Math.max(r, Math.max(g, b));
+		float min = Math.min(r, Math.min(g, b));
+		float h, s, l = (max + min) / 2f;
+		if (max == min) {
+			h = s = 0f;
+		} else {
+			float delta = max - min;
+			s = l > 0.5f ? delta / (2f - max - min) : delta / (max + min);
+			if (max == r) {
+				h = ((g - b) / delta + (g < b ? 6f : 0f)) / 6f;
+			} else if (max == g) {
+				h = ((b - r) / delta + 2f) / 6f;
+			} else {
+				h = ((r - g) / delta + 4f) / 6f;
+			}
+		}
+		return new float[]{ h, s, l };
+	}


Why not return a new Color?

src/main/java/org/skriptlang/skript/misc/colours/ExprBlend.java

sovdeeth · 2024-12-08T05:09:54Z

src/main/java/org/skriptlang/skript/misc/colours/ExprBlend.java

+        /* return new SyntaxStringBuilder(event, debug)
+			.append(this.colours)
+			.append("blended with")
+			.append(this.blendWith)
+			.append("by a factor of")
+			.append(this.amount)
+			.toString(); */


can uncomment now

This relies on #7244

src/main/java/org/skriptlang/skript/misc/colours/ExprComplement.java

sovdeeth · 2024-12-08T05:12:36Z

src/main/java/org/skriptlang/skript/misc/colours/ExprHex.java

+	static {
+		register(ExprHex.class, String.class, "hex [code]", "colors");
+	}
+
+	@Override
+	public @Nullable String convert(Color from) {
+		return ColourUtils.toHex(from);
+	}
+
+	@Override
+	protected String getPropertyName() {
+		return "hex code";
+	}
+
+	@Override
+	public Class<? extends String> getReturnType() {
+		return String.class;
+	}


I'm not sure about this
I think i'd rather see it implemented as taking in a number and returning a string, rather than being restricted to colors

src/main/java/org/skriptlang/skript/misc/colours/ExprHex.java

Fusezion

If we're gonna be moving colors into a module can we move the existing color classes into it?
While we're here can we also complete #5176, #6490 ~~and #5492~~ (this one was completed)

Efnilite

colour is used everywhere, and i think skript generally uses color, as do most people. you should probably replace all colour mentions with color

src/main/java/org/skriptlang/skript/misc/colours/ColourModule.java

src/main/java/org/skriptlang/skript/misc/colours/ExprComplement.java

cheeezburga · 2024-12-08T10:42:13Z

colour is used everywhere, and i think skript generally uses color, as do most people. you should probably replace all colour mentions with color

Yeah already discussed briefly on Discord - I'll change them all over in my next round of commits 👍

…amples

… some cleanup

…haracters

- Works for ColorRGBs but not SkriptColors

APickledWalrus · 2024-12-15T04:59:54Z

src/main/java/org/skriptlang/skript/misc/colors/ColorModule.java

@@ -0,0 +1,144 @@
+package org.skriptlang.skript.misc.colors;


Suggested change

package org.skriptlang.skript.misc.colors;

package org.skriptlang.skript.common.colors;

For native/non-Bukkit dependent syntax, we had sort of informally agreed on using common as the package name for, which I think would work better here.

APickledWalrus · 2024-12-15T05:03:27Z

src/main/java/ch/njol/skript/classes/data/SkriptClasses.java

I think it would be good to move the Color ClassInfo registration to the module

APickledWalrus · 2024-12-15T05:18:15Z

src/main/java/ch/njol/skript/util/SkriptColor.java

@@ -81,12 +57,17 @@ public enum SkriptColor implements Color {

 	private ChatColor chat;
 	private DyeColor dye;
-	@Nullable
-	private Adjective adjective;
+	private @Nullable Adjective adjective;


Is this field still Nullable now that the setter is gone?

APickledWalrus · 2024-12-15T05:20:31Z

src/main/java/org/skriptlang/skript/misc/colors/ColorUtils.java

+import org.jetbrains.annotations.NotNull;
+
+/**
+ * Utility class for colour manipulation and conversion.


Suggested change

* Utility class for colour manipulation and conversion.

* Utility class for color manipulation and conversion.

APickledWalrus · 2024-12-15T05:21:56Z

src/main/java/org/skriptlang/skript/misc/colors/ColorUtils.java

+ */
+public class ColorUtils {
+
+	public static Color fromInt(int asInt) {


APickledWalrus · 2024-12-15T05:40:31Z

src/main/java/org/skriptlang/skript/misc/colors/ExprBlend.java

+	public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, ParseResult parseResult) {
+		this.colours = (Expression<Color>) exprs[0];
+		this.blendWith = (Expression<Color>) exprs[1];
+		this.amount	= (Expression<Number>) exprs[2];


Suggested change

this.amount = (Expression<Number>) exprs[2];

this.amount = (Expression<Number>) exprs[2];

APickledWalrus · 2024-12-15T05:44:13Z

src/main/java/org/skriptlang/skript/misc/colors/ExprBlend.java

+			"%colors% (blended|mixed) with %colors% [by [a[n] (factor|amount) of] %-number%]",
+			"blend of %colors% (and|with) %colors% [by [a[n] (factor|amount) of] %-number%]",
+			"%colors% and %colors% blen(ded|t) together [by [a[n] (factor|amount) of] %-number%]");


Suggested change

"%colors% (blended|mixed) with %colors% [by [a[n] (factor|amount) of] %-number%]",

"blend of %colors% (and|with) %colors% [by [a[n] (factor|amount) of] %-number%]",

"%colors% and %colors% blen(ded|t) together [by [a[n] (factor|amount) of] %-number%]");

"%colors% (blended|mixed) with %colors% [by [(a factor|an amount) of] %-number%]",

"blend of %colors% (and|with) %colors% [by [(a factor|an amount) of] %-number%]",

"%colors% and %colors% blen(ded|t) together [by [(a factor|an amount) of] %-number%]");

I think this is somewhat easier to read (and a bit more correct!)

APickledWalrus · 2024-12-15T05:49:36Z

src/main/java/org/skriptlang/skript/misc/colors/ExprComplementaryColor.java

+
+	@Override
+	protected String getPropertyName() {
+		return "complementary color";


Suggested change

return "complementary color";

return (hsl ? "hsl " : "") + "complementary color";

APickledWalrus · 2024-12-15T05:50:01Z

src/main/java/org/skriptlang/skript/misc/colors/ExprComplementaryColor.java

+	}
+
+	@Override
+	protected String getPropertyName() {


Should be placed after getReturnType

APickledWalrus · 2024-12-15T05:50:17Z

src/main/java/org/skriptlang/skript/misc/colors/ExprHex.java

+	@Override
+	public Class<? extends String> getReturnType() {
+		return String.class;
+	}


Suggested change

}

}

cheeezburga added 17 commits December 7, 2024 17:58

Still a WIP, implements some functions and expressions

401baaf

Adds blend expression

bd64435

Adds complement expression

ae81c9e

Small change

d5985d6

Fixed invalid spelling of colour throwing a pattern exception

fc342b8

Fixed invalid spelling of colour throwing a pattern exception

50e064c

Adds hex code expression

a1cadb7

- Also fixes blending util method using old, wrong scale

Adds channel as an option in ExprARGB's patterns

e2d9081

Fixes number logic and adds another pattern to ExprBlend

b50ed36

Removes the <> being included in the hex code util method

2427be4

Adds hex codes test

d725215

Adds colour blending test

9875ffe

Adds colour complements test

67320f9

Fixes tests

3123bdb

Adds function tests (shade, tint, brightness, grayscale, sepiatone)

34d2024

Fixes brightness test

d07ce14

Adds documentation to ColourUtils

c0e9cd7

cheeezburga requested review from sovdeeth, UnderscoreTud, APickledWalrus and Moderocky and removed request for sovdeeth and UnderscoreTud December 8, 2024 04:56

sovdeeth requested changes Dec 8, 2024

View reviewed changes

Fusezion reviewed Dec 8, 2024

View reviewed changes

Efnilite requested changes Dec 8, 2024

View reviewed changes

Efnilite added the feature Pull request adding a new feature. label Dec 8, 2024

cheeezburga added 7 commits December 9, 2024 19:28

Changes all 'colour's to 'color's and adds better descriptions and ex…

e1f6364

…amples

Changes all 'colour's to 'color's and adds better descriptions and ex…

ed49cfd

…amples

Moves hex conversion to Color class in lieu of static util method and…

a8758b3

… some cleanup

Adds some comments and changes variable names to not be just single c…

99fb214

…haracters

Adds doc annotations to ExprHex

b6b4dee

Some small doc/pattern changes

641fa49

First attempt at serialization of colors

7340a72

- Works for ColorRGBs but not SkriptColors

APickledWalrus requested changes Dec 15, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Colours Are Cool 🌈 #7246

Colours Are Cool 🌈 #7246

cheeezburga commented Dec 8, 2024 •

edited

Loading

sovdeeth left a comment

sovdeeth Dec 8, 2024

sovdeeth Dec 8, 2024

cheeezburga Dec 8, 2024

sovdeeth Dec 15, 2024

sovdeeth Dec 8, 2024

Fusezion left a comment •

edited

Loading

Efnilite left a comment

cheeezburga commented Dec 8, 2024

APickledWalrus Dec 15, 2024

APickledWalrus Dec 15, 2024

APickledWalrus Dec 15, 2024

APickledWalrus Dec 15, 2024

APickledWalrus Dec 15, 2024

APickledWalrus Dec 15, 2024

APickledWalrus Dec 15, 2024

APickledWalrus Dec 15, 2024

APickledWalrus Dec 15, 2024

APickledWalrus Dec 15, 2024

	package org.skriptlang.skript.misc.colors;
	package org.skriptlang.skript.common.colors;

	* Utility class for colour manipulation and conversion.
	* Utility class for color manipulation and conversion.

	this.amount = (Expression<Number>) exprs[2];
	this.amount = (Expression<Number>) exprs[2];

	return "complementary color";
	return (hsl ? "hsl " : "") + "complementary color";

Colours Are Cool 🌈 #7246

Are you sure you want to change the base?

Colours Are Cool 🌈 #7246

Conversation

cheeezburga commented Dec 8, 2024 • edited Loading

Description

sovdeeth left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Fusezion left a comment • edited Loading

Choose a reason for hiding this comment

Efnilite left a comment

Choose a reason for hiding this comment

cheeezburga commented Dec 8, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cheeezburga commented Dec 8, 2024 •

edited

Loading

Fusezion left a comment •

edited

Loading