steed/doc/modules/prefs.txt
2011-02-28 09:04:59 +00:00

37 lines
1.5 KiB
Plaintext

====== Модуль Prefs ======
^ Подключение | require %%"%%prefs%%"%% |
^ Тип | расширение кода |
^ Зависимости | нет |
===== Описание =====
Этот модуль позволяет сохранять настройки игры. Другими словами, сохраненная информация не зависит от состояния игры.
Такой механизм можно использовать, например, для реализации системы достижений или счетчика количества прохождений игры.
prefs это объект, все переменные которого буду сохранены.
prefs:store() -- сохранить настройки.
prefs:purge() -- удалить все настройки.
Загрузка настроек выполняется автоматически при инициализации игры (перед вызовом функции init()), но вы можете инициировать загрузку и вручную:
prefs:load();
===== Примеры использования =====
<code lua>
instead_version "1.3.0"
require "click"
require "prefs"
prefs.counter = 0
game.click = function(s)
prefs.counter = prefs.counter + 1
prefs:store();
p("Кликов:", prefs.counter);
end
game.pic = 'clickme.png'
-- ...
</code>