91 lines
3.5 KiB
TypeScript
91 lines
3.5 KiB
TypeScript
import { SaveLoadRouter } from "@spt/di/Router";
|
|
import { ISptProfile, Info } from "@spt/models/eft/profile/ISptProfile";
|
|
import { ICoreConfig } from "@spt/models/spt/config/ICoreConfig";
|
|
import { ILogger } from "@spt/models/spt/utils/ILogger";
|
|
import { ConfigServer } from "@spt/servers/ConfigServer";
|
|
import { LocalisationService } from "@spt/services/LocalisationService";
|
|
import { HashUtil } from "@spt/utils/HashUtil";
|
|
import { JsonUtil } from "@spt/utils/JsonUtil";
|
|
import { VFS } from "@spt/utils/VFS";
|
|
export declare class SaveServer {
|
|
protected vfs: VFS;
|
|
protected saveLoadRouters: SaveLoadRouter[];
|
|
protected jsonUtil: JsonUtil;
|
|
protected hashUtil: HashUtil;
|
|
protected localisationService: LocalisationService;
|
|
protected logger: ILogger;
|
|
protected configServer: ConfigServer;
|
|
protected profileFilepath: string;
|
|
protected profiles: {};
|
|
protected onBeforeSaveCallbacks: {};
|
|
protected saveMd5: {};
|
|
protected coreConfig: ICoreConfig;
|
|
constructor(vfs: VFS, saveLoadRouters: SaveLoadRouter[], jsonUtil: JsonUtil, hashUtil: HashUtil, localisationService: LocalisationService, logger: ILogger, configServer: ConfigServer);
|
|
/**
|
|
* Add callback to occur prior to saving profile changes
|
|
* @param id Id for save callback
|
|
* @param callback Callback to execute prior to running SaveServer.saveProfile()
|
|
*/
|
|
addBeforeSaveCallback(id: string, callback: (profile: Partial<ISptProfile>) => Partial<ISptProfile>): void;
|
|
/**
|
|
* Remove a callback from being executed prior to saving profile in SaveServer.saveProfile()
|
|
* @param id Id of callback to remove
|
|
*/
|
|
removeBeforeSaveCallback(id: string): void;
|
|
/**
|
|
* Load all profiles in /user/profiles folder into memory (this.profiles)
|
|
*/
|
|
load(): void;
|
|
/**
|
|
* Save changes for each profile from memory into user/profiles json
|
|
*/
|
|
save(): void;
|
|
/**
|
|
* Get a player profile from memory
|
|
* @param sessionId Session id
|
|
* @returns ISptProfile
|
|
*/
|
|
getProfile(sessionId: string): ISptProfile;
|
|
profileExists(id: string): boolean;
|
|
/**
|
|
* Get all profiles from memory
|
|
* @returns Dictionary of ISptProfile
|
|
*/
|
|
getProfiles(): Record<string, ISptProfile>;
|
|
/**
|
|
* Delete a profile by id
|
|
* @param sessionID Id of profile to remove
|
|
* @returns true when deleted, false when profile not found
|
|
*/
|
|
deleteProfileById(sessionID: string): boolean;
|
|
/**
|
|
* Create a new profile in memory with empty pmc/scav objects
|
|
* @param profileInfo Basic profile data
|
|
*/
|
|
createProfile(profileInfo: Info): void;
|
|
/**
|
|
* Add full profile in memory by key (info.id)
|
|
* @param profileDetails Profile to save
|
|
*/
|
|
addProfile(profileDetails: ISptProfile): void;
|
|
/**
|
|
* Look up profile json in user/profiles by id and store in memory
|
|
* Execute saveLoadRouters callbacks after being loaded into memory
|
|
* @param sessionID Id of profile to store in memory
|
|
*/
|
|
loadProfile(sessionID: string): void;
|
|
/**
|
|
* Save changes from in-memory profile to user/profiles json
|
|
* Execute onBeforeSaveCallbacks callbacks prior to being saved to json
|
|
* @param sessionID profile id (user/profiles/id.json)
|
|
* @returns time taken to save in MS
|
|
*/
|
|
saveProfile(sessionID: string): number;
|
|
/**
|
|
* Remove a physical profile json from user/profiles
|
|
* @param sessionID Profile id to remove
|
|
* @returns true if file no longer exists
|
|
*/
|
|
removeProfile(sessionID: string): boolean;
|
|
}
|