Package io.github.kosmx.emotes.api.events.client

Class ClientEmoteAPI

java.lang.Object

io.github.kosmx.emotes.api.events.client.ClientEmoteAPI

All Implemented Interfaces:

IEmotecraftService

public abstract class ClientEmoteAPI
extends Object
implements IEmotecraftService

Field Summary

Fields

Modifier and Type	Field	Description
protected static final ClientEmoteAPI	INSTANCE

Constructor Summary

Constructors

Constructor	Description
ClientEmoteAPI()

Method Summary

Modifier and Type	Method	Description
static Collection<com.zigythebird.playeranimcore.animation.Animation>	clientEmoteList()	A list of client-side active emotes.
protected abstract Collection<com.zigythebird.playeranimcore.animation.Animation>	clientEmoteListImpl()
boolean	isActive()
static boolean	playEmote(@Nullable com.zigythebird.playeranimcore.animation.Animation animation)	Start playing an emote.
static boolean	playEmote(@Nullable com.zigythebird.playeranimcore.animation.Animation animation, float tick)	Start playing an emote.
protected abstract boolean	playEmoteImpl(com.zigythebird.playeranimcore.animation.Animation animation, float tick)
static boolean	stopEmote()	Stop play an emote.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.kosmx.emotes.api.services.IEmotecraftService

getName, getPriority

Field Details

INSTANCE

protected static final ClientEmoteAPI INSTANCE

Constructor Details

ClientEmoteAPI

public ClientEmoteAPI()

Method Details

stopEmote

public static boolean stopEmote()

Stop play an emote.

playEmote

public static boolean playEmote(@Nullable
 @Nullable com.zigythebird.playeranimcore.animation.Animation animation)

Start playing an emote.

Parameters:

animation - animation, null to stop playing.

Returns:

Can the emote be played: this doesn't check server-side verification

playEmote

public static boolean playEmote(@Nullable
 @Nullable com.zigythebird.playeranimcore.animation.Animation animation,
 float tick)

Start playing an emote.

Parameters:

animation - animation, null to stop playing.

tick - First tick

Returns:

Can the emote be played: this doesn't check server-side verification

clientEmoteList

public static Collection<com.zigythebird.playeranimcore.animation.Animation> clientEmoteList()

A list of client-side active emotes. You can not modify the list.

Returns:

Client-side active emotes

playEmoteImpl

protected abstract boolean playEmoteImpl(com.zigythebird.playeranimcore.animation.Animation animation,
 float tick)

clientEmoteListImpl

protected abstract Collection<com.zigythebird.playeranimcore.animation.Animation> clientEmoteListImpl()

isActive

public boolean isActive()

Specified by:

isActive in interface IEmotecraftService