Interface AnimationModule

All Superinterfaces:

ModuleLocalization, ModuleSimple

public interface AnimationModule
extends ModuleLocalization

Cycles a message through a list of frames so it appears animated.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	AnimationModule.AnimationKey	Identifies one running animation, so each reader sees their own progress.

Method Summary

Modifier and Type	Method	Description
MessageContext	addTag(MessageContext messageContext)	Registers the tag that renders an animation frame.
Message.Format.Animation	config()	The config section this module reads its settings from.
int	increment(UUID sender, UUID receiver, String animation, int maxInterval, int maxIndex)	Advances an animation to its next frame.
Localization.Message.Format.Animation	localization(FPlayer fPlayer)	The localization section for a player, picked from their chosen language.
Permission.Message.Format.Animation	permission()	The permission that gates this module.

Methods inherited from interface ModuleLocalization

cooldown, cooldownOrThrow, permissions, sound, soundOrThrow

Methods inherited from interface ModuleSimple

children, isDisable, name, onDisable, onEnable

Method Details

localization

Localization.Message.Format.Animation localization(FPlayer fPlayer)

Description copied from interface: ModuleLocalization

The localization section for a player, picked from their chosen language.

Specified by:

localization in interface ModuleLocalization

Parameters:

fPlayer - the player the text is for

Returns:

the localization settings

config

Message.Format.Animation config()

Description copied from interface: ModuleSimple

The config section this module reads its settings from.

Specified by:

config in interface ModuleSimple

Returns:

the settings

permission

Permission.Message.Format.Animation permission()

Description copied from interface: ModuleSimple

The permission that gates this module.

Specified by:

permission in interface ModuleSimple

Returns:

the permission

addTag

MessageContext addTag(MessageContext messageContext)

Registers the tag that renders an animation frame.

Parameters:

messageContext - the message being formatted

Returns:

the context with the tag added

increment

int increment(UUID sender,
 UUID receiver,
 String animation,
 int maxInterval,
 int maxIndex)

Advances an animation to its next frame.

Parameters:

sender - who wrote the message

receiver - who reads it

animation - the animation name

maxInterval - how many calls each frame lasts

maxIndex - how many frames there are

Returns:

the frame to draw