io.github.nucleuspowered.nucleus.api.service

Interface NucleusFreezePlayerService

public interface NucleusFreezePlayerService

A service that controls whether a player is frozen.

Requires the freeze-player module.

Method Summary

Modifier and Type	Method and Description
default boolean	isFrozen(User player) Gets whether a player is frozen.
boolean	isFrozen(UUID uuid) Gets whether a player is frozen.
default void	setFrozen(User player, boolean freeze) Sets whether a player is frozen.
void	setFrozen(UUID uuid, boolean freeze) Sets whether a player is frozen.

Method Detail

isFrozen

boolean isFrozen(UUID uuid)

Gets whether a player is frozen.

Parameters:

uuid - The UUID of the player.

Returns:

Whether they are frozen

isFrozen

default boolean isFrozen(User player)

Gets whether a player is frozen.

Parameters:

player - The player.

Returns:

Whether they are frozen

setFrozen

void setFrozen(UUID uuid,
               boolean freeze)

Sets whether a player is frozen.

Parameters:

uuid - The UUID of the player

freeze - Whether to freeze them

setFrozen

default void setFrozen(User player,
                       boolean freeze)

Sets whether a player is frozen.

Parameters:

player - The player

freeze - Whether to freeze them