Class: Unlock

Unlock(options)

new Unlock(options)

Parameters:
Name Type Description
options UnlockJSOptions

Members

addCheat

Adds a cheatcode
See:
  • CheatCode.constructor for parameters

addShortcut

Adds a shortcut
See:
  • {@see Shortcut.constructor} for parameters

disable

Sets enabled to false, shorthand for Unlock#toggle(false)

enable

Sets enabled to true, shorthand for Unlock#toggle(true)

(readonly) enabled :boolean

Get enabled state
Type:
  • boolean

find

Finds a cheat created with Unlock by name

reset

Resets the current keys chain

toggle

Toggle the enabled state of the unlock object

Type Definitions

UnlockJSOptions

Properties:
Name Type Description
timeout number Duration before cheatcode timer resets,
resetOnMatch boolean Whether or not completing a cheatcode resets the timer