en:api:core

This is an old revision of the document!


FIXME This page is not fully translated, yet. Please help completing the translation.
(remove this paragraph once the translation is finished)

Salet core

The Salet class; the only instance of this class is automatically available as window.salet.

An instance of Character class, the game's playable character. Every property in this class that can be serialized (i.e. not functions) gets in the save.

Globally Unique ID of the game, arbitrary string. Manages the save slot. You must redefine this property in your game, or you'll be sharing the save slot with other games (and that will break all of these games).

Use UUIDs to avoid collisions.

Game version, arbitrary string. Also manages the save slot (each new version gets a new slot).

Automatic save flag.

If true, then Salet would save the game when entering every room that has canSave = true. true by default.

Automatic load flag.

If true, then Salet would automatically load the saved game on page load. If you set this to false it's implied you have your own interface to load the game, also see loadGame.

It's useful for all sorts of intro menus, where you don't want to continue right where the player left the game.

An instance of the Random class.

Time in seconds spent since start of the game. A floating point number.

A date in seconds when the game started. A floating point number, read as Unix time.

A regular expression that controls which links are considered internal.

By default a link is internal when it consists only of Latin letters, digits, dash and underscore signs: room or room.action or ./action.

ID of the current room, where the player is right now.

The flag that shows if Salet in in the interactive mode.

If it's true, the game is going on right now; if false, the game is loading (non-interactive mode). In non-interactive mode, all visual animations are skipped.

A system object; a stack of links that are not parsed yet.

A system object; all data to save. Contains the RNG seed seed, a sequence of visited links sequence, a sequence of visited rooms path and save time saveTime.

A system object; instance of the SaletView class.

ID of the room the player starts in, start by default

A system object; keeps all the game rooms.

A system property for all the game timers.

Функция, которая вызывается при начале игры. Её удобно переопределить в игре, чтобы выставить начальное состояние. (Это также можно делать в обработчиках входа enter начальной комнаты)

Функция, которая вызывается каждый раз при входе в какую-либо комнату перед тем, как вызывается обработчик enter новой комнаты.

Аргумент 1: ID старой комнаты

Аргумент 2: ID новой комнаты

Функция, которая вызывается каждый раз при входе в какую-либо комнату после того, как вход произошёл и текст уже выведен.

Аргумент 1: ID старой комнаты

Аргумент 2: ID новой комнаты

Функция, которая вызывается каждый раз перед выполнением какого-либо действия в комнате.

Если она возвращает true, то действие считается поглощённым, и обработчик действия в комнате не вызывается.

Аргумент 1: ID комнаты

Аргумент 2: ID действия

Функция, которая вызывается каждый раз после выполнения какого-либо действия в комнате.

Аргумент 1: ID комнаты

Аргумент 2: ID действия

Функция, которая вызывается каждый раз при выходе из какой-либо комнаты перед тем, как вызывается обработчик exit старой комнаты.

Аргумент 1: ID старой комнаты

Аргумент 2: ID новой комнаты

Системная функция, которая собирает список комнат по указанному тегу и фильтрует его по размеру. Вызывается при создании автосписков неявного выбора.

Аргумент 1: тег для фильтра

Аргумент 2: максимальная длина списка на выходе

Возвращает комнату, в которой находится игрок.

Возвращает ID сохранения.

Системная функция; обработчик ссылок.

Аргумент 1: адрес ссылки

Перемещает игрока в другую комнату. Синоним для processClick.

Аргумент: ID комнаты

Системная функция; обработчик одной ссылки.

Аргумент 1: адрес ссылки

Системная функция; обработчик одной ссылки.

Аргумент 1: адрес ссылки

Возврат на N комнат назад. Это не отмена, а именно движение назад по истории.

N = 1 — это текущая комната.

Аргумент: количество комнат для отмотки, по умолчанию 2

Системная функция; перемещение между комнатами.

Аргумент 1: ID новой комнаты

Аргумент 2: флаг форсированного перемешения (передаётся обработчикам), по умолчанию false

Показывает предупреждение "вы точно хотите очистить сохранение?". Если пользователь соглашается, то очищает сохранение.

Аргумент: флаг форсированной очистки (не показывает предупреждение), по умолчанию false

Возвращает массив комнат с указанным тегом.

Аргумент: тег для поиска

Сохранение игры.

Загрузка игры из данных сохранения.

Аргумент: данные сохранения

Функция, которая возвращает данные сохранения.

СИстемная функция; инициализирует Salet и начинает игру. Выполняет функцию init, загружает игру если найдено сохранение и выставлен флаг autoload.

Синоним для getCurrentRoom

Возвращает true, если игрок уже посетил указанную комнату.

Аргумент: ID комнаты

Функция добавляет таймер в игру. Таймер - это текст или функция, которая выполнится через несколько ходов. Ход - это каждый клик мышкой (действие в игре). Таймер может быть повторяемым (выполняется каждый ход номер step) или одноразовым (удаляется после первого срабатывания).

Аргумент 1: имя таймера. Обязательный.

Аргумент 2: действие таймера. Обязательный. Может быть строкой или функцией. Возвращаемое значение функции дописывается в главное окно игры.

Аргумент 3: флаг повторения. По умолчанию false.

Аргумент 4: количество ходов. По умолчанию 1.

Функция необратимо удаляет указанный таймер.

Аргумент: имя таймера

Функция сбрасывает указанный таймер.

Аргумент: имя таймера

Системная функция, проверяет и вызывает все установленные таймеры.

Вызывается после каждого клика в игре.

  • en/api/core.1481869047.txt.gz
  • Last modified: 2021/01/24 10:41
  • (external edit)