Package ovh.mythmc.social.api.chat.renderer

Class SocialChatRenderer.Registered<T>

java.lang.Object

ovh.mythmc.social.api.chat.renderer.SocialChatRenderer.Registered<T>

Type Parameters:

T - the audience target type

Enclosing interface:

SocialChatRenderer<T>

public static final class SocialChatRenderer.Registered<T>
extends Object

A configured and registered wrapper around a SocialChatRenderer.

Constructor Summary

Constructors

Constructor	Description
Registered()

Method Summary

Modifier and Type	Method	Description
SocialChatRenderer.MapResult<T>	mapFromAudience(@NotNull Audience audience)	Attempts to map the given audience to a target of type T.
SocialRendererContext	render(@NotNull Audience audience, @NotNull SocialRegisteredMessageContext context)	Renders the message for the audience, first mapping it to a target.
SocialRendererContext	render(T target, @NotNull SocialRegisteredMessageContext context)	Renders the message directly for the given target.

Methods inherited from class java.lang.Object

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

Constructor Details

Registered

public Registered()

Method Details

mapFromAudience

public SocialChatRenderer.MapResult<T> mapFromAudience(@NotNull
 @NotNull Audience audience)

Attempts to map the given audience to a target of type T.

Parameters:

audience - the audience to map

Returns:

a SocialChatRenderer.MapResult that is either a success, ignore, or failure

render

public SocialRendererContext render(@NotNull
 @NotNull Audience audience,
 @NotNull
 @NotNull SocialRegisteredMessageContext context)

Renders the message for the audience, first mapping it to a target. Returns null if mapping fails or should be skipped.

Parameters:

audience - the audience to render for

context - the message context

Returns:

the render result, or null

render

public SocialRendererContext render(@NotNull
 T target,
 @NotNull
 @NotNull SocialRegisteredMessageContext context)

Renders the message directly for the given target. Returns null if the renderIf predicate is not satisfied.

Parameters:

target - the resolved target

context - the message context

Returns:

the render result, or null