com.voxelgameslib.voxelgameslib.user

Interface User

All Superinterfaces:

jskills.IPlayer, jskills.ISupportPartialPlay, jskills.ISupportPartialUpdate

All Known Subinterfaces:

ConsoleUser

All Known Implementing Classes:

GameConsoleUser, GamePlayer

public interface User
extends jskills.IPlayer, jskills.ISupportPartialPlay, jskills.ISupportPartialUpdate

A Users represents an abstract player of the game. There are implementations for every server mod available.

Method Summary

Modifier and Type	Method and Description
void	addListeningChannel(java.lang.String channel) Add the user to a new channel
void	applyRolePrefix() Applies the default prefix of the role, if there is one
void	applyRoleSuffix() Applies the default suffix of the role, if there is one
ChatChannel	getActiveChannel() Get the user's active channel
java.util.List<ChatChannel>	getChannels()
net.kyori.text.Component	getDisplayName() returns the display name of the user, consists of prefix, raw display name and suffix.
Locale	getLocale()
org.bukkit.entity.Player	getPlayer()
int	getPoint(GameMode gameMode, java.lang.String pointId) Get the value of a point
java.util.Map<GameMode,java.util.Map<java.lang.String,java.lang.Integer>>	getPoints()
java.util.Map<java.lang.String,java.lang.Integer>	getPoints(GameMode gameMode)
net.kyori.text.Component	getPrefix()
jskills.Rating	getRating(GameMode mode)
java.util.Map<java.lang.String,RatingWrapper>	getRatings()
java.lang.String	getRawDisplayName() returns the display name of the user
Role	getRole()
net.kyori.text.Component	getSuffix()
UserData	getUserData()
java.util.UUID	getUuid()
boolean	hasPermission(Permission perm) checks if that user has the desired permission.
boolean	isLeaving()
void	refreshDisplayName() Causes a new display name to be generated, based on the raw display name, prefix and suffix
void	removeListeningChannel(java.lang.String channel) Remove the user from a channel
void	saveRating(GameMode mode, jskills.Rating rating) Saves a rating for this users.
void	sendMessage(net.kyori.text.Component message) Send a message to this user.
void	setActiveChannel(java.lang.String channel) Set a user's active channel
void	setDisplayName(java.lang.String displayName) sets the raw display name for this user
void	setLeaving(boolean leaving) Deprecated. should only be used internally
void	setLocale(Locale locale) sets the players locale.
void	setPlayer(org.bukkit.entity.Player player) sets the player object for this user
void	setPoint(GameMode gameMode, java.lang.String pointId, int value) Set the value of a point
void	setPrefix(net.kyori.text.Component prefix) changes the prefix for this user.
void	setRole(Role role) changes the role of the user
void	setSuffix(net.kyori.text.Component suffix) changes the suffix for this user.
void	setUserData(UserData userData) Sets the userdata for this user
void	setUuid(java.util.UUID uuid) sets the uuid of this user.

Methods inherited from interface jskills.ISupportPartialPlay

getPartialPlayPercentage

Methods inherited from interface jskills.ISupportPartialUpdate

getPartialUpdatePercentage

Method Detail

getUuid

@Nonnull
java.util.UUID getUuid()

Returns:

a unique identifier for that user.

sendMessage

void sendMessage(@Nonnull
                 net.kyori.text.Component message)

Send a message to this user.

Parameters:

message - the message to be send

hasPermission

boolean hasPermission(@Nonnull
                      Permission perm)

checks if that user has the desired permission.

Parameters:

perm - the permission object to check

Returns:

whether or not the user has that permission

getDisplayName

@Nonnull
net.kyori.text.Component getDisplayName()

returns the display name of the user, consists of prefix, raw display name and suffix.

Returns:

the display name of the user, consists of prefix, raw display name and suffix.

setDisplayName

void setDisplayName(@Nonnull
                    java.lang.String displayName)

sets the raw display name for this user

Parameters:

displayName - the raw display name

getRawDisplayName

@Nonnull
java.lang.String getRawDisplayName()

returns the display name of the user

Returns:

the display name of the user

getPlayer

@Nonnull
org.bukkit.entity.Player getPlayer()

Returns:

the bukkit player

setPlayer

void setPlayer(@Nonnull
               org.bukkit.entity.Player player)

sets the player object for this user

Parameters:

player - the new player object

getLocale

@Nonnull
Locale getLocale()

Returns:

the players currently selected locale

setLocale

void setLocale(@Nonnull
               Locale locale)

sets the players locale. locale doesn't need to be installed, will default to default server locale

Parameters:

locale - the new locale

getRole

@Nonnull
Role getRole()

Returns:

the role of that player

setRole

void setRole(@Nonnull
             Role role)

changes the role of the user

Parameters:

role - the new role

getRating

@Nonnull
jskills.Rating getRating(@Nonnull
                                  GameMode mode)

Parameters:

mode - the mode to get the rating for

Returns:

the rating of this player for gamemode mode. will return default values if not present

saveRating

void saveRating(@Nonnull
                GameMode mode,
                @Nonnull
                jskills.Rating rating)

Saves a rating for this users. will override existing ratings

Parameters:

mode - the mode the rating was achieved in

rating - the new rating

refreshDisplayName

void refreshDisplayName()

Causes a new display name to be generated, based on the raw display name, prefix and suffix

getRatings

@Nonnull
java.util.Map<java.lang.String,RatingWrapper> getRatings()

Returns:

all ratings for this player

getPoints

java.util.Map<GameMode,java.util.Map<java.lang.String,java.lang.Integer>> getPoints()

Returns:

all the points for a user

getPoints

java.util.Map<java.lang.String,java.lang.Integer> getPoints(GameMode gameMode)

Returns:

all the points for a user, for a GameMode

getPoint

int getPoint(GameMode gameMode,
             java.lang.String pointId)

Get the value of a point

Parameters:

gameMode - gamemode the point applies for

pointId - the point name

Returns:

the value

setPoint

void setPoint(GameMode gameMode,
              java.lang.String pointId,
              int value)

Set the value of a point

Parameters:

gameMode - gamemode the point applies for

pointId - the point name

value - the new value to set

getPrefix

@Nonnull
net.kyori.text.Component getPrefix()

Returns:

the prefix for this user

setPrefix

void setPrefix(@Nonnull
               net.kyori.text.Component prefix)

changes the prefix for this user. forces the display name to be regenerated

Parameters:

prefix - the new prefix

getSuffix

@Nonnull
net.kyori.text.Component getSuffix()

Returns:

the suffix for this user

setSuffix

void setSuffix(@Nonnull
               net.kyori.text.Component suffix)

changes the suffix for this user. forces the display name to be regenerated

Parameters:

suffix - the new suffix

setUuid

void setUuid(@Nonnull
             java.util.UUID uuid)

sets the uuid of this user. shouldn't be used, unless you are gamehandler

Parameters:

uuid - the new uuid

getChannels

@Nonnull
java.util.List<ChatChannel> getChannels()

Returns:

Channels a user is listening to

addListeningChannel

void addListeningChannel(@Nonnull
                         java.lang.String channel)

Add the user to a new channel

Parameters:

channel - string identifier for the channel

removeListeningChannel

void removeListeningChannel(@Nonnull
                            java.lang.String channel)

Remove the user from a channel

Parameters:

channel - string identifier for the channel

getActiveChannel

@Nonnull
ChatChannel getActiveChannel()

Get the user's active channel

Returns:

ChatChannel the channel the user is speaking to

setActiveChannel

void setActiveChannel(@Nonnull
                      java.lang.String channel)

Set a user's active channel

Parameters:

channel - string identifier for the channel

applyRolePrefix

void applyRolePrefix()

Applies the default prefix of the role, if there is one

applyRoleSuffix

void applyRoleSuffix()

Applies the default suffix of the role, if there is one

getUserData

UserData getUserData()

Returns:

the userdata for this user

setUserData

void setUserData(UserData userData)

Sets the userdata for this user

Parameters:

userData - the new data to set

isLeaving

boolean isLeaving()

Returns:

if this player is currently attempting to quit the server

setLeaving

@Deprecated
void setLeaving(boolean leaving)

Deprecated. should only be used internally

Marks this player as leaving. Should only be called by vgl

Parameters:

leaving - if the player is leaving