2014-11-13 07:36:28 +00:00
|
|
|
package com.lenis0012.bukkit.marriage2;
|
|
|
|
|
|
|
|
import java.util.UUID;
|
|
|
|
|
|
|
|
import javax.annotation.Nullable;
|
|
|
|
|
|
|
|
public interface MPlayer {
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get unique User Id of the player.
|
|
|
|
*
|
|
|
|
* @return Player's unique user id.
|
|
|
|
*/
|
|
|
|
UUID getUniqueId();
|
|
|
|
|
2014-11-13 09:54:23 +00:00
|
|
|
/**
|
|
|
|
* Request marriage with this player by another.
|
|
|
|
*
|
|
|
|
* @param from Player who requested the marriage.
|
|
|
|
*/
|
|
|
|
void requestMarriage(UUID from);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Check if marriage with this player is requested by another.
|
|
|
|
*
|
|
|
|
* @param from Marriage requester.
|
|
|
|
* @return Whether or not marriage is requested by the player.
|
|
|
|
*/
|
|
|
|
boolean isMarriageRequested(UUID from);
|
|
|
|
|
2014-11-13 07:36:28 +00:00
|
|
|
/**
|
|
|
|
* Get the player's gender.
|
|
|
|
*
|
|
|
|
* @return Player's gender.
|
|
|
|
*/
|
|
|
|
Gender getGender();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Set the player's gender.
|
|
|
|
*
|
|
|
|
* @param gender Player's gender.
|
|
|
|
*/
|
|
|
|
void setGender(Gender gender);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get current marriage of the player.
|
|
|
|
*
|
|
|
|
* @return Player's marriage, NULL if not married.
|
|
|
|
*/
|
|
|
|
@Nullable
|
|
|
|
MData getMarriage();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Check if the player is married.
|
|
|
|
*
|
|
|
|
* @return True if married, false otherwise.
|
|
|
|
*/
|
|
|
|
boolean isMarried();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Check if the player is in marry-chat mode.
|
|
|
|
*
|
|
|
|
* @return True if in chat-mode, false otherwise.
|
|
|
|
*/
|
|
|
|
boolean isInChat();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Set if the player is in marry chat-mode.
|
|
|
|
*
|
|
|
|
* @param inChat Whether or not the player is in marry chat-mode.
|
|
|
|
*/
|
|
|
|
void setInChat(boolean inChat);
|
2014-12-14 02:36:33 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the current player's partner
|
|
|
|
*
|
|
|
|
* @return Current partner of the player
|
|
|
|
*/
|
|
|
|
MPlayer getPartner();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Divorce with the current player's partner
|
|
|
|
*/
|
|
|
|
void divorce();
|
2014-11-13 07:36:28 +00:00
|
|
|
}
|