Interface BubbleModule

All Superinterfaces:

ModuleSimple

public interface BubbleModule
extends ModuleSimple

Shows chat messages as floating text above the speaker's head.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	BubbleModule.Billboard	How a bubble turns to face the viewer.

Method Summary

Modifier and Type	Method	Description
void	add(@NonNull FPlayer fPlayer, @NonNull String rawString, @NonNull String inputString, Set<FPlayer> receivers)	Shows a bubble, keeping the raw text separate from the formatted one so the length limit is measured on what the player actually typed.
void	add(@NonNull FPlayer fPlayer, @NonNull String inputString, Set<FPlayer> receivers)	Shows a bubble above a player's head.
Message.Bubble	config()	The config section this module reads its settings from.
Permission.Message.Bubble	permission()	The permission that gates this module.

Methods inherited from interface ModuleSimple

children, isDisable, name, onDisable, onEnable, permissions

Method Details

config

Message.Bubble 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.Bubble permission()

Description copied from interface: ModuleSimple

The permission that gates this module.

Specified by:

permission in interface ModuleSimple

Returns:

the permission

add

void add(@NonNull FPlayer fPlayer,
 @NonNull String inputString,
 Set<FPlayer> receivers)

Shows a bubble above a player's head.

Parameters:

fPlayer - the speaker

inputString - the text

receivers - who should see it

add

void add(@NonNull FPlayer fPlayer,
 @NonNull String rawString,
 @NonNull String inputString,
 Set<FPlayer> receivers)

Shows a bubble, keeping the raw text separate from the formatted one so the length limit is measured on what the player actually typed.

Parameters:

fPlayer - the speaker

rawString - the text as typed

inputString - the formatted text

receivers - who should see it