Class: RegistryOverlay

Extends

• core.Object

Methods

apply () async

registryoverlay.js:225

Applies all overlaid modifications to the underlying registry.

cancel () async

registryoverlay.js:250

Cancels and forgets about all overlaid modifications.

info (key)object async

registryoverlay.js:95

Returns information about the given key, or null if the key does not exist.

Name	Type	Description
key	string	The key to retrieve the information from.

Returns:

Type	Description
object	The information object { type, description }.

list (folderKey)Array.<string> async

registryoverlay.js:115

Lists the contents of the given folder key.

Name	Type	Description
folderKey	string	The key to list the contents of.

Returns:

Type	Description
Array.<string>	The names of the content items.

read (key, defaultValue)any async

registryoverlay.js:150

Reads the given key. Returns the defaultValue if the key was not found.

Name	Type	Description
key	string	The key to read.
defaultValue	any	The default value to return if the key was not found.

Returns:

Type	Description
any	The key's value.

remove (key) async

registryoverlay.js:202

Removes the given key.

Name	Type	Description
key	string	The key to remove.

write (key, value, description) async

registryoverlay.js:180

Writes the given key. If the key does not yet exist, it will be created.

Name	Type	Description
key	string	The key.
value	any	The value to write.
description	string	optional An optional description text.

Events

core.RegistryOverlay.event:changeValue

registryoverlay.js:69

Is triggered when the value of a key has changed.

Name	Type	Description
key	string	The key that was changed.