@wayward/types 2.11.1-beta.dev.20220103.1 → 2.11.2-beta

package/definitions/game/multiplayer/Multiplayer.d.ts

@@ -1,181 +1,184 @@
-/*!
- * Copyright 2011-2021 Unlok
- * https://www.unlok.ca
- *
- * Credits & Thanks:
- * https://www.unlok.ca/credits-thanks/
- *
- * Wayward is a copyrighted and licensed work. Modification and/or distribution of any source files is prohibited. If you wish to modify the game in any way, please refer to the modding guide:
- * https://github.com/WaywardGame/types/wiki
- */
-import EventEmitter from "event/EventEmitter";
-import Player from "game/entity/player/Player";
-import type Island from "game/island/Island";
-import type { IJoinServerOptions, IMultiplayerEvents, IMultiplayerOptions, PacketTarget, ServerInfo } from "multiplayer/IMultiplayer";
-import { DisconnectReason, JoinServerRetryReason, MultiplayerSyncCheck, UnableToJoinReason, MultiplayerSyncCheckLevel } from "multiplayer/IMultiplayer";
-import type { IMatchmakingInfo } from "multiplayer/matchmaking/IMatchmaking";
-import type { IConnection } from "multiplayer/networking/IConnection";
-import type { IPacket } from "multiplayer/packets/IPacket";
-export default class Multiplayer extends EventEmitter.Host<IMultiplayerEvents> {
-    /**
-     * Static steam account id when steam support is on
-     * Otherwise it will be a random guid that persists
-     */
-    private _playerIdentifier;
-    /**
-     * Steam id - used for steam networking
-     */
-    private readonly _playerSteamId;
-    private readonly _steamNetworking;
-    private _isServer;
-    private _server;
-    private readonly _clients;
-    private readonly _steamIdToClientMapping;
-    private _joinServerTimeoutId;
-    private _joinedMatchmakingInfo;
-    private _connectedMatchmakingInfo;
-    private _globalMatchmaking;
-    private _globalMatchmakingRetryTimeoutId;
-    private _dedicatedMatchmaking;
-    private _dedicatedMatchmakingRetryTimeoutId;
-    private _options;
-    private _joinServerOptions;
-    private _incomingPacketQueue;
-    private _incomingPacketProcessingPaused;
-    private _packetTickIntervalId;
-    private _currentPacketProcessing;
-    private _currentSyncPacketsWaiting;
-    private _currentSyncPacketsProcessing;
-    private _syncCheckStack;
-    private _activeSyncCheck;
-    private _syncChecksSuppressed;
-    private _recentPackets;
-    private _enabledSyncChecks;
-    private _disconnectingFromSyncIssue;
-    private readonly _autojoinEnabled;
-    private _ipAddress;
-    private readonly _matchmakingSecret;
-    constructor();
-    isConnected(): boolean;
-    isReady(): boolean;
-    isServer(): boolean;
-    isClient(): boolean;
-    isProcessingPacket(): boolean;
-    getPlayerIdentifier(): string;
-    getOptions(): IMultiplayerOptions;
-    setOptions(options: IMultiplayerOptions, updateGame?: boolean): void;
-    updateOptions(updates: Partial<IMultiplayerOptions>): void;
-    /**
-     * Helper method for updating sync checks
-     * multiplayer.updateSyncChecks("normal")
-     * multiplayer.updateSyncChecks("verbose")
-     */
-    updateSyncChecks(syncChecks: boolean | MultiplayerSyncCheckLevel | MultiplayerSyncCheck[]): void;
-    private parseSyncChecks;
-    enableSteamNetworkConnections(enable: boolean): void;
-    getConnectedMatchmakingInfo(): IMatchmakingInfo | undefined;
-    /**
-     * Three types of game codes:
-     * 1. Dedicated server code - ex. 1.2.3.4:1234
-     * 2. Steam lobby code - ex. steam:109775241017071190
-     * 3. Global matchmaking server id - ex. 87287724-49aa-e556-4145-3ed96c649a20
-     */
-    getConnectedGameCode(): string | undefined;
-    isSteamLobby(gameCode: string): boolean;
-    convertGameCodeToServerInfo(gameCode: string): ServerInfo;
-    getDedicatedServerMatchmakingInfo(matchmakingServer: string, identifier?: string): IMatchmakingInfo;
-    getBannedPlayers(): string[];
-    setBanned(identifier: string, ban: boolean): boolean;
-    createServer(serverInfo: ServerInfo): void;
-    joinServer(serverInfo: ServerInfo, options?: Partial<IJoinServerOptions>): void;
-    rejoinServer(options?: {
-        randomizeIdentifier?: boolean;
-        automaticallyRetry?: boolean;
-    }): Promise<boolean>;
-    /**
-     * Disconnects from multiplayer
-     * Callable from a server or client
-     * If a client is in a game, disconnectAndResetGameState should be called
-     * @returns True when it disconnected. False is there was nothing to disconnect
-     */
-    disconnect(reason: DisconnectReason, args?: any[], unloadingOrResetGameState?: boolean): Promise<boolean>;
-    displayJoinServerRetryDialog(matchmakingInfo: IMatchmakingInfo, retryReason: JoinServerRetryReason): Promise<void>;
-    disconnectAndResetGameState(reason: DisconnectReason.UnableToJoinGame, unableToJoinReason: UnableToJoinReason): Promise<void>;
-    disconnectAndResetGameState(reason: DisconnectReason, reasonDescription?: any[]): Promise<void>;
-    kick(player: Player, reason: DisconnectReason.Kick | DisconnectReason.Banned): void;
-    onPlaying(): Promise<void>;
-    onLobbyEntered(success: boolean, lobbyId: string): void;
-    onLobbyExited(lobbyId: string): void;
-    getClients(): IConnection[];
-    closeConnection(reason: DisconnectReason, connection: IConnection): void;
-    sendConnectPacket(): void;
-    removePlayers(reason: DisconnectReason): void;
-    removePlayer(connection: IConnection, reason: DisconnectReason): void;
-    sendPacket(packet: IPacket, exclude?: PacketTarget): void;
-    sendPacketTo(to: PacketTarget, packet: IPacket, force?: boolean): void;
-    /**
-     * Sends a packet in a synchronized way to the server or clients
-     *
-     * When ran as a server, clientSide() is called and the packet data is sent to all the clients.
-     *
-     * When ran as a client, the packet is sent to the server. The server is expected to call this method, which in turn sends the packet back to the client. When the client receives the packet, this method a second time and clientSide() is called.
-     *
-     * @param packet The packet
-     * @param clientSide The method to run for the client or server.
-     * @param checkId When true, this packet will not be sent to the server/client if the same packet is already being processed. When false, this packet will not be sent if any packet is already being processed. Useful when dealing with methods that could end up sending multiple packets while a packet is already being processed.
-     * @param wait When true, the client will keep track of what packets it sent to the server. If the client calls this method again before the server responds, it will not send a duplicate packet. It will wait for the server to send the packet back before allowing another one to be sent. When true, it will keep track of duplicate packets based on the packet type. When it's a number, it will keep track of duplicate packets based on the packet type + the number.
-     */
-    syncPacket<T = any>(packet: IPacket, clientSide?: NullaryFunction<T>, checkId?: boolean, wait?: number | true): T | undefined;
-    markCurrentProcessingPacket(packetId: number, processing: boolean): void;
-    clearSyncPacketWaiting(packet: IPacket, wait: number): void;
-    clearSyncPacketsWaiting(waitId?: string): void;
-    pauseIncomingPacketProcessing(pause: boolean, clearQueue?: boolean): void;
-    updatePlayerId(oldPid: number, newPid: number): void;
-    suppressSyncChecks(suppress: boolean): void;
-    syncGameState(): void;
-    clearKeepAliveTimeouts(): void;
-    addKeepAliveTimeouts(): void;
-    updateGlobalServerDirectory(): void;
-    checkConnection(): Promise<void>;
-    isSyncCheckEnabled(syncCheck: MultiplayerSyncCheck, failIfNotActiveOrSurpressed?: boolean): boolean;
-    addSyncCheck(syncCheck: MultiplayerSyncCheck, value: any, addStackTrace?: boolean): void;
-    addMiscSeedSyncCheck(island: Island, ...messages: any[]): void;
-    addBeforeSyncChecks(packet: IPacket): void;
-    addAfterSyncChecks(packet: IPacket): void;
-    sendChatMessage(sender: Player, message: string): void;
-    private addDefaultSyncChecks;
-    private getPacketSyncChecks;
-    private clearJoinServerRetryTimeout;
-    private startMatchmakingServer;
-    private stopMatchmakingServer;
-    private setupClientConnection;
-    private connectGlobalMatchmakingServer;
-    private disconnectGlobalMatchmakingServer;
-    private connectDedicatedMatchmakingServer;
-    private disconnectDedicatedMatchmakingServer;
-    private onMatchmakingMessage;
-    private _onConnected;
-    private onConnectionData;
-    private serverPacketTick;
-    private clientPacketTick;
-    private processIncomingPackets;
-    private processOutgoingPackets;
-    private processPacket;
-    private synchronizationCheck;
-    private desync;
-    private sendPacketInternal;
-    private onStateChange;
-    private convertToMatchmakingInfo;
-    private getSyncPacketWaitId;
-    private refreshLobbySteamRelayStatus;
-    private onRelayNetworkStatus;
-    /**
-     * Called when a remote steam id is trying to send us a message
-     */
-    private onSteamNetworkingMessagesSessionRequest;
-    /**
-     * Called when we failed to connect to a remote steam id
-     */
-    private onSteamNetworkingMessagesSessionFailed;
-    private refreshEnabledSyncChecks;
-}
+/*!
+ * Copyright 2011-2021 Unlok
+ * https://www.unlok.ca
+ *
+ * Credits & Thanks:
+ * https://www.unlok.ca/credits-thanks/
+ *
+ * Wayward is a copyrighted and licensed work. Modification and/or distribution of any source files is prohibited. If you wish to modify the game in any way, please refer to the modding guide:
+ * https://github.com/WaywardGame/types/wiki
+ */
+import EventEmitter from "event/EventEmitter";
+import Player from "game/entity/player/Player";
+import type Island from "game/island/Island";
+import type { IJoinServerOptions, IMultiplayerEvents, IMultiplayerOptions, PacketTarget, ServerInfo } from "multiplayer/IMultiplayer";
+import { DisconnectReason, JoinServerRetryReason, MultiplayerSyncCheck, UnableToJoinReason, MultiplayerSyncCheckLevel } from "multiplayer/IMultiplayer";
+import type { IMatchmakingInfo } from "multiplayer/matchmaking/IMatchmaking";
+import type { IConnection } from "multiplayer/networking/IConnection";
+import type { IPacket } from "multiplayer/packets/IPacket";
+export default class Multiplayer extends EventEmitter.Host<IMultiplayerEvents> {
+    /**
+     * Static steam account id when steam support is on
+     * Otherwise it will be a random guid that persists
+     */
+    private _playerIdentifier;
+    /**
+     * Steam id - used for steam networking
+     */
+    private readonly _playerSteamId;
+    private readonly _steamNetworking;
+    private _isServer;
+    private _server;
+    private readonly _clients;
+    private readonly _steamIdToClientMapping;
+    private _joinServerTimeoutId;
+    private _steamNetworkConnectionWebRTCFallbackTimeoutId;
+    private _joinedMatchmakingInfo;
+    private _connectedMatchmakingInfo;
+    private _globalMatchmaking;
+    private _globalMatchmakingRetryTimeoutId;
+    private _dedicatedMatchmaking;
+    private _dedicatedMatchmakingRetryTimeoutId;
+    private _options;
+    private _joinServerOptions;
+    private _incomingPacketQueue;
+    private _incomingPacketProcessingPaused;
+    private _packetTickIntervalId;
+    private _currentPacketProcessing;
+    private _currentSyncPacketsWaiting;
+    private _currentSyncPacketsProcessing;
+    private _syncCheckStack;
+    private _activeSyncCheck;
+    private _syncChecksSuppressed;
+    private _recentPackets;
+    private _enabledSyncChecks;
+    private _disconnectingFromSyncIssue;
+    private readonly _autojoinEnabled;
+    private _ipAddress;
+    private readonly _matchmakingSecret;
+    constructor();
+    isConnected(): boolean;
+    isReady(): boolean;
+    isServer(): boolean;
+    isClient(): boolean;
+    isProcessingPacket(): boolean;
+    getPlayerIdentifier(): string;
+    getOptions(): IMultiplayerOptions;
+    setOptions(options: IMultiplayerOptions, updateGame?: boolean): void;
+    updateOptions(updates: Partial<IMultiplayerOptions>): void;
+    /**
+     * Helper method for updating sync checks
+     * multiplayer.updateSyncChecks("normal")
+     * multiplayer.updateSyncChecks("verbose")
+     */
+    updateSyncChecks(syncChecks: boolean | MultiplayerSyncCheckLevel | MultiplayerSyncCheck[]): void;
+    private parseSyncChecks;
+    enableSteamNetworkConnections(enable: boolean): void;
+    getConnectedMatchmakingInfo(): IMatchmakingInfo | undefined;
+    /**
+     * Three types of game codes:
+     * 1. Dedicated server code - ex. 1.2.3.4:1234
+     * 2. Steam lobby code - ex. steam:109775241017071190
+     * 3. Global matchmaking server id - ex. 87287724-49aa-e556-4145-3ed96c649a20
+     */
+    getConnectedGameCode(): string | undefined;
+    isSteamLobby(gameCode: string): boolean;
+    convertGameCodeToServerInfo(gameCode: string): ServerInfo;
+    getDedicatedServerMatchmakingInfo(matchmakingServer: string, identifier?: string): IMatchmakingInfo;
+    getBannedPlayers(): string[];
+    setBanned(identifier: string, ban: boolean): boolean;
+    createServer(serverInfo: ServerInfo): void;
+    joinServer(serverInfo: ServerInfo, options?: Partial<IJoinServerOptions>): void;
+    rejoinServer(options?: {
+        randomizeIdentifier?: boolean;
+        automaticallyRetry?: boolean;
+        enableSteamNetworkConnections?: boolean;
+    }): Promise<boolean>;
+    /**
+     * Disconnects from multiplayer
+     * Callable from a server or client
+     * If a client is in a game, disconnectAndResetGameState should be called
+     * @returns True when it disconnected. False is there was nothing to disconnect
+     */
+    disconnect(reason: DisconnectReason, args?: any[], unloadingOrResetGameState?: boolean): Promise<boolean>;
+    displayJoinServerRetryDialog(matchmakingInfo: IMatchmakingInfo, retryReason: JoinServerRetryReason): Promise<void>;
+    disconnectAndResetGameState(reason: DisconnectReason.UnableToJoinGame, unableToJoinReason: UnableToJoinReason): Promise<void>;
+    disconnectAndResetGameState(reason: DisconnectReason, reasonDescription?: any[]): Promise<void>;
+    kick(player: Player, reason: DisconnectReason.Kick | DisconnectReason.Banned): void;
+    onPlaying(): Promise<void>;
+    onLobbyEntered(success: boolean, lobbyId: string): void;
+    onLobbyExited(lobbyId: string): void;
+    getClients(): IConnection[];
+    closeConnection(reason: DisconnectReason, connection: IConnection): void;
+    sendConnectPacket(): void;
+    removePlayers(reason: DisconnectReason): void;
+    removePlayer(connection: IConnection, reason: DisconnectReason): void;
+    sendPacket(packet: IPacket, exclude?: PacketTarget): void;
+    sendPacketTo(to: PacketTarget, packet: IPacket, force?: boolean): void;
+    /**
+     * Sends a packet in a synchronized way to the server or clients
+     *
+     * When ran as a server, clientSide() is called and the packet data is sent to all the clients.
+     *
+     * When ran as a client, the packet is sent to the server. The server is expected to call this method, which in turn sends the packet back to the client. When the client receives the packet, this method a second time and clientSide() is called.
+     *
+     * @param packet The packet
+     * @param clientSide The method to run for the client or server.
+     * @param checkId When true, this packet will not be sent to the server/client if the same packet is already being processed. When false, this packet will not be sent if any packet is already being processed. Useful when dealing with methods that could end up sending multiple packets while a packet is already being processed.
+     * @param wait When true, the client will keep track of what packets it sent to the server. If the client calls this method again before the server responds, it will not send a duplicate packet. It will wait for the server to send the packet back before allowing another one to be sent. When true, it will keep track of duplicate packets based on the packet type. When it's a number, it will keep track of duplicate packets based on the packet type + the number.
+     */
+    syncPacket<T = any>(packet: IPacket, clientSide?: NullaryFunction<T>, checkId?: boolean, wait?: number | true): T | undefined;
+    markCurrentProcessingPacket(packetId: number, processing: boolean): void;
+    clearSyncPacketWaiting(packet: IPacket, wait: number): void;
+    clearSyncPacketsWaiting(waitId?: string): void;
+    pauseIncomingPacketProcessing(pause: boolean, clearQueue?: boolean): void;
+    updatePlayerId(oldPid: number, newPid: number): void;
+    suppressSyncChecks(suppress: boolean): void;
+    syncGameState(): void;
+    clearKeepAliveTimeouts(): void;
+    addKeepAliveTimeouts(): void;
+    updateGlobalServerDirectory(): void;
+    checkConnection(): Promise<void>;
+    isSyncCheckEnabled(syncCheck: MultiplayerSyncCheck, failIfNotActiveOrSurpressed?: boolean): boolean;
+    addSyncCheck(syncCheck: MultiplayerSyncCheck, value: any, addStackTrace?: boolean): void;
+    addMiscSeedSyncCheck(island: Island, ...messages: any[]): void;
+    addBeforeSyncChecks(packet: IPacket): void;
+    addAfterSyncChecks(packet: IPacket): void;
+    sendChatMessage(sender: Player, message: string): void;
+    private addDefaultSyncChecks;
+    private getPacketSyncChecks;
+    private clearJoinServerRetryTimeout;
+    clearSteamNetworkConnectionWebRTCFallbackTimer(): void;
+    private startMatchmakingServer;
+    private stopMatchmakingServer;
+    private setupClientConnection;
+    private connectGlobalMatchmakingServer;
+    private disconnectGlobalMatchmakingServer;
+    private connectDedicatedMatchmakingServer;
+    private disconnectDedicatedMatchmakingServer;
+    private onMatchmakingMessage;
+    private _onConnected;
+    private onConnectionData;
+    private serverPacketTick;
+    private clientPacketTick;
+    private processIncomingPackets;
+    private processOutgoingPackets;
+    private processPacket;
+    private synchronizationCheck;
+    private desync;
+    private sendPacketInternal;
+    private onStateChange;
+    private convertToMatchmakingInfo;
+    private getSyncPacketWaitId;
+    private refreshLobbySteamRelayStatus;
+    private onRelayNetworkStatus;
+    /**
+     * Called when a remote steam id is trying to send us a message
+     */
+    private onSteamNetworkingMessagesSessionRequest;
+    /**
+     * Called when we failed to connect to a remote steam id
+     */
+    private onSteamNetworkingMessagesSessionFailed;
+    private refreshEnabledSyncChecks;
+}

package/definitions/game/multiplayer/dedicatedServer/ssh/DefaultShell.d.ts

@@ -1,34 +1,34 @@
-/*!
- * Copyright 2011-2021 Unlok
- * https://www.unlok.ca
- *
- * Credits & Thanks:
- * https://www.unlok.ca/credits-thanks/
- *
- * Wayward is a copyrighted and licensed work. Modification and/or distribution of any source files is prohibited. If you wish to modify the game in any way, please refer to the modding guide:
- * https://github.com/WaywardGame/types/wiki
- */
-import type { ISshSession, ISshStream } from "multiplayer/dedicatedServer/ssh/ISsh";
-import type { ISshCommandManager } from "multiplayer/dedicatedServer/ssh/ISshCommandManager";
-import type ISshShell from "multiplayer/dedicatedServer/ssh/ISshShell";
-import Shell from "multiplayer/dedicatedServer/ssh/Shell";
-export default class DefaultShell extends Shell implements ISshShell {
-    private readonly username;
-    private readonly serverName;
-    readonly sshCommandManager: ISshCommandManager;
-    constructor(session: ISshSession, stream: ISshStream, username: string, serverName: string);
-    /**
-     * Writes the marker
-     */
-    writeMarker(): Promise<void>;
-    /**
-     * Processes a line sent for the session
-     * @returns A shell to push a new action shell, false to exit the session, undefined to keep the active shell going
-     */
-    processLine(line: string): Promise<Shell | false | undefined>;
-    /**
-     * Check if Ctrl+C is allowed to close the shell
-     * @return True if you want ctrl+c to close the shell
-     */
-    protected allowCtrlCClose(): boolean;
-}
+/*!
+ * Copyright 2011-2021 Unlok
+ * https://www.unlok.ca
+ *
+ * Credits & Thanks:
+ * https://www.unlok.ca/credits-thanks/
+ *
+ * Wayward is a copyrighted and licensed work. Modification and/or distribution of any source files is prohibited. If you wish to modify the game in any way, please refer to the modding guide:
+ * https://github.com/WaywardGame/types/wiki
+ */
+import type { ISshSession, ISshStream } from "multiplayer/dedicatedServer/ssh/ISsh";
+import type { ISshCommandManager } from "multiplayer/dedicatedServer/ssh/ISshCommandManager";
+import type ISshShell from "multiplayer/dedicatedServer/ssh/ISshShell";
+import Shell from "multiplayer/dedicatedServer/ssh/Shell";
+export default class DefaultShell extends Shell implements ISshShell {
+    private readonly username;
+    private readonly serverName;
+    readonly sshCommandManager: ISshCommandManager;
+    constructor(session: ISshSession, stream: ISshStream, username: string, serverName: string);
+    /**
+     * Writes the marker
+     */
+    writeMarker(): Promise<void>;
+    /**
+     * Processes a line sent for the session
+     * @returns A shell to push a new action shell, false to exit the session, undefined to keep the active shell going
+     */
+    processLine(line: string): Promise<Shell | false | undefined>;
+    /**
+     * Check if Ctrl+C is allowed to close the shell
+     * @return True if you want ctrl+c to close the shell
+     */
+    protected allowCtrlCClose(): boolean;
+}

package/definitions/game/multiplayer/dedicatedServer/ssh/ISsh.d.ts

@@ -1,26 +1,26 @@
-/*!
- * Copyright 2011-2021 Unlok
- * https://www.unlok.ca
- *
- * Credits & Thanks:
- * https://www.unlok.ca/credits-thanks/
- *
- * Wayward is a copyrighted and licensed work. Modification and/or distribution of any source files is prohibited. If you wish to modify the game in any way, please refer to the modding guide:
- * https://github.com/WaywardGame/types/wiki
- */
-import type Log from "utilities/Log";
-export declare const globalHistory: Map<string, string[]>;
-export declare const maxHistory = 50;
-export interface ISshStream {
-    write(data: string): void;
-    end(): void;
-    exit(code: number): void;
-    on(name: "error", callback: (ex: any) => void): void;
-    on(name: "data", callback: (data: {
-        toString(): string;
-    }) => void): void;
-}
-export interface ISshSession {
-    clientId: string;
-    clientLog: Log;
-}
+/*!
+ * Copyright 2011-2021 Unlok
+ * https://www.unlok.ca
+ *
+ * Credits & Thanks:
+ * https://www.unlok.ca/credits-thanks/
+ *
+ * Wayward is a copyrighted and licensed work. Modification and/or distribution of any source files is prohibited. If you wish to modify the game in any way, please refer to the modding guide:
+ * https://github.com/WaywardGame/types/wiki
+ */
+import type Log from "utilities/Log";
+export declare const globalHistory: Map<string, string[]>;
+export declare const maxHistory = 50;
+export interface ISshStream {
+    write(data: string): void;
+    end(): void;
+    exit(code: number): void;
+    on(name: "error", callback: (ex: any) => void): void;
+    on(name: "data", callback: (data: {
+        toString(): string;
+    }) => void): void;
+}
+export interface ISshSession {
+    clientId: string;
+    clientLog: Log;
+}

package/definitions/game/multiplayer/dedicatedServer/ssh/ISshCommand.d.ts

@@ -1,52 +1,52 @@
-/*!
- * Copyright 2011-2021 Unlok
- * https://www.unlok.ca
- *
- * Credits & Thanks:
- * https://www.unlok.ca/credits-thanks/
- *
- * Wayward is a copyrighted and licensed work. Modification and/or distribution of any source files is prohibited. If you wish to modify the game in any way, please refer to the modding guide:
- * https://github.com/WaywardGame/types/wiki
- */
-import type ISshShell from "multiplayer/dedicatedServer/ssh/ISshShell";
-export interface ISshCommand {
-    type: SshCommandType;
-    category: SshCommandCategory;
-    helpText: string;
-    requirements: SshCommandRequirement;
-    callback: SshCommandCallback;
-}
-export declare type SshCommandCallback = (shell: ISshShell, args: string) => Promise<SshCommandResult>;
-export declare type SshCommandResult = ISshShell | false | undefined | void;
-export declare enum SshCommandType {
-    Help = 0,
-    Status = 1,
-    Ls = 2,
-    Motd = 3,
-    End = 4,
-    New = 5,
-    Load = 6,
-    Backup = 7,
-    Save = 8,
-    Sync = 9,
-    Send = 10,
-    Chat = 11,
-    Kick = 12,
-    Ban = 13,
-    Unban = 14,
-    Shutdown = 15,
-    Exit = 16
-}
-export declare enum SshCommandCategory {
-    Server = 0,
-    Game = 1,
-    Chat = 2,
-    Admin = 3,
-    Ssh = 4,
-    Uncategorized = 5
-}
-export declare enum SshCommandRequirement {
-    None = 0,
-    InGame = 1,
-    NotInGame = 2
-}
+/*!
+ * Copyright 2011-2021 Unlok
+ * https://www.unlok.ca
+ *
+ * Credits & Thanks:
+ * https://www.unlok.ca/credits-thanks/
+ *
+ * Wayward is a copyrighted and licensed work. Modification and/or distribution of any source files is prohibited. If you wish to modify the game in any way, please refer to the modding guide:
+ * https://github.com/WaywardGame/types/wiki
+ */
+import type ISshShell from "multiplayer/dedicatedServer/ssh/ISshShell";
+export interface ISshCommand {
+    type: SshCommandType;
+    category: SshCommandCategory;
+    helpText: string;
+    requirements: SshCommandRequirement;
+    callback: SshCommandCallback;
+}
+export declare type SshCommandCallback = (shell: ISshShell, args: string) => Promise<SshCommandResult>;
+export declare type SshCommandResult = ISshShell | false | undefined | void;
+export declare enum SshCommandType {
+    Help = 0,
+    Status = 1,
+    Ls = 2,
+    Motd = 3,
+    End = 4,
+    New = 5,
+    Load = 6,
+    Backup = 7,
+    Save = 8,
+    Sync = 9,
+    Send = 10,
+    Chat = 11,
+    Kick = 12,
+    Ban = 13,
+    Unban = 14,
+    Shutdown = 15,
+    Exit = 16
+}
+export declare enum SshCommandCategory {
+    Server = 0,
+    Game = 1,
+    Chat = 2,
+    Admin = 3,
+    Ssh = 4,
+    Uncategorized = 5
+}
+export declare enum SshCommandRequirement {
+    None = 0,
+    InGame = 1,
+    NotInGame = 2
+}

package/definitions/game/multiplayer/dedicatedServer/ssh/ISshCommandManager.d.ts

@@ -1,16 +1,16 @@
-/*!
- * Copyright 2011-2021 Unlok
- * https://www.unlok.ca
- *
- * Credits & Thanks:
- * https://www.unlok.ca/credits-thanks/
- *
- * Wayward is a copyrighted and licensed work. Modification and/or distribution of any source files is prohibited. If you wish to modify the game in any way, please refer to the modding guide:
- * https://github.com/WaywardGame/types/wiki
- */
-import type { ISshCommand, SshCommandResult, SshCommandType } from "multiplayer/dedicatedServer/ssh/ISshCommand";
-import type ISshShell from "multiplayer/dedicatedServer/ssh/ISshShell";
-import type { IGenericManager } from "utilities/generic/IGenericManager";
-export interface ISshCommandManager extends IGenericManager<ISshCommand> {
-    execute(shell: ISshShell, sshCommand: SshCommandType, args?: string): Promise<SshCommandResult>;
-}
+/*!
+ * Copyright 2011-2021 Unlok
+ * https://www.unlok.ca
+ *
+ * Credits & Thanks:
+ * https://www.unlok.ca/credits-thanks/
+ *
+ * Wayward is a copyrighted and licensed work. Modification and/or distribution of any source files is prohibited. If you wish to modify the game in any way, please refer to the modding guide:
+ * https://github.com/WaywardGame/types/wiki
+ */
+import type { ISshCommand, SshCommandResult, SshCommandType } from "multiplayer/dedicatedServer/ssh/ISshCommand";
+import type ISshShell from "multiplayer/dedicatedServer/ssh/ISshShell";
+import type { IGenericManager } from "utilities/generic/IGenericManager";
+export interface ISshCommandManager extends IGenericManager<ISshCommand> {
+    execute(shell: ISshShell, sshCommand: SshCommandType, args?: string): Promise<SshCommandResult>;
+}