io.github.nucleuspowered.nucleus.api.service

Interface NucleusNicknameService

public interface NucleusNicknameService

Allows plugins to set and inspect a User's current nickname.

Method Summary

Modifier and Type	Method and Description
Optional<org.spongepowered.api.text.Text>	getNickname(org.spongepowered.api.entity.living.player.User user) Gets the current nickname for a user, if it exists.
Optional<org.spongepowered.api.text.Text>	getNicknameWithPrefix(org.spongepowered.api.entity.living.player.User user) Gets the current nickname for a user with prefix, if it exists.
default void	removeNickname(org.spongepowered.api.entity.living.player.User user) Removes the nickname for the specified user.
default void	setNickname(org.spongepowered.api.entity.living.player.User user, org.spongepowered.api.text.Text nickname) Sets a user's nickname.
void	setNickname(org.spongepowered.api.entity.living.player.User user, org.spongepowered.api.text.Text nickname, boolean bypassRestrictions) Sets a user's nickname.

Method Detail

getNicknameWithPrefix

Optional<org.spongepowered.api.text.Text> getNicknameWithPrefix(org.spongepowered.api.entity.living.player.User user)

Gets the current nickname for a user with prefix, if it exists.

Parameters:

user - The User to inspect.

Returns:

The nickname in Text form, if it exists.

getNickname

Optional<org.spongepowered.api.text.Text> getNickname(org.spongepowered.api.entity.living.player.User user)

Gets the current nickname for a user, if it exists.

Parameters:

user - The User to inspect.

Returns:

The nickname in Text form, if it exists.

setNickname

default void setNickname(org.spongepowered.api.entity.living.player.User user,
                         @Nullable
                         org.spongepowered.api.text.Text nickname)
                  throws NicknameException

Sets a user's nickname.

Parameters:

user - The User to change the nickname of

nickname - The nickname, or null to remove it.

Throws:

NicknameException - if the nickname could not be set.

setNickname

void setNickname(org.spongepowered.api.entity.living.player.User user,
                 @Nullable
                 org.spongepowered.api.text.Text nickname,
                 boolean bypassRestrictions)
          throws NicknameException

Sets a user's nickname.

Parameters:

user - The User to change the nickname of

nickname - The nickname, or null to remove it.

bypassRestrictions - Whether to bypass the configured restrictions.

Throws:

NicknameException - if the nickname could not be set.

removeNickname

default void removeNickname(org.spongepowered.api.entity.living.player.User user)
                     throws NicknameException

Removes the nickname for the specified user.

Parameters:

user - The nickname to set.

Throws:

NicknameException - if the nickname could not be set.