Interface IdeIntegration

All Known Implementing Classes:
EclipseIdeIntegration, IDEAIdeIntegration, IdeIntegration.NoOp

public interface IdeIntegration
Integration with IDEs to improve the development experience.
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final record 
     
  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    addRunConfiguration(org.gradle.api.tasks.TaskProvider<PrepareHytaleServerRunTask> prepareTask, HytaleRunModel model, HytaleDevAgentConfiguration agentConfiguration)
    Adds a run configuration for the given Hytale run model.
    static @NonNull IdeIntegration
    autoDetect(org.gradle.api.Project project)
    Auto-detects the IDE integration for the given project.
    default void
    Called after all details have been configured and the plugin is sure that no changes will be made anymore.
    void
    runTaskOnSync(org.gradle.api.tasks.TaskProvider<? extends org.gradle.api.Task> task)
    Runs the given task whenever the IDE syncs the project.
  • Method Details

    • runTaskOnSync

      void runTaskOnSync(org.gradle.api.tasks.TaskProvider<? extends org.gradle.api.Task> task)
      Runs the given task whenever the IDE syncs the project.
      Parameters:
      task - the task to run on sync
    • finalizeConfiguration

      default void finalizeConfiguration()
      Called after all details have been configured and the plugin is sure that no changes will be made anymore.
    • addRunConfiguration

      default void addRunConfiguration(org.gradle.api.tasks.TaskProvider<PrepareHytaleServerRunTask> prepareTask, HytaleRunModel model, HytaleDevAgentConfiguration agentConfiguration)
      Adds a run configuration for the given Hytale run model.
      Parameters:
      prepareTask - the prepare task for the run configuration
      model - the Hytale run model
      agentConfiguration - the development java agent configuration
    • autoDetect

      static @NonNull IdeIntegration autoDetect(org.gradle.api.Project project)
      Auto-detects the IDE integration for the given project.
      Parameters:
      project - the gradle project
      Returns:
      the detected IDE integration