Package de.z0rdak.yawp.core.flag

Class FlagMessage

java.lang.Object

de.z0rdak.yawp.core.flag.FlagMessage

All Implemented Interfaces:

INbtSerializable<net.minecraft.nbt.CompoundTag>

public class FlagMessage
extends Object
implements INbtSerializable<net.minecraft.nbt.CompoundTag>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	FlagMessage.FlagCorrelation	A correlation of a region and a flag.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_MSG
static FlagMessage	DEFAULT_FLAG_MSG
static final String	DIM_TEMPLATE
static final String	FLAG_TEMPLATE
static final Set<String>	MSG_TOKEN
static final String	PLAYER_TEMPLATE
static final String	POS_TEMPLATE
static final String	REGION_TEMPLATE

Constructor Summary

Constructors

Constructor	Description
FlagMessage(String msg)
FlagMessage(String msg, boolean muted)
FlagMessage(net.minecraft.nbt.CompoundTag msgNbt)

Method Summary

Modifier and Type	Method	Description
static net.minecraft.network.chat.MutableComponent	buildFrom(FlagCheckResult result, Map<String,String> substitutes)	Builds a flag message from the given flag check result and substitutes.
static Map<String,String>	defaultSubstitutes(RegionFlag flag, IProtectedRegion region, net.minecraft.core.BlockPos pos, @Nullable net.minecraft.world.entity.player.Player player)	Returns a map with default substitutes for the given flag and region.
static Map<String,String>	defaultSubstitutesFor(FlagCheckResult result)	Returns a map with default substitutes for the given flag check result.
void	deserializeNBT(net.minecraft.nbt.CompoundTag nbt)
boolean	isDefault()
boolean	isMuted()
String	msg()
void	mute(boolean mute)
void	reset()
net.minecraft.nbt.CompoundTag	serializeNBT()
void	setMsg(String msg)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

FLAG_TEMPLATE

public static final String FLAG_TEMPLATE

See Also:

• Constant Field Values

POS_TEMPLATE

public static final String POS_TEMPLATE

See Also:

• Constant Field Values

REGION_TEMPLATE

public static final String REGION_TEMPLATE

See Also:

• Constant Field Values

DIM_TEMPLATE

public static final String DIM_TEMPLATE

See Also:

• Constant Field Values

PLAYER_TEMPLATE

public static final String PLAYER_TEMPLATE

See Also:

• Constant Field Values

CONFIG_MSG

public static final String CONFIG_MSG

See Also:

• Constant Field Values

MSG_TOKEN

public static final Set<String> MSG_TOKEN

DEFAULT_FLAG_MSG

public static FlagMessage DEFAULT_FLAG_MSG

Constructor Details

FlagMessage

public FlagMessage(String msg)

FlagMessage

public FlagMessage(String msg,
 boolean muted)

FlagMessage

public FlagMessage(net.minecraft.nbt.CompoundTag msgNbt)

Method Details

defaultSubstitutes

public static Map<String,String> defaultSubstitutes(RegionFlag flag,
 IProtectedRegion region,
 net.minecraft.core.BlockPos pos,
 @Nullable
 @Nullable net.minecraft.world.entity.player.Player player)

Returns a map with default substitutes for the given flag and region.

Parameters:

flag - the flag to get the substitutes for

region - the region to get the substitutes for

pos - the position to get the substitutes for

player - the player to get the substitutes for

Returns:

a map with default substitutes for the given flag and region

defaultSubstitutesFor

public static Map<String,String> defaultSubstitutesFor(FlagCheckResult result)

Returns a map with default substitutes for the given flag check result.
The substitutes are built from the flag, responsible region, position and player in the result.
The substitutes are then returned as a map.

Parameters:

result - the flag check result to get the default substitutes for

Returns:

a map with default substitutes for the given flag check result

buildFrom

public static net.minecraft.network.chat.MutableComponent buildFrom(FlagCheckResult result,
 Map<String,String> substitutes)

Builds a flag message from the given flag check result and substitutes.
The flag message is built from the flag message template of the flag in the result.
The matches in the flag message template are replaced with the substitutes.
The flag message is then returned as a MutableComponent.

Parameters:

result - the flag check result to build the message for

substitutes - the substitutes to replace the matches in the flag message template with

Returns:

the flag message for the given flag check result and substitutes

isMuted

public boolean isMuted()

mute

public void mute(boolean mute)

reset

public void reset()

isDefault

public boolean isDefault()

msg

public String msg()

setMsg

public void setMsg(String msg)

toString

public String toString()

Overrides:

toString in class Object

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>