Package dev.kitteh.factions.data

Class MemoryFaction.Zone

java.lang.Object

dev.kitteh.factions.data.MemoryFaction.Zone

All Implemented Interfaces:

Faction.Zone

Enclosing class:

MemoryFaction

protected static class MemoryFaction.Zone
extends Object
implements Faction.Zone

Method Summary

Modifier and Type	Method	Description
boolean	canPlayerManage(FPlayer fPlayer)	Gets if the given player can manage this zone, meaning they have the ZONE permission for specifically this zone (if not overridden).
net.kyori.adventure.text.Component	greeting()	Gets the zone's greeting.
void	greeting(@Nullable String greeting)	Sets the zone's greeting in MiniMessage format.
@Nullable String	greetingString()	Gets the zone's raw MiniMessage greeting.
int	id()	Gets the zone's internal ID.
String	name()	Gets the zone's name.
void	name(String name)	Sets the zone's name.
Faction.Permissions	permissions()	Gets the zone's permissions.

Methods inherited from class java.lang.Object

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

Method Details

id

public int id()

Description copied from interface: Faction.Zone

Gets the zone's internal ID.

Specified by:

id in interface Faction.Zone

Returns:

zone id

name

public String name()

Description copied from interface: Faction.Zone

Gets the zone's name.

Specified by:

name in interface Faction.Zone

Returns:

zone name

name

public void name(String name)

Description copied from interface: Faction.Zone

Sets the zone's name.

Specified by:

name in interface Faction.Zone

Parameters:

name - new name

greeting

public net.kyori.adventure.text.Component greeting()

Description copied from interface: Faction.Zone

Gets the zone's greeting.

Specified by:

greeting in interface Faction.Zone

Returns:

greeting

greetingString

public @Nullable String greetingString()

Description copied from interface: Faction.Zone

Gets the zone's raw MiniMessage greeting.

Specified by:

greetingString in interface Faction.Zone

Returns:

MiniMessage greeting or null if the zone uses the main zone's greeting

greeting

public void greeting(@Nullable String greeting)

Description copied from interface: Faction.Zone

Sets the zone's greeting in MiniMessage format. Takes the 'tag' placeholder to inject the faction tag. If null, will default to the main zone's greeting.

Specified by:

greeting in interface Faction.Zone

Parameters:

greeting - new greeting

permissions

public Faction.Permissions permissions()

Description copied from interface: Faction.Zone

Gets the zone's permissions.

Specified by:

permissions in interface Faction.Zone

Returns:

zone permissions

canPlayerManage

public boolean canPlayerManage(FPlayer fPlayer)

Description copied from interface: Faction.Zone

Gets if the given player can manage this zone, meaning they have the ZONE permission for specifically this zone (if not overridden).

Specified by:

canPlayerManage in interface Faction.Zone

Parameters:

fPlayer - player

Returns:

true if can manage