Index (hytale-server-runner 1.2.0 API)

A B D E F G H I J L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

apply(Project) - Method in class wtf.ranked.hytale.server.runner.HytaleServerRunnerPlugin
AUTHENTICATED - Enum constant in enum class wtf.ranked.hytale.server.runner.extension.OnlineMode

B

builder() - Method in class wtf.ranked.hytale.server.runner.resource.ResourceProvider: Creates a new builder for a resource acquisition request.
Builder() - Constructor for class wtf.ranked.hytale.server.runner.resource.ResourceProvider.ResourceRequest.Builder

D

DefaultRunningTask - Class in wtf.ranked.hytale.server.runner.task: Base class for tasks running entirely within the Gradle process.
DefaultRunningTask() - Constructor for class wtf.ranked.hytale.server.runner.task.DefaultRunningTask
deleteDirectory(File) - Method in class wtf.ranked.hytale.server.runner.util.FileUtil: Recursively deletes a directory and all of its contents.
deleteFile(File) - Method in class wtf.ranked.hytale.server.runner.util.FileUtil
deleteFile(File, String) - Method in class wtf.ranked.hytale.server.runner.util.FileUtil
deleteFiles(File, String...) - Method in class wtf.ranked.hytale.server.runner.util.FileUtil: Deletes multiple files within a directory by name.
dependsOn(String...) - Method in class wtf.ranked.hytale.server.runner.HytalePluginExtension: Adds the name of the prerequisite build task using a string identifier.
destinationFile() - Method in record class wtf.ranked.hytale.server.runner.resource.ResourceProvider.ResourceRequest: Returns the value of the destinationFile record component.
destinationFile(File) - Method in class wtf.ranked.hytale.server.runner.resource.ResourceProvider.ResourceRequest.Builder
download(M) - Method in class wtf.ranked.hytale.server.runner.mod.strategy.ModDownloaderStrategy: Implementation-specific logic to acquire the mod file.
download(UrlMod) - Method in class wtf.ranked.hytale.server.runner.mod.strategy.UrlDownloaderStrategy: Executes the HTTP download using the metadata provided in the UrlMod.
downloadAllMods(List) - Method in class wtf.ranked.hytale.server.runner.mod.ModDownloader: Iterates through a list of mods and triggers the download process for each.
downloadMod(M) - Method in class wtf.ranked.hytale.server.runner.mod.strategy.ModDownloaderStrategy: Orchestrates the installation of a mod.
DownloadModStep - Class in wtf.ranked.hytale.server.runner.step.impl: Step that resolves and downloads all configured mods.
DownloadModStep() - Constructor for class wtf.ranked.hytale.server.runner.step.impl.DownloadModStep
DownloadServerAssetStep - Class in wtf.ranked.hytale.server.runner.step.impl: Step that executes the native Hytale downloader binary.
DownloadServerAssetStep() - Constructor for class wtf.ranked.hytale.server.runner.step.impl.DownloadServerAssetStep

E

environment(String, Object) - Method in class wtf.ranked.hytale.server.runner.HytalePluginExtension: Adds an environment variable to the server process.
equals(Object) - Method in record class wtf.ranked.hytale.server.runner.resource.ResourceProvider.ResourceRequest: Indicates whether some other object is "equal to" this one.
exec() - Method in class wtf.ranked.hytale.server.runner.task.JavaExecRunningTask: Entry point for Gradle execution.
execute() - Method in class wtf.ranked.hytale.server.runner.mod.strategy.ModDownloaderStrategy

F

fileName - Variable in class wtf.ranked.hytale.server.runner.mod.Mod: The target name for the mod file on the local disk.
FileUtil - Class in wtf.ranked.hytale.server.runner.util: Utility class for file and directory operations.
FileUtil() - Constructor for class wtf.ranked.hytale.server.runner.util.FileUtil

G

getAssets() - Method in class wtf.ranked.hytale.server.runner.HytalePluginExtension: File property for the server assets archive.
getDependsOn() - Method in class wtf.ranked.hytale.server.runner.HytalePluginExtension: The names of the tasks that must be completed before the server runs.
getDownloadTimeout() - Method in class wtf.ranked.hytale.server.runner.HytalePluginExtension: The maximum amount of time allowed for download operations.
getEnvironment() - Method in class wtf.ranked.hytale.server.runner.HytalePluginExtension: Map of environment variables passed to the server process.
getExecOperations() - Method in class wtf.ranked.hytale.server.runner.step.impl.DownloadServerAssetStep
getHytalePluginExtension() - Method in interface wtf.ranked.hytale.server.runner.extension.HytaleExtensionParameters: Provides access to the global Hytale boot configuration.
getHytalePluginExtension() - Method in interface wtf.ranked.hytale.server.runner.mod.strategy.ModDownloaderStrategy.ModDownloaderExtension: The Hytale boot configuration extension.
getHytalePluginExtension() - Method in class wtf.ranked.hytale.server.runner.task.DefaultRunningTask: Provides access to the Hytale configuration settings.
getHytalePluginExtension() - Method in interface wtf.ranked.hytale.server.runner.task.GradleRunningTask: Provides access to the Hytale configuration settings.
getHytalePluginExtension() - Method in class wtf.ranked.hytale.server.runner.task.JavaExecRunningTask: Provides access to the Hytale configuration settings.
getHytalePluginExtension() - Method in class wtf.ranked.hytale.server.runner.task.type.GlobalRunningTask
getJvmArgs() - Method in class wtf.ranked.hytale.server.runner.HytalePluginExtension: List of JVM arguments to pass to the server process.
getMod() - Method in interface wtf.ranked.hytale.server.runner.mod.strategy.ModDownloaderStrategy.ModDownloaderExtension: The mod instance to be downloaded.
getModDirectory() - Method in class wtf.ranked.hytale.server.runner.HytalePluginExtension: Directory where server mods will be installed.
getModExtension() - Method in class wtf.ranked.hytale.server.runner.HytalePluginExtension: Accesses the nested configuration for server mods.
getMods() - Method in class wtf.ranked.hytale.server.runner.mod.ModExtension: Retrieves the list of all configured mods.
getName(Class) - Static method in class wtf.ranked.hytale.server.runner.step.TaskStepRegistry
getPlatformFile() - Static method in class wtf.ranked.hytale.server.runner.platform.PlatformFileProvider: Detects the current operating system and returns its corresponding platform file.
getResourceProvider() - Method in class wtf.ranked.hytale.server.runner.mod.strategy.UrlDownloaderStrategy
getResourceProvider() - Method in class wtf.ranked.hytale.server.runner.step.impl.PrepareDownloaderStep
getRunDirectory() - Method in class wtf.ranked.hytale.server.runner.HytalePluginExtension: Root directory for server execution.
getServerAddress() - Method in class wtf.ranked.hytale.server.runner.HytalePluginExtension: The InetSocketAddress to which the server will be bound.
getServerDirectory() - Method in class wtf.ranked.hytale.server.runner.HytalePluginExtension: Directory where the Hytale server files are located.
getServerDownloadUri() - Method in class wtf.ranked.hytale.server.runner.HytalePluginExtension: URI used to download the server software.
getServerJar() - Method in class wtf.ranked.hytale.server.runner.HytalePluginExtension: The primary executable JAR file for the server.
getServerJarMainClass() - Method in class wtf.ranked.hytale.server.runner.HytalePluginExtension: The entry point class name for the Hytale server.
getServerOnlineMode() - Method in class wtf.ranked.hytale.server.runner.HytalePluginExtension: Property which allows to change the server online mode.
getWorkerExecutor() - Method in class wtf.ranked.hytale.server.runner.step.impl.DownloadModStep
github(String, String, String, String) - Method in class wtf.ranked.hytale.server.runner.mod.ModExtension: Adds a mod to the configuration from a GitHub Release asset.
GithubMod - Class in wtf.ranked.hytale.server.runner.mod.type: A specialized mod implementation for files hosted on GitHub Releases.
GLOBAL_TASK_GROUP - Static variable in class wtf.ranked.hytale.server.runner.HytaleServerRunnerPlugin
GlobalRunningTask - Class in wtf.ranked.hytale.server.runner.task.type: Orchestrator task that provides a high-level entry point for users.
GlobalRunningTask() - Constructor for class wtf.ranked.hytale.server.runner.task.type.GlobalRunningTask: Initializes the task and assigns it to the plugin's task group.
GlobalTaskRegistrar - Class in wtf.ranked.hytale.server.runner.registrar.task: Handles the registration and lifecycle setup of Global tasks.
GlobalTaskRegistrar(Project, HytalePluginExtension) - Constructor for class wtf.ranked.hytale.server.runner.registrar.task.GlobalTaskRegistrar
GradleRunningTask - Interface in wtf.ranked.hytale.server.runner.task: Root interface for all Hytale boot-related tasks.
GradleServiceRegistrar - Class in wtf.ranked.hytale.server.runner.registrar: Registrar responsible for configuring and providing Gradle Shared Build Services.
GradleServiceRegistrar(Project) - Constructor for class wtf.ranked.hytale.server.runner.registrar.GradleServiceRegistrar
GROUP - Static variable in class wtf.ranked.hytale.server.runner.HytaleServerRunnerPlugin

H

hashCode() - Method in record class wtf.ranked.hytale.server.runner.resource.ResourceProvider.ResourceRequest: Returns a hash code value for this object.
HttpResourceProvider - Class in wtf.ranked.hytale.server.runner.resource: HTTP implementation of the ResourceProvider.
HttpResourceProvider() - Constructor for class wtf.ranked.hytale.server.runner.resource.HttpResourceProvider
HytaleExtensionParameters - Interface in wtf.ranked.hytale.server.runner.extension: Common parameter definition for Hytale-related Build Services.
HytalePluginExtension - Class in wtf.ranked.hytale.server.runner: Main configuration extension for the Hytale Boot plugin.
HytalePluginExtension(ProjectLayout) - Constructor for class wtf.ranked.hytale.server.runner.HytalePluginExtension: Constructs a new HytalePluginExtension and sets default conventions.
HytaleServerRunnerPlugin - Class in wtf.ranked.hytale.server.runner: Gradle plugin for booting a Hytale server.
HytaleServerRunnerPlugin() - Constructor for class wtf.ranked.hytale.server.runner.HytaleServerRunnerPlugin

I

INTERNAL_TASK_GROUP - Static variable in class wtf.ranked.hytale.server.runner.HytaleServerRunnerPlugin
InternalDefaultRunningTask() - Constructor for class wtf.ranked.hytale.server.runner.task.type.InternalRunningTask.InternalDefaultRunningTask
InternalExecRunningTask() - Constructor for class wtf.ranked.hytale.server.runner.task.type.InternalRunningTask.InternalExecRunningTask
InternalRunningTask - Class in wtf.ranked.hytale.server.runner.task.type: Container for atomic worker tasks used within the boot lifecycle.
InternalRunningTask() - Constructor for class wtf.ranked.hytale.server.runner.task.type.InternalRunningTask
InternalRunningTask.InternalDefaultRunningTask - Class in wtf.ranked.hytale.server.runner.task.type: An internal worker focused on general build-environment logic.
InternalRunningTask.InternalExecRunningTask - Class in wtf.ranked.hytale.server.runner.task.type: An internal worker focused on starting a Java-based process.
isModInstalled(String) - Method in class wtf.ranked.hytale.server.runner.mod.strategy.ModDownloaderStrategy: Checks if a mod is already present in the local mods directory.

J

JavaExecRunningTask - Class in wtf.ranked.hytale.server.runner.task: Base class for tasks that launch the Hytale server process.
JavaExecRunningTask() - Constructor for class wtf.ranked.hytale.server.runner.task.JavaExecRunningTask

L

LaunchServerStep - Class in wtf.ranked.hytale.server.runner.step.impl: The terminal step that starts the Hytale server process.
LaunchServerStep() - Constructor for class wtf.ranked.hytale.server.runner.step.impl.LaunchServerStep
LaunchServerTask - Class in wtf.ranked.hytale.server.runner.task.global: The primary execution task for booting a Hytale server.
LaunchServerTask() - Constructor for class wtf.ranked.hytale.server.runner.task.global.LaunchServerTask
LINUX - Enum constant in enum class wtf.ranked.hytale.server.runner.platform.PlatformFile

M

Mod - Class in wtf.ranked.hytale.server.runner.mod: Abstract base for all mod definitions.
Mod() - Constructor for class wtf.ranked.hytale.server.runner.mod.Mod
ModDownloader - Class in wtf.ranked.hytale.server.runner.mod: Execution context for processing mod downloads.
ModDownloader() - Constructor for class wtf.ranked.hytale.server.runner.mod.ModDownloader
ModDownloaderStrategy<M> - Class in wtf.ranked.hytale.server.runner.mod.strategy: Base strategy for downloading and installing Hytale mods.
ModDownloaderStrategy() - Constructor for class wtf.ranked.hytale.server.runner.mod.strategy.ModDownloaderStrategy
ModDownloaderStrategy.ModDownloaderExtension - Interface in wtf.ranked.hytale.server.runner.mod.strategy: Parameters for the mod downloader work action.
ModExtension - Class in wtf.ranked.hytale.server.runner.mod: Configuration extension for managing Hytale mods.
ModExtension() - Constructor for class wtf.ranked.hytale.server.runner.mod.ModExtension
mods(Action) - Method in class wtf.ranked.hytale.server.runner.HytalePluginExtension: Configures the server mods via an action.

N

normalizeFileName(String) - Static method in class wtf.ranked.hytale.server.runner.mod.Mod: Ensures the provided file name has a consistent .jar extension.

O

of(String, String) - Static method in class wtf.ranked.hytale.server.runner.mod.type.UrlMod: Static factory to create a mod from a URL string.
of(String, String, String, String) - Static method in class wtf.ranked.hytale.server.runner.mod.type.GithubMod: Static factory to build a GithubMod from repository coordinates.
of(URI, String) - Static method in class wtf.ranked.hytale.server.runner.mod.type.UrlMod: Static factory to create a mod from a URI.
OFFLINE - Enum constant in enum class wtf.ranked.hytale.server.runner.extension.OnlineMode
OnlineMode - Enum Class in wtf.ranked.hytale.server.runner.extension

P

PlatformFile - Enum Class in wtf.ranked.hytale.server.runner.platform: Supported operating system platforms and their corresponding downloader executable filenames.
PlatformFileProvider - Class in wtf.ranked.hytale.server.runner.platform: Provides the appropriate platform-specific file configuration based on the host operating system.
PlatformFileProvider() - Constructor for class wtf.ranked.hytale.server.runner.platform.PlatformFileProvider
PrepareDownloaderStep - Class in wtf.ranked.hytale.server.runner.step.impl: Initial preparation step for acquiring Hytale server components.
PrepareDownloaderStep() - Constructor for class wtf.ranked.hytale.server.runner.step.impl.PrepareDownloaderStep
PrepareReinstallStep - Class in wtf.ranked.hytale.server.runner.step.impl: Step that wipes the current server installation.
PrepareReinstallStep() - Constructor for class wtf.ranked.hytale.server.runner.step.impl.PrepareReinstallStep
provide() - Method in class wtf.ranked.hytale.server.runner.resource.ResourceProvider.ResourceRequest.Builder
provide(ResourceProvider.ResourceRequest) - Method in class wtf.ranked.hytale.server.runner.resource.HttpResourceProvider: Executes an HTTP GET request and streams the response directly to a file.
provide(ResourceProvider.ResourceRequest) - Method in class wtf.ranked.hytale.server.runner.resource.ResourceProvider: Core logic for fulfilling a resource request.

R

register(String, Class) - Method in interface wtf.ranked.hytale.server.runner.registrar.Registrar: Registers a component with a unique identifier.
register(String, Class) - Method in class wtf.ranked.hytale.server.runner.registrar.GradleServiceRegistrar: Registers a build service if it is not already present in the registry.
register(String, Class) - Method in class wtf.ranked.hytale.server.runner.registrar.task.StepTaskRegistrar
register(String, Class) - Static method in class wtf.ranked.hytale.server.runner.step.TaskStepRegistry
register(String, Class) - Method in class wtf.ranked.hytale.server.runner.registrar.task.GlobalTaskRegistrar
Registrar<C> - Interface in wtf.ranked.hytale.server.runner.registrar: Generic interface for registering plugin components.
ResourceDownloadException - Exception Class in wtf.ranked.hytale.server.runner.resource.exception
ResourceDownloadException(String) - Constructor for exception class wtf.ranked.hytale.server.runner.resource.exception.ResourceDownloadException
ResourceDownloadException(Throwable) - Constructor for exception class wtf.ranked.hytale.server.runner.resource.exception.ResourceDownloadException
ResourceProvider - Class in wtf.ranked.hytale.server.runner.resource: Base build service for acquiring external resources.
ResourceProvider() - Constructor for class wtf.ranked.hytale.server.runner.resource.ResourceProvider
ResourceProvider.ResourceRequest - Record Class in wtf.ranked.hytale.server.runner.resource
ResourceProvider.ResourceRequest.Builder - Class in wtf.ranked.hytale.server.runner.resource
ResourceRequest(URI, File, Duration) - Constructor for record class wtf.ranked.hytale.server.runner.resource.ResourceProvider.ResourceRequest: Creates an instance of a ResourceRequest record class.
run() - Method in class wtf.ranked.hytale.server.runner.step.type.TaskStepDefault
run() - Method in class wtf.ranked.hytale.server.runner.step.type.TaskStepExec
run() - Method in interface wtf.ranked.hytale.server.runner.task.GradleRunningTask: Executes the specific business logic for this task.
runStep() - Method in class wtf.ranked.hytale.server.runner.step.impl.DownloadModStep
runStep() - Method in class wtf.ranked.hytale.server.runner.step.impl.DownloadServerAssetStep
runStep() - Method in class wtf.ranked.hytale.server.runner.step.impl.LaunchServerStep
runStep() - Method in class wtf.ranked.hytale.server.runner.step.impl.PrepareDownloaderStep
runStep() - Method in class wtf.ranked.hytale.server.runner.step.impl.PrepareReinstallStep
runStep() - Method in interface wtf.ranked.hytale.server.runner.step.TaskStep: Standard execution flow for the step.
runTask() - Method in class wtf.ranked.hytale.server.runner.task.DefaultRunningTask: Entry point for Gradle execution.

S

serverAddress(String, int) - Method in class wtf.ranked.hytale.server.runner.HytalePluginExtension: Sets the network address and port for the Hytale server.
setup(GlobalRunningTask) - Method in class wtf.ranked.hytale.server.runner.step.TaskStepLoader: Configures the task dependencies for a given Global task to create a sequential execution pipeline.
steps() - Method in class wtf.ranked.hytale.server.runner.task.global.LaunchServerTask: Defines the sequential boot pipeline.
steps() - Method in class wtf.ranked.hytale.server.runner.task.type.GlobalRunningTask: Defines the ordered sequence of steps required for this task's lifecycle.
StepTaskRegistrar - Class in wtf.ranked.hytale.server.runner.registrar.task: Registrar implementation responsible for initializing internal lifecycle steps.
StepTaskRegistrar() - Constructor for class wtf.ranked.hytale.server.runner.registrar.task.StepTaskRegistrar

T

TaskStep - Interface in wtf.ranked.hytale.server.runner.step
TaskStepDefault - Class in wtf.ranked.hytale.server.runner.step.type: A step implementation for standard internal logic.
TaskStepDefault() - Constructor for class wtf.ranked.hytale.server.runner.step.type.TaskStepDefault
TaskStepExec - Class in wtf.ranked.hytale.server.runner.step.type: A step implementation for external process execution.
TaskStepExec() - Constructor for class wtf.ranked.hytale.server.runner.step.type.TaskStepExec
TaskStepLoader - Class in wtf.ranked.hytale.server.runner.step: Orchestrator that transforms a list of Step classes into a linked Gradle task chain.
TaskStepLoader() - Constructor for class wtf.ranked.hytale.server.runner.step.TaskStepLoader
TaskStepRegistry - Class in wtf.ranked.hytale.server.runner.step: Global registry for mapping TaskStep implementations to their unique Gradle task identifiers.
TaskStepRegistry() - Constructor for class wtf.ranked.hytale.server.runner.step.TaskStepRegistry
timeout() - Method in record class wtf.ranked.hytale.server.runner.resource.ResourceProvider.ResourceRequest: Returns the value of the timeout record component.
timeout(Duration) - Method in class wtf.ranked.hytale.server.runner.resource.ResourceProvider.ResourceRequest.Builder
toString() - Method in record class wtf.ranked.hytale.server.runner.resource.ResourceProvider.ResourceRequest: Returns a string representation of this record class.

U

unpackZipFile(File, File) - Method in class wtf.ranked.hytale.server.runner.util.FileUtil: Extracts a ZIP file to the specified destination and deletes the source archive.
uri() - Method in record class wtf.ranked.hytale.server.runner.resource.ResourceProvider.ResourceRequest: Returns the value of the uri record component.
uri(URI) - Method in class wtf.ranked.hytale.server.runner.resource.ResourceProvider.ResourceRequest.Builder
url(String, String) - Method in class wtf.ranked.hytale.server.runner.mod.ModExtension: Adds a mod to the configuration via a direct download link.
UrlDownloaderStrategy - Class in wtf.ranked.hytale.server.runner.mod.strategy: Strategy for downloading mods via direct HTTP/HTTPS requests.
UrlDownloaderStrategy() - Constructor for class wtf.ranked.hytale.server.runner.mod.strategy.UrlDownloaderStrategy
UrlMod - Class in wtf.ranked.hytale.server.runner.mod.type: A mod implementation defined by a direct web URL.
UrlMod(String, URI) - Constructor for class wtf.ranked.hytale.server.runner.mod.type.UrlMod: Internal constructor for creating a URL-based mod.

V

valueOf(String) - Static method in enum class wtf.ranked.hytale.server.runner.extension.OnlineMode: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class wtf.ranked.hytale.server.runner.platform.PlatformFile: Returns the enum constant of this class with the specified name.
values() - Static method in enum class wtf.ranked.hytale.server.runner.extension.OnlineMode: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class wtf.ranked.hytale.server.runner.platform.PlatformFile: Returns an array containing the constants of this enum class, in the order they are declared.

W

WINDOWS - Enum constant in enum class wtf.ranked.hytale.server.runner.platform.PlatformFile
wtf.ranked.hytale.server.runner - package wtf.ranked.hytale.server.runner
wtf.ranked.hytale.server.runner.extension - package wtf.ranked.hytale.server.runner.extension
wtf.ranked.hytale.server.runner.mod - package wtf.ranked.hytale.server.runner.mod
wtf.ranked.hytale.server.runner.mod.strategy - package wtf.ranked.hytale.server.runner.mod.strategy
wtf.ranked.hytale.server.runner.mod.type - package wtf.ranked.hytale.server.runner.mod.type
wtf.ranked.hytale.server.runner.platform - package wtf.ranked.hytale.server.runner.platform
wtf.ranked.hytale.server.runner.registrar - package wtf.ranked.hytale.server.runner.registrar
wtf.ranked.hytale.server.runner.registrar.task - package wtf.ranked.hytale.server.runner.registrar.task
wtf.ranked.hytale.server.runner.resource - package wtf.ranked.hytale.server.runner.resource
wtf.ranked.hytale.server.runner.resource.exception - package wtf.ranked.hytale.server.runner.resource.exception
wtf.ranked.hytale.server.runner.step - package wtf.ranked.hytale.server.runner.step
wtf.ranked.hytale.server.runner.step.impl - package wtf.ranked.hytale.server.runner.step.impl
wtf.ranked.hytale.server.runner.step.type - package wtf.ranked.hytale.server.runner.step.type
wtf.ranked.hytale.server.runner.task - package wtf.ranked.hytale.server.runner.task
wtf.ranked.hytale.server.runner.task.global - package wtf.ranked.hytale.server.runner.task.global
wtf.ranked.hytale.server.runner.task.type - package wtf.ranked.hytale.server.runner.task.type
wtf.ranked.hytale.server.runner.util - package wtf.ranked.hytale.server.runner.util

A B D E F G H I J L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form