Interface StreamModule

All Superinterfaces:

org.incendo.cloud.execution.CommandExecutionHandler<FPlayer>, ModuleCommand, ModuleLocalization, ModuleSimple

public interface StreamModule
extends ModuleCommand

The /stream command, which announces that a player has gone live.

Nested Class Summary

Nested classes/interfaces inherited from interface org.incendo.cloud.execution.CommandExecutionHandler

org.incendo.cloud.execution.CommandExecutionHandler.FutureCommandExecutionHandler<C>

Method Summary

Modifier and Type	Method	Description
MessageContext	addTag(MessageContext messageContext)	Registers the tag that renders a player's stream marker.
Command.Stream	config()	The config section for this command, which also holds its aliases.
Localization.Command.Stream	localization(FPlayer fPlayer)	The localization section for a player, picked from their chosen language.
Permission.Command.Stream	permission()	The permission that gates this module.
void	setStreamPrefix(FPlayer fPlayer, String prefix)	Sets the marker shown next to a streaming player's name.
net.kyori.adventure.text.minimessage.tag.resolver.TagResolver	urlTag(FEntity sender, FPlayer receiver, String urls)	Renders the stream links as clickable text.

Methods inherited from interface org.incendo.cloud.execution.CommandExecutionHandler

executeFuture

Methods inherited from interface ModuleCommand

execute, execute

Methods inherited from interface ModuleLocalization

cooldown, cooldownOrThrow, permissions, sound, soundOrThrow

Methods inherited from interface ModuleSimple

children, isDisable, name, onDisable, onEnable

Method Details

setStreamPrefix

void setStreamPrefix(FPlayer fPlayer,
 String prefix)

Sets the marker shown next to a streaming player's name.

Parameters:

fPlayer - the player

prefix - the marker, or an empty string to clear it

config

Command.Stream config()

Description copied from interface: ModuleCommand

The config section for this command, which also holds its aliases.

Specified by:

config in interface ModuleCommand

Specified by:

config in interface ModuleSimple

Returns:

the command settings

permission

Permission.Command.Stream permission()

Description copied from interface: ModuleSimple

The permission that gates this module.

Specified by:

permission in interface ModuleSimple

Returns:

the permission

localization

Localization.Command.Stream 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

addTag

MessageContext addTag(MessageContext messageContext)

Registers the tag that renders a player's stream marker.

Parameters:

messageContext - the message being formatted

Returns:

the context with the tag added

urlTag

net.kyori.adventure.text.minimessage.tag.resolver.TagResolver urlTag(FEntity sender,
 FPlayer receiver,
 String urls)

Renders the stream links as clickable text.

Parameters:

sender - the streaming player

receiver - the reader

urls - the links

Returns:

the resolver for the links tag