Options
All
  • Public
  • Public/Protected
  • All
Menu

A key that can be used to decrypt a save slot.

Hierarchy

  • SaveKey

Index

Constructors

constructor

  • new SaveKey(arg: Uint8Array | number): SaveKey
  • Construct a new save key from existing data or create an empty one.

    Parameters

    • arg: Uint8Array | number

      Existing key data or the generation for which to create an empty key

    Returns SaveKey

Accessors

blank

blank:

The blank Pokémon file for the save file.

boxKey1

boxKey1:

The first possible key for the boxes.

boxKey2

boxKey2:

The second possible key for the boxes.

boxOffset

boxOffset:

The offset that box data is stored in in the key file.

generation

generation:

The generation of the save file this key is for.

isNewKey

isNewKey:

Flag describing if this key is a new style key.

keyData

keyData:

The raw key data.

slot1Flag

slot1Flag:

The value a save file has at the slot 1 flag when data was saved to the first slot.

slot1Key

slot1Key:

The key describing the difference between the two save slots.

slotsUnlocked

slotsUnlocked:

stamp

stamp:

The stamp uniquely identifying the save file.

Methods

mergeKey

  • Merge the data from this save key with another save key. If the other key contains additional data it will be merged to this one. The other key will not be modified.

    Parameters

    • other: SaveKey

      Another save key for the same save file

    Returns void

persist

  • persist(): Promise<void>
  • Persist this key to the key store. This should be called everytime the key is updated.

    Returns Promise<void>

setKeyStore

  • Set the key store that manages this key. This method is called by the store and should not be used manually.

    Parameters

    Returns void

setStamp

  • setStamp(arr: Uint8Array): void
  • Set the raw stamp for this key.

    Parameters

    • arr: Uint8Array

      The raw stamp data

    Returns void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc