com.zhamty.emoteschat.api

Class Emote

java.lang.Object

com.zhamty.emoteschat.api.Emote

public class Emote
extends java.lang.Object

Represents an emote object.

Constructor Summary

Constructors

Constructor and Description
Emote(java.lang.String name, org.bukkit.configuration.file.FileConfiguration config) Returns a new emote by just searching for its name in a config file.
Emote(java.lang.String name, java.lang.String code, java.lang.String emote, java.lang.String permission) Returns a new emote by inputting each property.

Method Summary

Modifier and Type	Method and Description
boolean	canUse(org.bukkit.entity.Player player) Check if a player can use the current emote.
java.lang.String	getCode() Returns current emote code.
java.lang.String	getEmote() Returns current emote.
java.lang.String	getEmoteWithPAPI(org.bukkit.OfflinePlayer player) Returns current emote with parsed placeholders (if PAPI installed).
java.lang.String	getName() Returns current emote name.

Methods inherited from class java.lang.Object

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

Constructor Detail

Emote

public Emote(java.lang.String name,
             org.bukkit.configuration.file.FileConfiguration config)

Returns a new emote by just searching for its name in a config file.

The path to search is "config.emotes.%name%.%property%" where name is the emote name and property is the property to search.

Parameters:

name - Name of the emote.

config - Config file.

Since:

1.2

Emote

public Emote(java.lang.String name,
             java.lang.String code,
             java.lang.String emote,
             java.lang.String permission)

Returns a new emote by inputting each property.

Parameters:

name - Name of the emote.

code - Code of the emote.

emote - Emote (string to replace code).

permission - Permission of the emote (maybe null if not needed).

Since:

1.2

Method Detail

getCode

public java.lang.String getCode()

Returns current emote code. Example: ":happy:"

Returns:

Current emote code.

Since:

1.2

getEmote

public java.lang.String getEmote()

Returns current emote. Example: "☺"

Returns:

Current emote.

Since:

1.2

getEmoteWithPAPI

public java.lang.String getEmoteWithPAPI(org.bukkit.OfflinePlayer player)

Returns current emote with parsed placeholders (if PAPI installed). Example: "☺"

Parameters:

player - The player used to parse placeholders (can be null).

Returns:

Current emote with parsed placeholders (if PAPI installed).

Since:

1.3

getName

public java.lang.String getName()

Returns current emote name. Example: "happy"

Returns:

Current emote name.

Since:

1.2

canUse

public boolean canUse(org.bukkit.entity.Player player)

Check if a player can use the current emote.

Parameters:

player - The player used to check permission.

Returns:

True if the player has permission to use the current emote, or if it doesn't need any permission to be used.

Since:

1.2