Package org.spongepowered.api.adventure
Class SpongeComponents
java.lang.Object
org.spongepowered.api.adventure.SpongeComponents
Additional SpongeAPI-specific methods for working with
Component
s and related.-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ClickEvent
executeCallback
(Consumer<CommandCause> callback) Creates a newClickEvent
that will execute the given runnable on the server when clicked.static ComponentFlattener
Get aComponentFlattener
with access to server-specific informationstatic Component
resolve
(Component component, CommandCause senderContext, Audience viewer, DefaultedRegistryReference<ResolveOperation> resolver, DefaultedRegistryReference<ResolveOperation>... otherResolvers) Render a component for viewer-specific context.static Component
resolve
(Component component, CommandCause senderContext, DefaultedRegistryReference<ResolveOperation> resolver, DefaultedRegistryReference<ResolveOperation>... otherResolvers) Render a component for sender-specific context.
-
Method Details
-
executeCallback
Creates a newClickEvent
that will execute the given runnable on the server when clicked. The callback will expire after some amount of time (not particularly instantly, but not like overnight really either).- Parameters:
callback
- The callback to execute- Returns:
- The created click event instance
-
resolve
@SafeVarargs public static Component resolve(Component component, CommandCause senderContext, Audience viewer, DefaultedRegistryReference<ResolveOperation> resolver, DefaultedRegistryReference<ResolveOperation>... otherResolvers) Render a component for viewer-specific context.The
viewer
must refer to a single viewer, not multiple viewers, in order to gather any useful context. If an audience cannot be resolved to a single viewer, this method will behave as if no viewer had been defined.- Parameters:
component
- the component to rendersenderContext
- the context to render inviewer
- the viewer to render forresolver
- the first resolverotherResolvers
- any other resolvers to apply- Returns:
- the rendered component
-
resolve
@SafeVarargs public static Component resolve(Component component, CommandCause senderContext, DefaultedRegistryReference<ResolveOperation> resolver, DefaultedRegistryReference<ResolveOperation>... otherResolvers) Render a component for sender-specific context.Viewer-specific information will not be available
- Parameters:
component
- the component to rendersenderContext
- the context to render inresolver
- the first resolverotherResolvers
- any other resolvers to apply- Returns:
- the rendered component
-
flattener
Get aComponentFlattener
with access to server-specific informationThis flattener can be used for custom formats where translatable strings should be localized server-side.
- Returns:
- The flattener
-