Class SpongeComponents


  • public final class SpongeComponents
    extends java.lang.Object
    Additional SpongeAPI-specific methods for working with Components and related.
    • Method Detail

      • executeCallback

        public static ClickEvent executeCallback​(java.util.function.Consumer<CommandCause> callback)
        Creates a new ClickEvent 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 render
        senderContext - the context to render in
        viewer - the viewer to render for
        resolver - the first resolver
        otherResolvers - any other resolvers to apply
        Returns:
        the rendered component
      • flattener

        public static ComponentFlattener flattener()
        Get a ComponentFlattener with access to server-specific information

        This flattener can be used for custom formats where translatable strings should be localized server-side.

        Returns:
        The flattener