feature: add the suppress sending feature to allow to suppress the …

…sending of message by its key. (core)
sakurawald · Jan 3, 2025 · 7bc78f1 · 7bc78f1
1 parent 8b090e2
commit 7bc78f1
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 1 deletion.
diff --git a/docs/chapters/module/language/language.tex b/docs/chapters/module/language/language.tex
@@ -19,3 +19,8 @@
 \LevelTwo{Difference}
 Disabled: All the players use the \ttt{default\_language}.\\
 Enabled: Fuji will \textbf{try} to respect the player's client-side language, if the server-side supports.
+
+\LevelTwo{Example}
+\begin{example}{To supress the sending of a message}
+    Set the value of a message key to \str{[suppress-sending]}, to suppress the sending of this type of message.
+\end{example}
diff --git a/docs/chapters/module/teleport_warmup/teleport_warmup.tex b/docs/chapters/module/teleport_warmup/teleport_warmup.tex
@@ -32,5 +32,5 @@
 
 \LevelTwo{Meta}
 \begin{description}
-    \item [fuji.teleport_warmup.warmup] The per player teleport warmup time in seconds.
+    \item [fuji.teleport\_warmup.warmup] The per player teleport warmup time in seconds.
 \end{description}
diff --git a/docs/release/fuji.pdf b/docs/release/fuji.pdf
diff --git a/src/main/java/io/github/sakurawald/core/auxiliary/minecraft/TextHelper.java b/src/main/java/io/github/sakurawald/core/auxiliary/minecraft/TextHelper.java
@@ -57,6 +57,9 @@ public class TextHelper {
     private static final Map<String, JsonObject> code2json = new HashMap<>();
     private static final JsonObject UNSUPPORTED_LANGUAGE_MARKER = new JsonObject();
 
+    private static final String SUPPRESS_SENDING_STRING_MARKER = "[suppress-sending]";
+    private static final Text SUPPRESS_SENDING_TEXT_MARKER = Text.literal("[suppress-sending]");
+
     static {
         writeDefaultLanguageFilesIfAbsent();
 
@@ -219,6 +222,11 @@ private static boolean isDefaultLanguageCode(String languageCode) {
     private static @NotNull Text getText(@NonNull NodeParser parser, @Nullable Object audience, boolean isKey, String keyOrValue, Object... args) {
         String value = isKey ? getValueByKey(audience, keyOrValue) : keyOrValue;
 
+        // suppress this sending?
+        if (value.equals(SUPPRESS_SENDING_STRING_MARKER)) {
+            return SUPPRESS_SENDING_TEXT_MARKER;
+        }
+
         // resolve args
         value = resolveArgs(value, args);
 
@@ -292,6 +300,13 @@ public static void sendMessageByFlag(@NotNull Object audience, boolean flag) {
     public static void sendMessageByKey(@NotNull Object audience, String key, Object... args) {
         Text text = getTextByKey(audience, key, args);
 
+        /* suppress this sending ? */
+        if (text == SUPPRESS_SENDING_TEXT_MARKER) {
+            LogUtil.debug("Suppress the sending of message: audience = {}, key = {}, args = {}", audience, key, args);
+            return;
+        }
+
+
         /* extract the source */
         if (audience instanceof CommandContext<?> ctx) {
             audience = ctx.getSource();