import type { InternalClientOptions } from "./common.js"; export declare function buildV1(options: InternalClientOptions): { /** * Performs a health check on the Dedicated Server API. Allows passing additional data between Modded Dedicated Server and Modded Game Client. * * This function requires no Authentication. */ HealthCheck: (extra?: Omit | undefined) => Promise; /** * Verifies the Authentication token provided to the Dedicated Server API. Returns No Content if the provided token is valid. * * This function does not require input parameters and does not return any data. */ VerifyAuthenticationToken: (extra?: Omit | undefined) => Promise; /** * Attempts to perform a passwordless login to the Dedicated Server as a player. * * Passwordless login is possible if the Dedicated Server is not claimed, or if Client Protection Password is not set for the Dedicated Server. * * This function requires no Authentication. */ PasswordlessLogin: (extra?: Omit | undefined) => Promise; /** * Attempts to log in to the Dedicated Server as a player using either Admin Password or Client Protection Password. * * This function requires no Authentication. */ PasswordLogin: (extra?: Omit | undefined) => Promise; /** * Retrieves the current state of the Dedicated Server. */ QueryServerState: (extra?: Omit | undefined) => Promise; /** * Retrieves currently applied server options and server options that are still pending application (because of needing session or server restart). */ GetServerOptions: (extra?: Omit | undefined) => Promise; /** * Retrieves currently applied advanced game settings. */ GetAdvancedGameSettings: (extra?: Omit | undefined) => Promise; /** * Applies new values to the provided Advanced Game Settings properties. * * Will automatically enable Advanced Game Settings for the currently loaded save if they are not enabled already. */ ApplyAdvancedGameSettings: (extra?: Omit | undefined) => Promise; /** * Claims this Dedicated Server if it is not claimed. * * Requires InitialAdmin privilege level, which can only be acquired by attempting passwordless login while the server does not have an Admin Password set, e.g. it is not claimed yet. * * Function does not return any data in case of success, and the server is claimed. * * The client should drop InitialAdmin privileges after that and use returned AuthenticationToken instead, and update it's cached server game state by calling QueryServerState. */ ClaimServer: (extra?: Omit | undefined) => Promise; /** * Renames the Dedicated Server once it has been claimed. * * Requires Admin privileges. * * Function does not return any data on success. */ RenameServer: (extra?: Omit | undefined) => Promise; /** * Updates the currently set Client Protection Password. * * This will invalidate all previously issued Client authentication tokens. * * Pass empty string to remove the password, and let anyone join the server as Client. * * Requires Admin privileges. * * Function does not return any data on success. */ SetClientPassword: (extra?: Omit | undefined) => Promise; /** * Updates the currently set Admin Password. * * This will invalidate all previously issued Client and Admin authentication tokens. * * Requires Admin privileges. * * Function does not return any data on success. */ SetAdminPassword: (extra?: Omit | undefined) => Promise; /** * Updates the name of the session that the Dedicated Server will automatically load on startup. * * Does not change currently loaded session. * * Requires Admin privileges. * * Function does not return any data on success. */ SetAutoLoadSessionName: (extra?: Omit | undefined) => Promise; /** * Runs the given Console Command on the Dedicated Server, and returns it's output to the Console. * * Requires Admin privileges. */ RunCommand: (extra?: Omit | undefined) => Promise; /** * Shuts down the Dedicated Server. * * If automatic restart script is setup, this allows restarting the server to apply new settings or update. * * Requires Admin privileges. * * Shutdowns initiated by remote hosts are logged with their IP and their token. * * Function does not return any data on success, and does not take any parameters. */ Shutdown: (extra?: Omit | undefined) => Promise; /** * Applies new Server Options to the Dedicated Server. * * Requires Admin privileges. * * Function does not return any data on success. */ ApplyServerOptions: (extra?: Omit | undefined) => Promise; /** * Creates a new session on the Dedicated Server, and immediately loads it. * * HTTPS API becomes temporarily unavailable when map loading is in progress. * * Function does not return any data on success. */ CreateNewGame: (extra?: Omit | undefined) => Promise; /** * Saves the currently loaded session into the new save game file named as the argument. * * Requires Admin privileges. * * SaveName might be changed to satisfy file system restrictions on file names. * * Function does not return any data on success. */ SaveGame: (extra?: Omit | undefined) => Promise; /** * Enumerates all save game files available on the Dedicated Server. * * Requires Admin privileges. * * Function does not require any additional parameters. */ EnumerateSessions: (extra?: Omit | undefined) => Promise; }; export type * from "./ApplyAdvancedGameSettings.js"; export type * from "./ApplyServerOptions.js"; export type * from "./ClaimServer.js"; export type * from "./common.js"; export type * from "./CreateNewGame.js"; export type * from "./EnumerateSessions.js"; export type * from "./error.js"; export type * from "./GetAdvancedGameSettings.js"; export type * from "./GetServerOptions.js"; export type * from "./HealthCheck.js"; export type * from "./PasswordlessLogin.js"; export type * from "./PasswordLogin.js"; export type * from "./QueryServerState.js"; export type * from "./RenameServer.js"; export type * from "./RunCommand.js"; export type * from "./SaveGame.js"; export type * from "./SetAdminPassword.js"; export type * from "./SetAutoLoadSessionName.js"; export type * from "./SetClientPassword.js"; export type * from "./Shutdown.js"; export type * from "./VerifyAuthenticationToken.js";