io.github.nucleuspowered.nucleus.api.service

Interface NucleusInvulnerabilityService

public interface NucleusInvulnerabilityService

A service that handles Nucleus invulnerability

Field Summary

Fields

Modifier and Type	Field and Description
static String	INVULNERABLE_CONTEXT The permission context key that indicates a player is invulnerable.

Method Summary

Modifier and Type	Method and Description
boolean	isInvulnerable(org.spongepowered.api.entity.living.player.User user) Returns whether a player is invulnerable as far as Nucleus is concerned.
void	setInvulnerable(org.spongepowered.api.entity.living.player.User user, boolean invulnerable) Sets whether a player is invulnerable as far as Nucleus is concerned.

Field Detail

INVULNERABLE_CONTEXT

static final String INVULNERABLE_CONTEXT

The permission context key that indicates a player is invulnerable.

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

See Also:

Constant Field Values

Method Detail

isInvulnerable

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

Returns whether a player is invulnerable as far as Nucleus is concerned.

Parameters:

user - The user

Returns:

true if so

setInvulnerable

void setInvulnerable(org.spongepowered.api.entity.living.player.User user,
                     boolean invulnerable)
              throws NucleusException

Sets whether a player is invulnerable as far as Nucleus is concerned.

Parameters:

user - The user

invulnerable - true if so

Throws:

NucleusException - thrown if the Nucleus user data file could not be opened/saved.