Package de.z0rdak.yawp.core.flag

Class Flag

java.lang.Object

de.z0rdak.yawp.core.flag.Flag

All Implemented Interfaces:

IFlag, Comparable<IFlag>

Direct Known Subclasses:

BooleanFlag, IntFlag, ListFlag

public abstract class Flag
extends Object
implements IFlag

Field Summary

Fields

Modifier and Type	Field	Description
static com.mojang.serialization.Codec<IFlag>	CODEC
protected boolean	doesOverride
protected FlagMessage	msg
protected String	name
protected FlagState	state
protected FlagType	type

Constructor Summary

Constructors

Constructor	Description
Flag(String name, FlagType type)
Flag(String name, FlagType type, boolean override)
Flag(String name, FlagType type, boolean override, FlagState state)
Flag(String name, FlagType type, boolean override, FlagState state, FlagMessage msg)
Flag(String name, FlagType type, boolean override, FlagState state, String msg)

Method Summary

Modifier and Type	Method	Description
int	compareTo(IFlag o)
boolean	doesOverride()	Returns whether the flag does override the same flag defined in child regions.
FlagMessage	getFlagMsg()
String	getName()	Get the unique identifier for the flag.
FlagState	getState()
FlagType	getType()	Returns the flag type of the flag.
boolean	isActive()	Returns whether the flag is active in the region.
void	setFlagMsg(FlagMessage msg)
void	setOverride(boolean override)	Set the override state of the flag.
void	setState(FlagState state)

Methods inherited from class java.lang.Object

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

Field Details

CODEC

public static com.mojang.serialization.Codec<IFlag> CODEC

name

protected String name

type

protected FlagType type

state

protected FlagState state

doesOverride

protected boolean doesOverride

msg

protected FlagMessage msg

Constructor Details

Flag

public Flag(String name,
 FlagType type,
 boolean override)

Flag

public Flag(String name,
 FlagType type,
 boolean override,
 FlagState state)

Flag

public Flag(String name,
 FlagType type)

Flag

public Flag(String name,
 FlagType type,
 boolean override,
 FlagState state,
 String msg)

Flag

public Flag(String name,
 FlagType type,
 boolean override,
 FlagState state,
 FlagMessage msg)

Method Details

getType

public FlagType getType()

Description copied from interface: IFlag

Returns the flag type of the flag. *

Specified by:

getType in interface IFlag

Returns:

the flag type enum value of the flag.

See Also:

• FlagType

getName

public String getName()

Description copied from interface: IFlag

Get the unique identifier for the flag.
The valid flags are currently stored as an enum.
Mod:Name -> ResourceLocation in the future.

Specified by:

getName in interface IFlag

Returns:

unique name for flag.

See Also:

• RegionFlag

isActive

public boolean isActive()

Description copied from interface: IFlag

Returns whether the flag is active in the region.
This means the flag state is either ALLOWED or DENIED.
Disabled flags are not considered for flag checks.

Specified by:

isActive in interface IFlag

Returns:

true if flag is active, false otherwise.

getState

public FlagState getState()

Specified by:

getState in interface IFlag

setState

public void setState(FlagState state)

Specified by:

setState in interface IFlag

doesOverride

public boolean doesOverride()

Description copied from interface: IFlag

Returns whether the flag does override the same flag defined in child regions.

Specified by:

doesOverride in interface IFlag

Returns:

true if the flag overrides the same flag in child regions

setOverride

public void setOverride(boolean override)

Description copied from interface: IFlag

Set the override state of the flag.
When true, it overrides the same flag in child regions.

Specified by:

setOverride in interface IFlag

Parameters:

override - overrides the same flag in child regions if set to true

getFlagMsg

public FlagMessage getFlagMsg()

Specified by:

getFlagMsg in interface IFlag

setFlagMsg

public void setFlagMsg(FlagMessage msg)

Specified by:

setFlagMsg in interface IFlag

compareTo

public int compareTo(IFlag o)

Specified by:

compareTo in interface Comparable<IFlag>