Class Emote

java.lang.Object

com.zhamty.emoteschat.api.Emote

public class Emote
extends Object

Represents an emote object.

Constructor Summary

Constructors

Constructor	Description
Emote(String name, String code, String emote, String permission)	Returns a new emote by inputting each property.

Method Summary

Modifier and Type	Method	Description
String	getCode()	Returns current emote code.
String	getEmote()	Returns current emote.
String	getName()	Returns current emote name.
String	getPermission()	Returns the required permission for this emote or null.
boolean	isPermissionRequired()

Methods inherited from class Object

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

Constructor Details

Emote

public Emote(String name,
 String code,
 String emote,
 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 (null if not needed).

Since:

1.2

Method Details

getCode

public String getCode()

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

Returns:

Current emote code.

Since:

1.2

getEmote

public String getEmote()

Returns current emote. Example: "☺"

Returns:

Current emote.

Since:

1.2

getName

public String getName()

Returns current emote name. Example: "happy"

Returns:

Current emote name.

Since:

1.2

getPermission

public String getPermission()

Returns the required permission for this emote or null. Example: "emoteschat.emote.happy"

Returns:

Required permission or null.

Since:

2.0

isPermissionRequired

public boolean isPermissionRequired()

Returns:

`true` if there is a required permission for this emote, `false` otherwise.

Since:

2.0