Skip to content

Document NOTE color constant in Colors.kt #174

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
twisti-dev merged 5 commits into from
Dec 28, 2025
Merged

Document NOTE color constant in Colors.kt #174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
22de7c9
Document NOTE color constant in Colors.kt
TheBjoRedCraft Dec 28, 2025
17ec451
Add note function to SurfComponentBuilder
TheBjoRedCraft Dec 28, 2025
2e4a0d9
Update surf-api-core/surf-api-core-api/src/main/kotlin/dev/slne/surf/…
TheBjoRedCraft Dec 28, 2025
4211b8d
feat: add `note` function and `NOTE` field to support styled text dec…
TheBjoRedCraft Dec 28, 2025
a9fc24c
Update version to 1.21.11-2.49.0
twisti-dev Dec 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion gradle.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled
javaVersion=21
mcVersion=1.21.11
group=dev.slne.surf
version=1.21.11-2.48.0
version=1.21.11-2.49.0
relocationPrefix=dev.slne.surf.surfapi.libs
snapshot=false
3 changes: 3 additions & 0 deletions surf-api-bukkit/surf-api-bukkit-api/api/surf-api-bukkit-api.api
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12345,6 +12345,7 @@ public abstract interface class dev/slne/surf/surfapi/core/api/messages/Colors {
public static final field GREEN Lnet/kyori/adventure/text/format/NamedTextColor;
public static final field INFO Lnet/kyori/adventure/text/format/TextColor;
public static final field LIGHT_PURPLE Lnet/kyori/adventure/text/format/NamedTextColor;
public static final field NOTE Lnet/kyori/adventure/text/format/TextColor;
public static final field PREFIX Lnet/kyori/adventure/text/Component;
public static final field PREFIX_COLOR Lnet/kyori/adventure/text/format/TextColor;
public static final field PRIMARY Lnet/kyori/adventure/text/format/TextColor;
Expand Down Expand Up @@ -12773,6 +12774,7 @@ public abstract interface class dev/slne/surf/surfapi/core/api/messages/builder/
public abstract fun mergeStyle (Lnet/kyori/adventure/text/Component;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
public abstract fun mergeStyle (Lnet/kyori/adventure/text/Component;Ljava/util/Set;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
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;
public fun note (Ljava/lang/Object;[Lnet/kyori/adventure/text/format/TextDecoration;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
public fun primary (C[Lnet/kyori/adventure/text/format/TextDecoration;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
public fun primary (D[Lnet/kyori/adventure/text/format/TextDecoration;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
public fun primary (F[Lnet/kyori/adventure/text/format/TextDecoration;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
Expand Down Expand Up @@ -12895,6 +12897,7 @@ public final class dev/slne/surf/surfapi/core/api/messages/builder/SurfComponent
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;
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;
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;
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;
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;
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;
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;
Expand Down
3 changes: 3 additions & 0 deletions surf-api-core/surf-api-core-api/api/surf-api-core-api.api
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6935,6 +6935,7 @@ public abstract interface class dev/slne/surf/surfapi/core/api/messages/Colors {
public static final field GREEN Lnet/kyori/adventure/text/format/NamedTextColor;
public static final field INFO Lnet/kyori/adventure/text/format/TextColor;
public static final field LIGHT_PURPLE Lnet/kyori/adventure/text/format/NamedTextColor;
public static final field NOTE Lnet/kyori/adventure/text/format/TextColor;
public static final field PREFIX Lnet/kyori/adventure/text/Component;
public static final field PREFIX_COLOR Lnet/kyori/adventure/text/format/TextColor;
public static final field PRIMARY Lnet/kyori/adventure/text/format/TextColor;
Expand Down Expand Up @@ -7363,6 +7364,7 @@ public abstract interface class dev/slne/surf/surfapi/core/api/messages/builder/
public abstract fun mergeStyle (Lnet/kyori/adventure/text/Component;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
public abstract fun mergeStyle (Lnet/kyori/adventure/text/Component;Ljava/util/Set;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
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;
public fun note (Ljava/lang/Object;[Lnet/kyori/adventure/text/format/TextDecoration;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
public fun primary (C[Lnet/kyori/adventure/text/format/TextDecoration;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
public fun primary (D[Lnet/kyori/adventure/text/format/TextDecoration;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
public fun primary (F[Lnet/kyori/adventure/text/format/TextDecoration;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
Expand Down Expand Up @@ -7485,6 +7487,7 @@ public final class dev/slne/surf/surfapi/core/api/messages/builder/SurfComponent
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;
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;
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;
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;
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;
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;
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;
Expand Down
11 changes: 11 additions & 0 deletions ...-core/surf-api-core-api/src/main/kotlin/dev/slne/surf/surfapi/core/api/messages/Colors.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,17 @@ interface Colors {
@JvmField
val INFO: TextColor = color(0x97B3F7)

/**
* The note color (#6EA6D9).
* Used for supplemental or side-note information that adds context,
* tips, or clarifications to a primary message.
* Prefer this for ancillary guidance rather than main content:
* use [INFO] for neutral system messages or status updates, and [PRIMARY]
* for branded elements such as titles or key headings.
*/
@JvmField
val NOTE: TextColor = color(0x6EA6D9)

/**
* The success color (#65ff64).
* Indicates a positive outcome of a user action and is always
Expand Down
5 changes: 4 additions & 1 deletion ...i/src/main/kotlin/dev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package dev.slne.surf.surfapi.core.api.messages.builder
import dev.slne.surf.surfapi.core.api.messages.Colors.Companion.DARK_SPACER
import dev.slne.surf.surfapi.core.api.messages.Colors.Companion.ERROR
import dev.slne.surf.surfapi.core.api.messages.Colors.Companion.INFO
import dev.slne.surf.surfapi.core.api.messages.Colors.Companion.NOTE
import dev.slne.surf.surfapi.core.api.messages.Colors.Companion.PREFIX
import dev.slne.surf.surfapi.core.api.messages.Colors.Companion.PRIMARY
import dev.slne.surf.surfapi.core.api.messages.Colors.Companion.SECONDARY
Expand Down Expand Up @@ -124,6 +125,8 @@ interface SurfComponentBuilder : TextComponent.Builder {
fun info(int: Int, vararg decoration: TextDecoration) = text(int, INFO, *decoration)
fun info(long: Long, vararg decoration: TextDecoration) = text(long, INFO, *decoration)

fun note(any: Any, vararg decoration: TextDecoration) = text(any.toString(), NOTE, *decoration)

fun success(text: String, vararg decoration: TextDecoration) = text(text, SUCCESS, *decoration)
fun success(boolean: Boolean, vararg decoration: TextDecoration) =
text(boolean, SUCCESS, *decoration)
Expand Down Expand Up @@ -339,4 +342,4 @@ interface SurfComponentBuilder : TextComponent.Builder {
override fun style(style: Style): SurfComponentBuilder
override fun shadowColor(argb: ARGBLike?): SurfComponentBuilder
override fun shadowColorIfAbsent(argb: ARGBLike?): SurfComponentBuilder
}
}
3 changes: 3 additions & 0 deletions surf-api-velocity/surf-api-velocity-api/api/surf-api-velocity-api.api
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10241,6 +10241,7 @@ public abstract interface class dev/slne/surf/surfapi/core/api/messages/Colors {
public static final field GREEN Lnet/kyori/adventure/text/format/NamedTextColor;
public static final field INFO Lnet/kyori/adventure/text/format/TextColor;
public static final field LIGHT_PURPLE Lnet/kyori/adventure/text/format/NamedTextColor;
public static final field NOTE Lnet/kyori/adventure/text/format/TextColor;
public static final field PREFIX Lnet/kyori/adventure/text/Component;
public static final field PREFIX_COLOR Lnet/kyori/adventure/text/format/TextColor;
public static final field PRIMARY Lnet/kyori/adventure/text/format/TextColor;
Expand Down Expand Up @@ -10669,6 +10670,7 @@ public abstract interface class dev/slne/surf/surfapi/core/api/messages/builder/
public abstract fun mergeStyle (Lnet/kyori/adventure/text/Component;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
public abstract fun mergeStyle (Lnet/kyori/adventure/text/Component;Ljava/util/Set;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
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;
public fun note (Ljava/lang/Object;[Lnet/kyori/adventure/text/format/TextDecoration;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
public fun primary (C[Lnet/kyori/adventure/text/format/TextDecoration;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
public fun primary (D[Lnet/kyori/adventure/text/format/TextDecoration;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
public fun primary (F[Lnet/kyori/adventure/text/format/TextDecoration;)Ldev/slne/surf/surfapi/core/api/messages/builder/SurfComponentBuilder;
Expand Down Expand Up @@ -10791,6 +10793,7 @@ public final class dev/slne/surf/surfapi/core/api/messages/builder/SurfComponent
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;
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;
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;
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;
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;
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;
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;
Expand Down