Redstoner/ModuleLoader
Archived
0
Fork 0
Code Pull Requests Activity

Updated documentation

Browse Source
This commit is contained in:
Pepich 2017-02-01 16:30:26 +01:00
parent 2843ff9fdf
commit c89b43d247
1 changed files with 18 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
src/com/redstoner/misc/Utils.java
View File

@ -13,7 +13,7 @@ import net.md_5.bungee.api.ChatColor;
/** The utils class containing utility functions. Those include but are not limited to sending formatted messages, broadcasts and more. /** The utils class containing utility functions. Those include but are not limited to sending formatted messages, broadcasts and more.
* *
* @author Pepich */ * @author Pepich */
@Version(major = 1, minor = 1, revision = 0, compatible = 1) @Version(major = 1, minor = 1, revision = 1, compatible = 1)
public final class Utils public final class Utils
{ {
/** Hidden constructor. Do not instantiate UTILS classes! :) */ /** Hidden constructor. Do not instantiate UTILS classes! :) */
@ -80,25 +80,33 @@ public final class Utils
ChatColor.translateAlternateColorCodes(alternateColorCode, message)); ChatColor.translateAlternateColorCodes(alternateColorCode, message));
} }
/** @param message /** This method broadcasts a message to all players (and console) that are allowed by the filter. Set the filter to NULL to broadcast to everyone.</br>
* @param filter * This will not be logged to console except when you return true in the filter.
* @return */ *
* @param message the message to be sent around
* @param filter the BroadcastFilter to be applied.</br>
* Write a class implementing the interface and pass it to this method, the "sendTo()" method will be called for each recipient.
* @return the amount of people that received the message. */
public static int broadcast(String prefix, String message, BroadcastFilter filter) public static int broadcast(String prefix, String message, BroadcastFilter filter)
{ {
return broadcast(prefix, message, filter, null); return broadcast(prefix, message, filter, null);
} }
/** @param message /** This method broadcasts a message to all players and console that are allowed by the filter. Set the filter to NULL to broadcast to everyone.</br>
* @param filter * If you want to, you can set a message that will be logged to console. Set to null to not log anything.</br>
* @param log * You can still allow console in the filter to log the original message.
* @return */ *
* @param message the message to be sent around
* @param filter the BroadcastFilter to be applied.</br>
* Write a class implementing the interface and pass it to this method, the "sendTo()" method will be called for each recipient.
* @param logmessage the log message to appear in console. Set to null to not log this (you can still log the original message by returning true in the filter).
* @return the amount of people that received the message. */
@Debugable @Debugable
public static int broadcast(String prefix, String message, BroadcastFilter filter, String logmessage) public static int broadcast(String prefix, String message, BroadcastFilter filter, String logmessage)
{ {
Debugger.notifyMethod(message, filter, logmessage); Debugger.notifyMethod(message, filter, logmessage);
if (logmessage != null) if (logmessage != null)
sendMessage(Bukkit.getConsoleSender(), prefix, sendMessage(Bukkit.getConsoleSender(), prefix, logmessage);
logmessage + (filter == null ? " §7(global)" : " §7(filtered)"));
if (filter == null) if (filter == null)
{ {
for (Player p : Bukkit.getOnlinePlayers()) for (Player p : Bukkit.getOnlinePlayers())