Upstream/war
1
0
Fork 0
mirror of https://github.com/taoneill/war.git synced 2024-11-30 06:03:23 +01:00
Code Issues Projects Releases Wiki Activity

Nicer messages with words unbroken at end-of-line

Browse Source 
Closes gh-493. Looks much better. Just had to drop an old ChatFixUtil
from the olden days before Bukkit at all that fancy end-of-word line
breaks built in. Should have done this much earlier. Thanks for
reminding me to remove this @cmastudios.
This commit is contained in:
taoneill 2012-06-21 19:51:14 -04:00
parent c6e98769e5
commit 53aa9cda52
2 changed files with 3 additions and 189 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
war/src/main/java/com/tommytony/war/War.java
View File

@ -46,11 +46,10 @@ import com.tommytony.war.mapper.WarzoneYmlMapper;
import com.tommytony.war.spout.SpoutDisplayer;
import com.tommytony.war.structure.Bomb;
import com.tommytony.war.structure.Cake;
import com.tommytony.war.structure.HubLobbyMaterials;
import com.tommytony.war.structure.Monument;
import com.tommytony.war.structure.WarHub;
import com.tommytony.war.structure.HubLobbyMaterials;
import com.tommytony.war.structure.ZoneLobby;
import com.tommytony.war.utility.ChatFixUtil;
import com.tommytony.war.utility.PlayerState;
import com.tommytony.war.utility.SizeCounter;
import com.tommytony.war.utility.WarLogFormatter;
@ -843,7 +842,7 @@ public class War extends JavaPlugin {
public void msg(CommandSender sender, String str) {
if (sender instanceof Player) {
String out = ChatColor.GRAY + "War> " + ChatColor.WHITE + this.colorKnownTokens(str, ChatColor.WHITE) + " ";
ChatFixUtil.sendMessage(sender, out);
sender.sendMessage(out);
} else {
sender.sendMessage("War> " + str);
}
@ -852,7 +851,7 @@ public class War extends JavaPlugin {
public void badMsg(CommandSender sender, String str) {
if (sender instanceof Player) {
String out = ChatColor.GRAY + "War> " + ChatColor.RED + this.colorKnownTokens(str, ChatColor.RED) + " ";
ChatFixUtil.sendMessage(sender, out);
sender.sendMessage(out);
} else {
sender.sendMessage("War> " + str);
}

185
war/src/main/java/com/tommytony/war/utility/ChatFixUtil.java
View File

@ -1,185 +0,0 @@
package com.tommytony.war.utility;
import java.util.*;
import org.bukkit.command.CommandSender;
/**
* The purpose of this tool is twofold: 1: Avoid client crashes due to bad color formating. 2: Make color continue on word wrapping
*
* In minecraft the degree sign is used as a prefix to another char to create a color. For example the code for white is "\u00A7f". The "\u00A7" is the unicode notation for the degree sign and the "f" means white.
*
* When does minecraft wrap the text? After how many chars? Answer: Because the font isn't monospace this differs depending on what you write. However we can fit 53 "M" without wrapping and the 54th char would then wrap (be at the beginning of the next line instead) As there is no broader char than "M" we can know for sure the minimum line length is 53. Note that this means the number of DISPLAYED chars per row is 53. A degree sign and the char after will NOT count, as they will not be displayed as chars.
*
* Good to know: Numbers have the same font width as an M.
*
* When does the client crash? Answer: When a row ends with a degree char and optionally another sign after. Another way to say the same: When a line ends with either a broken or valid color notation. AND The client will ALWAYS crash if the sign after the last displayed char in a row is a degree char. A goofy way to explatin it: For a line with only "M" and numbers, the fiftyfourth "displayed char" musn't be a degree sign.
*
* WARNING: Above is a hypothesis I have created based on what my experiments have shown. I am fairly sure it is correct but please help me test it further.
*/
public class ChatFixUtil {
public final static char deg = '\u00A7';
public final static int lineLength = 53;
/**
* This method wraps the msg for you at row lengths of 53, avoids client crash scenarios and makes the previous color continue on the next line.
*
* The upsides with filtering your messages through this method are: - No client crashes. - Line wrapping with preserved color.
*
* The downsides are: - The width of the chat window will not be used to it's fullest. For example you can fit more that 53 commas (,) in a chatwindow row but the line would break after 53 displayed chars.
*
* Suggested usage: NO NEED TO USE the fix method for static help pages in your plugin. As the text is static you can make sure there is no client crash yourself and be able to use the full line length.
*
* DO USE in cases like where you output colored messages with playernames in your plugin. As the player names have different length there is potential for client crash.
*/
public static ArrayList<String> fix(String msg) {
// Make sure the end of msg is good
msg = ChatFixUtil.cleanMsgEnding(msg);
ArrayList<String> ret = new ArrayList<String>();
int displen = 0; // The number of displayed chars in row so far.
String row = "";
String latestColor = null;
for (int i = 0; i < msg.length(); i++) {
if (displen == ChatFixUtil.lineLength) {
// it is time to start on the next row!
ret.add(row);
displen = 0;
row = "";
if (latestColor != null) {
row += ChatFixUtil.deg + latestColor;
}
}
char c = msg.charAt(i);
if (c == ChatFixUtil.deg) {
latestColor = String.valueOf(msg.charAt(i + 1));
row += ChatFixUtil.deg + latestColor;
i++;
} else {
displen += 1;
row += c;
}
}
ret.add(row);
return ret;
}
public static ArrayList<String> fix(List<String> messages) {
ArrayList<String> ret = new ArrayList<String>();
for (String message : messages) {
ret.addAll(ChatFixUtil.fix(message));
}
return ret;
}
/**
* Removes the ending chars as long as they are deg or deg+'anychar' or a space As I see it we would never want those chars at the end of a msg.
*/
protected static String cleanMsgEnding(String msg) {
while (msg.length() > 0) {
if (msg.endsWith(String.valueOf(ChatFixUtil.deg)) || msg.endsWith(" ")) {
msg = msg.substring(0, msg.length() - 1);
} else if (msg.length() >= 2 && msg.charAt(msg.length() - 2) == ChatFixUtil.deg) {
msg = msg.substring(0, msg.length() - 2);
} else {
break;
}
}
return msg;
}
/**
* This test util assumes line break after 53 displayed chars. The fix method above breaks like that so this method should be a valid way to test if a message row would crash a client.
*/
public static String thisMsgWouldCrashClient(String str) {
// There would always be crash if we end with deg or deg+'anychar'
if (str.length() >= 1 && str.charAt(str.length() - 1) == ChatFixUtil.deg) {
return "Crash: The str ends with deg.";
} else if (str.length() >= 2 && str.charAt(str.length() - 2) == ChatFixUtil.deg) {
return "Crash: The str ends with deg+'anychar'.";
}
int displayedChars = 0;
for (int i = 0; i < str.length(); i++) {
char c = str.charAt(i);
if (c == ChatFixUtil.deg && displayedChars == ChatFixUtil.lineLength) {
return "Crash: Deg as fiftyforth \"displayed\" char";
} else if (c == ChatFixUtil.deg) {
i++; // this and next: they are not displayed... skip them...
} else {
displayedChars += 1;
}
}
return "all ok";
}
// ----------------------------------------------//
// Methods for effectively sending messages
// ----------------------------------------------//
// ----------------------------------------------//
// One player
// ----------------------------------------------//
public static void sendMessage(CommandSender player, String message, boolean fix) {
if (fix) {
List<String> messages = ChatFixUtil.fix(message);
ChatFixUtil.sendMessage(player, messages, false);
} else {
if (player != null) {
player.sendMessage(message);
}
}
}
public static void sendMessage(CommandSender player, List<String> messages, boolean fix) {
if (fix) {
messages = ChatFixUtil.fix(messages);
}
for (String message : messages) {
ChatFixUtil.sendMessage(player, message, false);
}
}
public static void sendMessage(CommandSender player, String message) {
ChatFixUtil.sendMessage(player, message, true);
}
public static void sendMessage(CommandSender player, List<String> messages) {
ChatFixUtil.sendMessage(player, messages, true);
}
// ----------------------------------------------//
// Many CommandSenders
// ----------------------------------------------//
public static void sendMessage(Collection<CommandSender> players, String message, boolean fix) {
if (fix) {
List<String> messages = ChatFixUtil.fix(message);
ChatFixUtil.sendMessage(players, messages, false);
} else {
for (CommandSender player : players) {
ChatFixUtil.sendMessage(player, message, false);
}
}
}
public static void sendMessage(Collection<CommandSender> players, List<String> messages, boolean fix) {
if (fix) {
messages = ChatFixUtil.fix(messages);
}
for (String message : messages) {
ChatFixUtil.sendMessage(players, message, false);
}
}
public static void sendMessage(Collection<CommandSender> players, String message) {
ChatFixUtil.sendMessage(players, message, true);
}
public static void sendMessage(Collection<CommandSender> players, List<String> messages) {
ChatFixUtil.sendMessage(players, messages, true);
}
}