Package net.lewmc.essence.utils

Class HomeUtil

java.lang.Object

net.lewmc.essence.utils.HomeUtil

public class HomeUtil
extends Object

/homes command helper utility.

Constructor Summary

Constructors

Constructor	Description
HomeUtil(Essence plugin)	Constructor for the HomeUtil class.

Method Summary

Modifier and Type	Method	Description
boolean	create(String homeName, org.bukkit.entity.Player player, org.bukkit.Location loc)	Creates a new home
int	getHomeCount(org.bukkit.entity.Player player)	Returns the amount of homes that a user has set.
StringBuilder	getHomesList(org.bukkit.entity.Player player)	Gets a list of homes.
int	getTeamHomeCount(org.bukkit.entity.Player player)	Returns the amount of team homes that a user has set.
StringBuilder	getTeamHomesList(String team)	Gets a list of team homes.

Methods inherited from class java.lang.Object

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

Constructor Details

HomeUtil

public HomeUtil(Essence plugin)

Constructor for the HomeUtil class.

Parameters:

plugin - Essence - Reference to main class.

Method Details

getHomesList

public StringBuilder getHomesList(org.bukkit.entity.Player player)

Gets a list of homes.

Parameters:

player - Player - The player whose homes to list.

Returns:

StringBuilder|null - List of homes or null.

getTeamHomesList

public StringBuilder getTeamHomesList(String team)

Gets a list of team homes.

Parameters:

team - String - The team whose homes to list.

Returns:

StringBuilder|null - List of homes or null.

getHomeCount

public int getHomeCount(org.bukkit.entity.Player player)

Returns the amount of homes that a user has set.

Parameters:

player - Player - The player who should be checked.

Returns:

int - The number of homes.

getTeamHomeCount

public int getTeamHomeCount(org.bukkit.entity.Player player)

Returns the amount of team homes that a user has set.

Parameters:

player - Player - The player who should be checked.

Returns:

int - The number of team homes.

create

public boolean create(String homeName,
 org.bukkit.entity.Player player,
 org.bukkit.Location loc)

Creates a new home

Parameters:

homeName - String - The name of the home.

player - Player - The player.

loc - Location - The location for the home.

Returns:

boolean - If the operation was successful.