Package de.z0rdak.yawp.core.region

Class AbstractRegion

java.lang.Object

de.z0rdak.yawp.core.region.AbstractRegion

All Implemented Interfaces:

INbtSerializable<net.minecraft.nbt.CompoundTag>, IProtectedRegion

Direct Known Subclasses:

AbstractMarkableRegion, DimensionalRegion, GlobalRegion

public abstract class AbstractRegion
extends Object
implements IProtectedRegion

An abstract region represents the basic implementation of a IProtectedRegion. This abstraction can be used for markable regions as well as regions without an area (dimensions).

Field Summary

Fields

Modifier and Type	Field	Description
protected net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level>	dimension
protected IProtectedRegion	parent
protected String	parentName

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractRegion(String name, net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dimension, RegionType type)
protected	AbstractRegion(String name, net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dimension, RegionType regionType, net.minecraft.world.entity.player.Player owner)
protected	AbstractRegion(net.minecraft.nbt.CompoundTag nbt)

Method Summary

Modifier and Type	Method	Description
boolean	addChild(IProtectedRegion child)
void	addFlag(IFlag flag)
void	addPlayer(UUID uuid, String playerName, String group)
void	addPlayer(net.minecraft.world.entity.player.Player player, String group)
void	addTeam(String teamName, String group)
void	clearChildren()
boolean	containsFlag(RegionFlag flag)
boolean	containsFlag(String flag)
void	deserializeNBT(net.minecraft.nbt.CompoundTag nbt)
Map<String,IProtectedRegion>	getChildren()
Set<String>	getChildrenNames()
net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level>	getDim()
@Nullable IFlag	getFlag(String flagName)
FlagContainer	getFlagContainer()
Collection<IFlag>	getFlags()
PlayerContainer	getGroup(String group)	Gets the container for the provided group.
String	getName()
IProtectedRegion	getParent()
String	getParentName()
RegionType	getRegionType()
boolean	hasChild(IProtectedRegion maybeChild)
boolean	hasPlayer(UUID playerUuid, String group)
boolean	hasTeam(String teamName, String group)
boolean	isActive()
boolean	isInGroup(net.minecraft.world.entity.player.Player player, String group)
boolean	isMuted()
boolean	permits(net.minecraft.world.entity.player.Player player)	Checks if the player is defined in the regions player list OR whether the player is an operator.
void	removeChild(IProtectedRegion child)	Will always be called by IMarkableRegion to remove child of type IMarkableRegion
void	removeFlag(String flag)
void	removePlayer(UUID playerUuid, String group)
void	removeTeam(String teamName, String group)
void	resetGroups()
net.minecraft.nbt.CompoundTag	serializeNBT()
void	setFlags(FlagContainer flags)
void	setGroups(Map<String,PlayerContainer> groups)
void	setIsActive(boolean isActive)
void	setIsMuted(boolean isMuted)
protected void	setName(String name)
protected boolean	setParent(IProtectedRegion parent)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

dimension

protected net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dimension

parent

protected IProtectedRegion parent

parentName

protected String parentName

Constructor Details

AbstractRegion

protected AbstractRegion(net.minecraft.nbt.CompoundTag nbt)

AbstractRegion

protected AbstractRegion(String name,
 net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dimension,
 RegionType type)

AbstractRegion

protected AbstractRegion(String name,
 net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dimension,
 RegionType regionType,
 net.minecraft.world.entity.player.Player owner)

Method Details

getParentName

public String getParentName()

Specified by:

getParentName in interface IProtectedRegion

getName

public String getName()

Specified by:

getName in interface IProtectedRegion

setName

protected void setName(String name)

setGroups

public void setGroups(Map<String,PlayerContainer> groups)

Specified by:

setGroups in interface IProtectedRegion

getDim

public net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> getDim()

Specified by:

getDim in interface IProtectedRegion

getRegionType

public RegionType getRegionType()

Specified by:

getRegionType in interface IProtectedRegion

addFlag

public void addFlag(IFlag flag)

Specified by:

addFlag in interface IProtectedRegion

removeFlag

public void removeFlag(String flag)

Specified by:

removeFlag in interface IProtectedRegion

containsFlag

public boolean containsFlag(RegionFlag flag)

Specified by:

containsFlag in interface IProtectedRegion

containsFlag

public boolean containsFlag(String flag)

Specified by:

containsFlag in interface IProtectedRegion

getFlags

public Collection<IFlag> getFlags()

Specified by:

getFlags in interface IProtectedRegion

setFlags

public void setFlags(FlagContainer flags)

Specified by:

setFlags in interface IProtectedRegion

getFlagContainer

public FlagContainer getFlagContainer()

Specified by:

getFlagContainer in interface IProtectedRegion

getFlag

@Nullable
public @Nullable IFlag getFlag(String flagName)

Specified by:

getFlag in interface IProtectedRegion

isActive

public boolean isActive()

Specified by:

isActive in interface IProtectedRegion

setIsActive

public void setIsActive(boolean isActive)

Specified by:

setIsActive in interface IProtectedRegion

isMuted

public boolean isMuted()

Specified by:

isMuted in interface IProtectedRegion

setIsMuted

public void setIsMuted(boolean isMuted)

Specified by:

setIsMuted in interface IProtectedRegion

addPlayer

public void addPlayer(net.minecraft.world.entity.player.Player player,
 String group)

Specified by:

addPlayer in interface IProtectedRegion

addPlayer

public void addPlayer(UUID uuid,
 String playerName,
 String group)

Specified by:

addPlayer in interface IProtectedRegion

addTeam

public void addTeam(String teamName,
 String group)

Specified by:

addTeam in interface IProtectedRegion

removeTeam

public void removeTeam(String teamName,
 String group)

Specified by:

removeTeam in interface IProtectedRegion

resetGroups

public void resetGroups()

Specified by:

resetGroups in interface IProtectedRegion

removePlayer

public void removePlayer(UUID playerUuid,
 String group)

Specified by:

removePlayer in interface IProtectedRegion

hasTeam

public boolean hasTeam(String teamName,
 String group)

Specified by:

hasTeam in interface IProtectedRegion

hasPlayer

public boolean hasPlayer(UUID playerUuid,
 String group)

Specified by:

hasPlayer in interface IProtectedRegion

getGroup

public PlayerContainer getGroup(String group)

Gets the container for the provided group. Creates a new one if none is existent.

Specified by:

getGroup in interface IProtectedRegion

permits

public boolean permits(net.minecraft.world.entity.player.Player player)

Checks if the player is defined in the regions player list OR whether the player is an operator. Usually this check is needed when an event occurs, and it needs to be checked whether the player has a specific permission to perform an action in the region.

Specified by:

permits in interface IProtectedRegion

Parameters:

player - to be checked

Returns:

true if player is in region list or is an operator, false otherwise

isInGroup

public boolean isInGroup(net.minecraft.world.entity.player.Player player,
 String group)

Specified by:

isInGroup in interface IProtectedRegion

removeChild

public void removeChild(IProtectedRegion child)

Will always be called by IMarkableRegion to remove child of type IMarkableRegion

Specified by:

removeChild in interface IProtectedRegion

clearChildren

public void clearChildren()

Specified by:

clearChildren in interface IProtectedRegion

getChildren

public Map<String,IProtectedRegion> getChildren()

Specified by:

getChildren in interface IProtectedRegion

getChildrenNames

public Set<String> getChildrenNames()

Specified by:

getChildrenNames in interface IProtectedRegion

hasChild

public boolean hasChild(IProtectedRegion maybeChild)

Specified by:

hasChild in interface IProtectedRegion

addChild

public boolean addChild(IProtectedRegion child)

Specified by:

addChild in interface IProtectedRegion

setParent

protected boolean setParent(IProtectedRegion parent)

getParent

public IProtectedRegion getParent()

Specified by:

getParent in interface IProtectedRegion

serializeNBT

public net.minecraft.nbt.CompoundTag serializeNBT()

Specified by:

serializeNBT in interface INbtSerializable<net.minecraft.nbt.CompoundTag>

deserializeNBT

public void deserializeNBT(net.minecraft.nbt.CompoundTag nbt)

Specified by:

deserializeNBT in interface INbtSerializable<net.minecraft.nbt.CompoundTag>