• Home
• net.whimxiqal.journey
• core-api
• 1.2
• source code
• NavigatorDetailsBuilder.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

net.whimxiqal.journey.navigation.NavigatorDetailsBuilder Maven / Gradle / Ivy

package net.whimxiqal.journey.navigation;

import net.kyori.adventure.text.Component;
import net.whimxiqal.journey.Builder;
import net.whimxiqal.journey.navigation.option.NavigatorOption;

/**
 * A builder for {@link NavigatorDetails}.
 *
 * @param  the derived type of builder, for more helpful chaining
 */
public interface NavigatorDetailsBuilder>
    extends Builder {

  /**
   * Set a new option value.
   *
   * @param key   the option id
   * @param value the option value
   * @return the builder, for chaining
   */
  B setOption(String key, Object value);

  /**
   * Set a new option value using the option and type safety.
   *
   * @param option the option
   * @param value  the value
   * @param     the type of the option's value
   * @return the builder, for chaining
   */
   B setOption(NavigatorOption option, T value);

  /**
   * Set the completion message, which will be sent to the agent upon completion of the navigator.
   *
   * @param message the message
   * @return the builder, for chaining
   */
  B completionMessage(Component message);

  /**
   * Set the completion title, which will be sent to the agent upon completion of the navigator.
   *
   * @param title the title
   * @return the builder, for chaining
   */
  B completionTitle(Component title);

  /**
   * Set the completion subtitle, which will be sent to the agent upon completion of the navigator.
   *
   * @param subtitle the subtitle
   * @return the builder, for chaining
   */
  B completionSubtitle(Component subtitle);

}