Skip to content

Commit db8b4b8

Browse files
twisti-devtwisti-dev
authored
Document NOTE color constant in Colors.kt (#174)
2 parents d3a4350 + a9fc24c commit db8b4b8

File tree

6 files changed

+25
-2
lines changed

6 files changed

+25
-2
lines changed

‎gradle.properties‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@ org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled
77
javaVersion=21
88
mcVersion=1.21.11
99
group=dev.slne.surf
10-
version=1.21.11-2.48.0
10+
version=1.21.11-2.49.0
1111
relocationPrefix=dev.slne.surf.surfapi.libs
1212
snapshot=false

‎surf-api-bukkit/surf-api-bukkit-api/api/surf-api-bukkit-api.api‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12345,6 +12345,7 @@ public abstract interface class dev/slne/surf/surfapi/core/api/messages/Colors {
1234512345
public static final field GREEN Lnet/kyori/adventure/text/format/NamedTextColor;
1234612346
public static final field INFO Lnet/kyori/adventure/text/format/TextColor;
1234712347
public static final field LIGHT_PURPLE Lnet/kyori/adventure/text/format/NamedTextColor;
12348+
public static final field NOTE Lnet/kyori/adventure/text/format/TextColor;
1234812349
public static final field PREFIX Lnet/kyori/adventure/text/Component;
1234912350
public static final field PREFIX_COLOR Lnet/kyori/adventure/text/format/TextColor;
1235012351
public static final field PRIMARY Lnet/kyori/adventure/text/format/TextColor;
@@ -12773,6 +12774,7 @@ public abstract interface class dev/slne/surf/surfapi/core/api/messages/builder/
1277312774
public abstract fun mergeStyle (Lnet/kyori/adventure/text/Component;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
1277412775
public abstract fun mergeStyle (Lnet/kyori/adventure/text/Component;Ljava/util/Set;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
1277512776
public abstract fun mergeStyle (Lnet/kyori/adventure/text/Component;[Lnet/kyori/adventure/text/format/Style$Merge;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
12777+
public fun note (Ljava/lang/Object;[Lnet/kyori/adventure/text/format/TextDecoration;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
1277612778
public fun primary (C[Lnet/kyori/adventure/text/format/TextDecoration;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
1277712779
public fun primary (D[Lnet/kyori/adventure/text/format/TextDecoration;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
1277812780
public fun primary (F[Lnet/kyori/adventure/text/format/TextDecoration;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
@@ -12895,6 +12897,7 @@ public final class dev/slne/surf/surfapi/core/api/messages/builder/SurfComponent
1289512897
public static fun info (Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;J[Lnet/kyori/adventure/text/format/TextDecoration;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
1289612898
public static fun info (Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;Ljava/lang/String;[Lnet/kyori/adventure/text/format/TextDecoration;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
1289712899
public static fun info (Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;Z[Lnet/kyori/adventure/text/format/TextDecoration;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
12900+
public static fun note (Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;Ljava/lang/Object;[Lnet/kyori/adventure/text/format/TextDecoration;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
1289812901
public static fun primary (Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;C[Lnet/kyori/adventure/text/format/TextDecoration;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
1289912902
public static fun primary (Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;D[Lnet/kyori/adventure/text/format/TextDecoration;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
1290012903
public static fun primary (Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;F[Lnet/kyori/adventure/text/format/TextDecoration;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;

‎surf-api-core/surf-api-core-api/api/surf-api-core-api.api‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6935,6 +6935,7 @@ public abstract interface class dev/slne/surf/surfapi/core/api/messages/Colors {
69356935
public static final field GREEN Lnet/kyori/adventure/text/format/NamedTextColor;
69366936
public static final field INFO Lnet/kyori/adventure/text/format/TextColor;
69376937
public static final field LIGHT_PURPLE Lnet/kyori/adventure/text/format/NamedTextColor;
6938+
public static final field NOTE Lnet/kyori/adventure/text/format/TextColor;
69386939
public static final field PREFIX Lnet/kyori/adventure/text/Component;
69396940
public static final field PREFIX_COLOR Lnet/kyori/adventure/text/format/TextColor;
69406941
public static final field PRIMARY Lnet/kyori/adventure/text/format/TextColor;
@@ -7363,6 +7364,7 @@ public abstract interface class dev/slne/surf/surfapi/core/api/messages/builder/
73637364
public abstract fun mergeStyle (Lnet/kyori/adventure/text/Component;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
73647365
public abstract fun mergeStyle (Lnet/kyori/adventure/text/Component;Ljava/util/Set;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
73657366
public abstract fun mergeStyle (Lnet/kyori/adventure/text/Component;[Lnet/kyori/adventure/text/format/Style$Merge;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
7367+
public fun note (Ljava/lang/Object;[Lnet/kyori/adventure/text/format/TextDecoration;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
73667368
public fun primary (C[Lnet/kyori/adventure/text/format/TextDecoration;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
73677369
public fun primary (D[Lnet/kyori/adventure/text/format/TextDecoration;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
73687370
public fun primary (F[Lnet/kyori/adventure/text/format/TextDecoration;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
@@ -7485,6 +7487,7 @@ public final class dev/slne/surf/surfapi/core/api/messages/builder/SurfComponent
74857487
public static fun info (Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;J[Lnet/kyori/adventure/text/format/TextDecoration;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
74867488
public static fun info (Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;Ljava/lang/String;[Lnet/kyori/adventure/text/format/TextDecoration;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
74877489
public static fun info (Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;Z[Lnet/kyori/adventure/text/format/TextDecoration;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
7490+
public static fun note (Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;Ljava/lang/Object;[Lnet/kyori/adventure/text/format/TextDecoration;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
74887491
public static fun primary (Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;C[Lnet/kyori/adventure/text/format/TextDecoration;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
74897492
public static fun primary (Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;D[Lnet/kyori/adventure/text/format/TextDecoration;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
74907493
public static fun primary (Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;F[Lnet/kyori/adventure/text/format/TextDecoration;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;

‎surf-api-core/surf-api-core-api/src/main/kotlin/dev/slne/surf/surfapi/core/api/messages/Colors.kt‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,17 @@ interface Colors {
4444
@JvmField
4545
val INFO: TextColor = color(0x97B3F7)
4646

47+
/**
48+
* The note color (#6EA6D9).
49+
* Used for supplemental or side-note information that adds context,
50+
* tips, or clarifications to a primary message.
51+
* Prefer this for ancillary guidance rather than main content:
52+
* use [INFO] for neutral system messages or status updates, and [PRIMARY]
53+
* for branded elements such as titles or key headings.
54+
*/
55+
@JvmField
56+
val NOTE: TextColor = color(0x6EA6D9)
57+
4758
/**
4859
* The success color (#65ff64).
4960
* Indicates a positive outcome of a user action and is always

‎surf-api-core/surf-api-core-api/src/main/kotlin/dev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder.kt‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ package dev.slne.surf.surfapi.core.api.messages.builder
33
import dev.slne.surf.surfapi.core.api.messages.Colors.Companion.DARK_SPACER
44
import dev.slne.surf.surfapi.core.api.messages.Colors.Companion.ERROR
55
import dev.slne.surf.surfapi.core.api.messages.Colors.Companion.INFO
6+
import dev.slne.surf.surfapi.core.api.messages.Colors.Companion.NOTE
67
import dev.slne.surf.surfapi.core.api.messages.Colors.Companion.PREFIX
78
import dev.slne.surf.surfapi.core.api.messages.Colors.Companion.PRIMARY
89
import dev.slne.surf.surfapi.core.api.messages.Colors.Companion.SECONDARY
@@ -124,6 +125,8 @@ interface SurfComponentBuilder : TextComponent.Builder {
124125
fun info(int: Int, vararg decoration: TextDecoration) = text(int, INFO, *decoration)
125126
fun info(long: Long, vararg decoration: TextDecoration) = text(long, INFO, *decoration)
126127

128+
fun note(any: Any, vararg decoration: TextDecoration) = text(any.toString(), NOTE, *decoration)
129+
127130
fun success(text: String, vararg decoration: TextDecoration) = text(text, SUCCESS, *decoration)
128131
fun success(boolean: Boolean, vararg decoration: TextDecoration) =
129132
text(boolean, SUCCESS, *decoration)
@@ -339,4 +342,4 @@ interface SurfComponentBuilder : TextComponent.Builder {
339342
override fun style(style: Style): SurfComponentBuilder
340343
override fun shadowColor(argb: ARGBLike?): SurfComponentBuilder
341344
override fun shadowColorIfAbsent(argb: ARGBLike?): SurfComponentBuilder
342-
}
345+
}

‎surf-api-velocity/surf-api-velocity-api/api/surf-api-velocity-api.api‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10241,6 +10241,7 @@ public abstract interface class dev/slne/surf/surfapi/core/api/messages/Colors {
1024110241
public static final field GREEN Lnet/kyori/adventure/text/format/NamedTextColor;
1024210242
public static final field INFO Lnet/kyori/adventure/text/format/TextColor;
1024310243
public static final field LIGHT_PURPLE Lnet/kyori/adventure/text/format/NamedTextColor;
10244+
public static final field NOTE Lnet/kyori/adventure/text/format/TextColor;
1024410245
public static final field PREFIX Lnet/kyori/adventure/text/Component;
1024510246
public static final field PREFIX_COLOR Lnet/kyori/adventure/text/format/TextColor;
1024610247
public static final field PRIMARY Lnet/kyori/adventure/text/format/TextColor;
@@ -10669,6 +10670,7 @@ public abstract interface class dev/slne/surf/surfapi/core/api/messages/builder/
1066910670
public abstract fun mergeStyle (Lnet/kyori/adventure/text/Component;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
1067010671
public abstract fun mergeStyle (Lnet/kyori/adventure/text/Component;Ljava/util/Set;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
1067110672
public abstract fun mergeStyle (Lnet/kyori/adventure/text/Component;[Lnet/kyori/adventure/text/format/Style$Merge;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
10673+
public fun note (Ljava/lang/Object;[Lnet/kyori/adventure/text/format/TextDecoration;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
1067210674
public fun primary (C[Lnet/kyori/adventure/text/format/TextDecoration;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
1067310675
public fun primary (D[Lnet/kyori/adventure/text/format/TextDecoration;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
1067410676
public fun primary (F[Lnet/kyori/adventure/text/format/TextDecoration;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
@@ -10791,6 +10793,7 @@ public final class dev/slne/surf/surfapi/core/api/messages/builder/SurfComponent
1079110793
public static fun info (Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;J[Lnet/kyori/adventure/text/format/TextDecoration;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
1079210794
public static fun info (Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;Ljava/lang/String;[Lnet/kyori/adventure/text/format/TextDecoration;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
1079310795
public static fun info (Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;Z[Lnet/kyori/adventure/text/format/TextDecoration;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
10796+
public static fun note (Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;Ljava/lang/Object;[Lnet/kyori/adventure/text/format/TextDecoration;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
1079410797
public static fun primary (Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;C[Lnet/kyori/adventure/text/format/TextDecoration;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
1079510798
public static fun primary (Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;D[Lnet/kyori/adventure/text/format/TextDecoration;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
1079610799
public static fun primary (Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;F[Lnet/kyori/adventure/text/format/TextDecoration;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;

0 commit comments

Comments
 (0)