OptionManager

new OptionManager(appName, containerNameopt)

Предоставляет методы для сохранения и загрузки настроек игры из localStorage бразуера.
Хранит настройки по умолчанию.

Source:
Parameters:
Name Type Attributes Description
appName string

название приложения, вместе с containerName используется как ключ настроек в localStorage.
containerName string <optional>

название контейнера приложения (для нескольких приложений)

Members

defaults localStorageKey options

defaults :object

Настройки по умолчанию.

Source:

localStorageKey :string

Ключ настроек в localStorage.

Source:

options :object

Текущие настройки.

Source:

Methods

get getDefaults getGroup load restore restoreAll restoreAllDefaults restoreDefault restoreGroup restoreGroupDefaults save set setGroup

get(key) → {any}

Получает настройку.

Source:
Parameters:
Name Type Description
key string

ключ настройки
Returns:
Type:
any

Значение настройки.

getDefaults() → {object}

Возвращает настройки по умолчанию.

Source:
Returns:
Type:
object

getGroup(group) → {object}

Получает настройки определенной группы. Группа входит в ключ настройки: group_whatever.

Source:
Parameters:
Name Type Description
group string

название группы
Returns:
Type:
object

Возвращает объект со значениями настроек по ключу настроек без группы. group_whatever -> whatever

load() → {object}

Загружает настройки из localStorage браузера.
Догружает недостающие настройки из defaults.

Source:
Returns:
Type:
object

Загруженные настройки.

restore(key) → {any}

Восстанавливает настройку на ту, которая в данный момент находятся в localStorage.

Source:
Parameters:
Name Type Description
key string

ключ настройки
Returns:
Type:
any

Значение настройки в localStorage.

restoreAll()

Восстанавливает все настройки на те, которые в данный момент находятся в localStorage.

Source:

restoreAllDefaults()

Восстанавливает все настройки по умолчанию.

Source:

restoreDefault(key) → {any}

Восстанавливает настройку по умолчанию

Source:
Parameters:
Name Type Description
key string

ключ настройки
Returns:
Type:
any

Значение настройки по умолчанию.

restoreGroup(group) → {object}

Восстанавливает все настройки определенной группы на те, которые в данный момент находятся в localStorage.
Группа входит в ключ настройки: group_whatever.

Source:
Parameters:
Name Type Description
group string

название группы
Returns:
Type:
object

Возвращает объект со значениями настроек из localStorage по ключу настроек без группы. group_whatever -> whatever

restoreGroupDefaults(group) → {object}

Восстанавливает все настройки определенной группы по умолчанию.
Группа входит в ключ настройки: group_whatever.

Source:
Parameters:
Name Type Description
group string

название группы
Returns:
Type:
object

Возвращает объект со значениями настроек по умолчанию по ключу настроек без группы. group_whatever -> whatever

save()

Сохраняет настройки из options в localStorage браузера.
Необходимо использовать этот метод, чтобы измененные настройки сохранились после перезагрузки страницы.

Source:

set(key, value)

Устанавливает значение настройки.

Source:
Parameters:
Name Type Description
key string

ключ настройки
value any

значение настройки

setGroup(group, options)

Устанавливает настройки группы, прибавляя название группы к ключу настройки. group_whatever

Source:
Parameters:
Name Type Description
group string

название группы
options object

настройки по ключам без названия группы