net.tridentsdk.service

Interface ChatIdentityFormatter

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface ChatIdentityFormatter

Provides chat properties to the ChatFormatter

The formatting provides only the left most portion (the player name and prompt), not the actual chat message

Since:

0.3-alpha-DP

Author:

The TridentSDK Team

Method Summary

Modifier and Type	Method and Description
String	format(String message, Player sender) Obtains a formatted string of the chat identifier
default void	overriden(ChatIdentityFormatter other, Plugin overrider) A callback indicating the overriding of this provider

Method Detail

format

String format(String message,
              Player sender)

Obtains a formatted string of the chat identifier

• %p - the default prefix
• %n - the player name
• %s - the default suffix
• %d - the default prompt

The default is usually %n>. The default is filled in, but cannot replace the default string.

Examples:

     // Default is: John>

     // [Prefix]John[Suffix]>>
     return "[Prefix]%n[Suffix]>>";

     // [Prefix]JOHN>
     return "[Prefix]" + sender.displayName().toUpperCase() + "%d";
 

It is generally a good idea to use the provided variables than to hardcode them, as the implementation is allowed to change the chat characters.

Parameters:

message - the default identifier

sender - the player sending the identifier

Returns:

the foratted string

overriden

default void overriden(ChatIdentityFormatter other,
                       Plugin overrider)

A callback indicating the overriding of this provider

Parameters:

other - the chat provider that is being set

overrider - the plugin that is setting the overrider