io.github.nucleuspowered.nucleus.api.module.mute

Interface NucleusMuteService

public interface NucleusMuteService

Provides methods for managing mutes within Nucleus

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MUTED_CONTEXT The permission context key that indicates a player is muted.

Method Summary

Modifier and Type	Method and Description
java.util.Optional<Mute>	getPlayerMuteInfo(org.spongepowered.api.entity.living.player.User user) Gets the Mute about a player.
boolean	isMuted(org.spongepowered.api.entity.living.player.User user) Gets whether a User is muted.
boolean	mutePlayer(org.spongepowered.api.entity.living.player.User user, java.lang.String reason, java.time.Duration duration, org.spongepowered.api.event.cause.Cause cause) Mutes a player.
boolean	unmutePlayer(org.spongepowered.api.entity.living.player.User user, org.spongepowered.api.event.cause.Cause cause) Unmutes a player.

Field Detail

MUTED_CONTEXT

static final java.lang.String MUTED_CONTEXT

The permission context key that indicates a player is muted.

The value of this context will always be true if set.

See Also:

Constant Field Values

Method Detail

isMuted

boolean isMuted(org.spongepowered.api.entity.living.player.User user)

Gets whether a User is muted.

Parameters:

user - The User to check.

Returns:

true if so.

getPlayerMuteInfo

java.util.Optional<Mute> getPlayerMuteInfo(org.spongepowered.api.entity.living.player.User user)

Gets the Mute about a player.

Parameters:

user - The User to check

Returns:

The Mute, if applicable.

mutePlayer

boolean mutePlayer(org.spongepowered.api.entity.living.player.User user,
                   java.lang.String reason,
                   @Nullable
                   java.time.Duration duration,
                   org.spongepowered.api.event.cause.Cause cause)

Mutes a player.

Parameters:

user - The User to mute.

reason - The reason to mute them for.

duration - The length of time to mute for, or null for indefinite.

cause - The Cause of the mute. The first User in the cause will be designated as the muter.

Returns:

true if the user was muted, false if the user was already muted.

unmutePlayer

boolean unmutePlayer(org.spongepowered.api.entity.living.player.User user,
                     org.spongepowered.api.event.cause.Cause cause)

Unmutes a player.

Parameters:

user - The User to unmute.

cause - The Cause

Returns:

true if the player was unmuted.