SocialChatRenderer

Type Parameters:: T - the type of object this renderer operates on (e.g. a player class)

All Known Implementing Classes:: ConsoleChatRenderer, UserChatRenderer

public interface SocialChatRenderer<T>

Renders a SocialRegisteredMessageContext for a specific audience target type T.

Renderers are registered via ChatManager#registerRenderer. The framework maps incoming Audience objects to a target of type T and then calls render(Object, SocialRegisteredMessageContext) to produce a SocialRendererContext.

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static final class

SocialChatRenderer.Builder<T>

Builder for SocialChatRenderer.Registered wrappers around a SocialChatRenderer.

static class

SocialChatRenderer.MapResult<T>

Represents the outcome of mapping an Audience to a renderer target.

static final class

SocialChatRenderer.Registered<T>

A configured and registered wrapper around a SocialChatRenderer.
Method Summary

Modifier and Type

Method

Description

static <T> SocialChatRenderer.Builder<T>

builder(@NotNull SocialChatRenderer<T> renderer)

Creates a new builder for the given renderer implementation.

SocialRendererContext

render(T target, @NotNull SocialRegisteredMessageContext context)

Renders the message for the given target.

Method Details
- builder
  
  static <T> SocialChatRenderer.Builder<T> builder(@NotNull @NotNull SocialChatRenderer<T> renderer)
  
  Creates a new builder for the given renderer implementation.
  
  Type Parameters:
  
  T - the audience target type
  
  Parameters:
  
  renderer - the renderer to wrap
  
  Returns:
  
  a new builder
- render
  
  SocialRendererContext render(@NotNull T target, @NotNull @NotNull SocialRegisteredMessageContext context)
  
  Renders the message for the given target.
  
  Parameters:
  
  target - the resolved audience target
  
  context - the message context to render
  
  Returns:
  
  the renderer output context