Package com.samsthenerd.inline.api.client

Interface InlineClientAPI

public interface InlineClientAPI

The main Inline Client API. Primarly for managing matchers and renderers.

Field Summary

Fields

Modifier and Type	Field	Description
static final InlineClientAPI	INSTANCE

Method Summary

Modifier and Type	Method	Description
void	addMatcher(InlineMatcher matcher)	Register an InlineMatcher
void	addRenderer(InlineRenderer<?> renderer)	Register an InlineRenderer
Set<InlineMatcher>	getAllMatchers()	Get all registered matchers
Set<InlineRenderer<?>>	getAllRenderers()	Get all registered renderers
InlineClientConfig	getConfig()	Get the client config.
MatchContext	getMatched(String input)	Gets a frozen/read-only MatchContext with all currently enabled client-side matchers (see getAllMatchers() and InlineClientConfig.isMatcherEnabled(net.minecraft.util.Identifier)) applied to it.
MatchContext	getMatched(net.minecraft.text.Text input)	Like getMatched(String) but for Text input.
InlineMatcher	getMatcher(net.minecraft.util.Identifier id)	Get an InlineMatcher by its ID
InlineRenderer<?>	getRenderer(net.minecraft.util.Identifier id)	Get an InlineRenderer by its ID

Field Details

INSTANCE

static final InlineClientAPI INSTANCE

Method Details

addRenderer

void addRenderer(InlineRenderer<?> renderer)

Register an InlineRenderer

Parameters:

renderer -

getRenderer

InlineRenderer<?> getRenderer(net.minecraft.util.Identifier id)

Get an InlineRenderer by its ID

Parameters:

id -

Returns:

renderer with the given id, or a InlineErrorRenderer if none could be found.

getAllRenderers

Set<InlineRenderer<?>> getAllRenderers()

Get all registered renderers

Returns:

all registered renderers

addMatcher

void addMatcher(InlineMatcher matcher)

Register an InlineMatcher

Parameters:

matcher -

getMatcher

@Nullable
InlineMatcher getMatcher(net.minecraft.util.Identifier id)

Get an InlineMatcher by its ID

Parameters:

id -

Returns:

matcher with the given id, or null if it does not exist.

getAllMatchers

Set<InlineMatcher> getAllMatchers()

Get all registered matchers

Returns:

all registered matchers

getMatched

MatchContext getMatched(String input)

Gets a frozen/read-only MatchContext with all currently enabled client-side matchers (see getAllMatchers() and InlineClientConfig.isMatcherEnabled(net.minecraft.util.Identifier)) applied to it.

This is backed by a cache for faster matching of repeated values. Since the returned MatchContexts are cached/re-used, it's likely that some of their operations (such as MatchContext.getFinalMatches() or MatchContext.getFinalText()) will have already been ran and cached as well.

Parameters:

input - string to match against

Returns:

read-only MatchContext with all currently enabled client-side matchers applied to it

getMatched

MatchContext getMatched(net.minecraft.text.Text input)

Like getMatched(String) but for Text input.

Parameters:

input - Text to match against

Returns:

read-only MatchContext with all currently enabled client-side matchers applied to it

getConfig

InlineClientConfig getConfig()

Get the client config.

Returns:

inline client config.