Saver

Module used to save data between world sessions, different worlds have their own saves.

Index

Interfaces

• DefaultSavesFunction
• IHashSaver
• IObjectSaver
• IScopeSaver
• ObjectLoadFunction
• ObjectSaveFunction
• ScopeLoadFunction
• ScopeSaveFunction

Type Aliases

• SaveableObjectType

Functions

• addSavesScope
• deserialize
• deserializeFromString
• registerObject
• registerObjectSaver
• registerScopeSaver
• serialize
• serializeToString
• setObjectIgnored

Interfaces

DefaultSavesFunction

• DefaultSavesFunction(): object

• Returns object

IHashSaver

IHashSaver:

getId

• getId(): number

• Returns number

setId

• setId(id: number): void

• Parameters

  • id: number

  Returns void

IObjectSaver

IObjectSaver:

Interface that should be implemented to pass object as Saver.registerObjectSaver parameter.

read

read: ObjectLoadFunction

Function that converts serialized data from saves scope to your object instance.

save

save: ObjectSaveFunction

Function used to save serialized data of your object instance.

IScopeSaver

IScopeSaver:

Interface that should be implemented to pass object as Saver.registerScopeSaver parameter.

optionalgetDefaultSaves

getDefaultSaves?: DefaultSavesFunction

Function that returns default data to be passed to read if there is no previous data.

@since

2.3.1b116-3

read

read: ScopeLoadFunction

Function that loads data from saves scope.

save

save: ScopeSaveFunction

Function used to save data.

ObjectLoadFunction

• ObjectLoadFunction(obj: object): SaveableObjectType

• ---

  Parameters

  • obj: object

    object data from saves

  Returns SaveableObjectType

  Instance of newly instantiated object.

ObjectSaveFunction

• ObjectSaveFunction(instance: SaveableObjectType): object

• ---

  Parameters

  • instance: SaveableObjectType

    instance of your object to be saved

  Returns object

  Object data to be serialized in saves scope.

ScopeLoadFunction

• ScopeLoadFunction(scope: object): void

• Parameters

  • scope: object

    object data from saves

  Returns void

ScopeSaveFunction

• ScopeSaveFunction(): object

• ---

  Returns object

  Object data to be serialized in saves scope.

Type Aliases

SaveableObjectType

SaveableObjectType: object | org.json.JSONObject | IHashSaver

Functions

addSavesScope

• addSavesScope(name: string, load: ScopeLoadFunction, save: ScopeSaveFunction): void

• Creates saves scope, a universal data storage container. This storage container should be used whenever you need to save some data between world sessions. If you want to store primitives, use an object to wrap them.

  @example

  let thirst = 20;
  Saver.addSavesScope("thirst_library.thirst", 
      function read(scope) {
          thirst = scope ? scope.thirst : 20;
      },
      function save() {
          return { thirst: thirst };
      }
  );

  ---

  Parameters

  • name: string

    saves scope name

  • load: ScopeLoadFunction

    function used to load saved data

  • save: ScopeSaveFunction

    function used to save data

  Returns void

deserialize

• deserialize(obj: object): any

• Converts present serialized object via registered Saver.registerScopeSaver and Saver.registerObjectSaver recursively to instance hieracly.

  ---

  Parameters

  • obj: object

  Returns any

  Deserialized object instance hieracly.

deserializeFromString

• deserializeFromString(str: string): any

• Converts present transformed to string serialized object via registered Saver.registerScopeSaver and Saver.registerObjectSaver recursively to instance hieracly.

  ---

  Parameters

  • str: string

  Returns any

  Deserialized object instance hieracly.

registerObject

• registerObject(obj: SaveableObjectType, saverId: number): void

• Registers object to be saved with a given saver by identifier received from Saver.registerObjectSaver.

  ---

  Parameters

  • obj: SaveableObjectType

    target object instance

  • saverId: number

    to be used on saving

  Returns void

registerObjectSaver

• registerObjectSaver(name: string, saver: IObjectSaver): number

• Registers object as object instance saver.

  @example

  function PedestalTile(type) {
      this.type = type;
      Saver.registerObject(this, PedestalTile.saverId);
  }
  PedestalTile.saverId = Saver.registerObjectSaver("mystical_agriculture.pedestal", {
      read(obj) {
          return new PedestalTile(obj.type);
      },
      save(instance) {
          return { type: instance.type };
      }
  });

  ---

  Parameters

  • name: string

    saves scope name

  • saver: IObjectSaver

    object that implements Saver.IObjectSaver interface and can be loaded and saved via it's functions calls

  Returns number

  Saver identifier of your object instance.

registerScopeSaver

• registerScopeSaver(name: string, saver: IScopeSaver): void

• Registers object as scope saver.

  ---

  Parameters

  • name: string

    saves scope name

  • saver: IScopeSaver

    object that implements Saver.IScopeSaver interface and can be loaded and saved via it's functions calls

  Returns void

serialize

• serialize(obj: any): object

• Converts present object hieracly via registered Saver.registerScopeSaver and Saver.registerObjectSaver instances recursively to serialized data.

  ---

  Parameters

  • obj: any

  Returns object

  Serialized object hieracly.

serializeToString

• serializeToString(obj: any): string

• Converts present object hieracly via registered Saver.registerScopeSaver and Saver.registerObjectSaver instances recursively to serialized data.

  ---

  Parameters

  • obj: any

  Returns string

  Serialized object hieracly transformed to string.

setObjectIgnored

• setObjectIgnored(obj: object, ignore: boolean): void

• Changes registered via Saver.registerObject instance behavior to object be skippable or not.

  ---

  Parameters

  • obj: object

    target object instance

  • ignore: boolean

    should be skipped on saving

  Returns void