en:api:core

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
en:api:core [2016/12/16 08:25]
Alexander Yakovlev
en:api:core [2016/12/16 10:01]
Alexander Yakovlev [goBack]
Line 1: Line 1:
-FIXME **This page is not fully translated, yet. Please help completing the translation.**\\ //(remove this paragraph once the translation is finished)// 
- 
 ====== Salet core ====== ====== Salet core ======
 The ''Salet'' class; the only instance of this class is automatically available as ''window.salet''. The ''Salet'' class; the only instance of this class is automatically available as ''window.salet''.
Line 13: Line 11:
  
 ==== game_version ==== ==== game_version ====
-Game version, arbitrary string. Also manages the save slot (each new version gets a new slot).+Game version, arbitrary string. It corresponds to the save slot too (each new version gets a new slot).
  
 ==== autosave ==== ==== autosave ====
Line 39: Line 37:
 A regular expression that controls which links are considered internal. 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''.+By defaulta link is internal when it consists only of Latin letters, digits, dash and underscore signs: ''room'' or ''room.action'' or ''./action''.
  
 ==== current ==== ==== current ====
Line 45: Line 43:
  
 ==== interactive ==== ==== interactive ====
-The flag that shows if Salet in in the interactive mode.+The flag that shows if Salet is 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. 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.
Line 71: Line 69:
 The function called at the start of the game. The function called at the start of the game.
  
-It's convenient to redefine in your game to initialize the game state. (You also can do that in the enter functions ''enter'' of the starting room)+It's convenient to redefine in your game to initialize the game state. (You also can do that in the on-entering callback ''enter'' of the starting room)
  
 ==== enter ==== ==== enter ====
Line 104: Line 102:
  
 ==== exit ==== ==== exit ====
-Функция, которая вызывается каждый раз при выходе из какой-либо комнаты перед тем, как вызывается обработчик ''exit'' старой комнаты.+The function called when the player exits any room before the ''exit'' handler of the old room is called.
  
-**Argument 1:** ID старой комнаты+**Argument 1:** old room'ID
  
-**Argument 2:** ID новой комнаты+**Argument 2:** new room'ID
  
 ==== getSituationIdChoices ==== ==== getSituationIdChoices ====
Line 118: Line 116:
  
 ==== getCurrentRoom ==== ==== getCurrentRoom ====
-Возвращает комнату, в которой находится игрок.+Returns a room (''SaletRoom'') where the player is. 
 + 
 +Aliases: ''[[#here]]''
  
 ==== getSaveId ==== ==== getSaveId ====
-Возвращает ID сохранения.+Returns ID of the save.
  
 ==== processLink ==== ==== processLink ====
-Системная функцияобработчик ссылок.+A system functionlink handler.
  
-**Argument 1:** адрес ссылки+**Argument 1:** link target
  
 ==== goTo ==== ==== goTo ====
-Перемещает игрока в другую комнатуСиноним для ''processClick''.+Moved the player to another roomAn alias for ''[[#processClick]]''.
  
-**Argument:** ID комнаты+**Argument:** room ID
  
 ==== processOneLink ==== ==== processOneLink ====
-Системная функцияобработчик одной ссылки.+A system functionprocesses one link.
  
-**Argument 1:** адрес ссылки+**Argument 1:** link target
  
 ==== processClick ==== ==== processClick ====
-Системная функцияобработчик одной ссылки.+A system functionprocesses one link.
  
-**Argument 1:** адрес ссылки+**Argument 1:** link target
  
 ==== goBack ==== ==== goBack ====
-Возврат на комнат назадЭто не отменаа именно движение назад по истории.+Returns the player to ''N'' rooms backIt's not an UNDO commandbut rather a "go where I've been" command.
  
-''N = 1'' — это текущая комната.+''N = 1'' is the current room.
  
-**Argument:** количество комнат для отмоткипо умолчанию ''2''+**Argument:** number of rooms to go back, ''2'' by default
  
 ==== doTransitionTo ==== ==== doTransitionTo ====
-Системная функцияперемещение между комнатами.+A system functionmovement between rooms.
  
-**Argument 1:** ID новой комнаты+**Argument 1:** new room ID
  
-**Argument 2:** флаг форсированного перемешения (передаётся обработчикам), по умолчанию ''false''+**Argument 2:** forced movement flag (passed to the handlers), ''false'' by default
  
 ==== eraseSave ==== ==== eraseSave ====
-Показывает предупреждение "вы точно хотите очистить сохранение?". Если пользователь соглашаетсято очищает сохранение.+Shows a warning "do you really want to erase the save?" If the player agreeserases the save and restarts the game.
  
-**Argument:** флаг форсированной очистки (не показывает предупреждение), по умолчанию ''false''+**Argument:** forced erase flag (skips the warning), ''false'' by default.
  
 ==== getRoomsTagged ==== ==== getRoomsTagged ====
-Возвращает массив комнат с указанным тегом.+Returns an array of rooms having the specified tag.
  
-**Argument:** тег для поиска+**Argument:** tag to search.
  
 ==== saveGame ==== ==== saveGame ====
Line 171: Line 171:
  
 ==== loadGame ==== ==== loadGame ====
-Загрузка игры из данных сохранения.+Loads the game from the save data.
  
-**Argument:** данные сохранения+**Argument:** save data
  
 ==== getSave ==== ==== getSave ====
Line 179: Line 179:
  
 ==== beginGame ==== ==== beginGame ====
-СИстемная функция; инициализирует Salet и начинает игруВыполняет функцию ''init'', загружает игру если найдено сохранение и выставлен флаг ''autoload''.+A system function that initializes Salet and begins the gameCalls the ''[[#init]]'' functionloads the game if the save is found and ''[[#autoload]]'' is on.
  
 ==== here ==== ==== here ====
-Синоним для ''getCurrentRoom''+An alias for ''[[#getCurrentRoom]]''
  
 ==== isVisited ==== ==== isVisited ====
-Возвращает ''true'', если игрок уже посетил указанную комнату.+Returns ''true'' if the player visited the specified room at least once.
  
-**Argument:** ID комнаты+**Argument:** room ID
  
 ==== addTimer ==== ==== addTimer ====
-Функция добавляет таймер в игру. Таймер - это текст или функция, которая выполнится через несколько ходов. Ход - это каждый клик мышкой (действие в игре). Таймер может быть повторяемым (выполняется каждый ход номер ''step'') или одноразовым (удаляется после первого срабатывания).+This function adds a timer in the game.
  
-**Argument 1:** имя таймераОбязательный.+Timer is a text or a function that will be called after several stepsStep is every click (in-game action).
  
-**Argument 2:** действие таймера. Обязательный. Может быть строкой или функцией. Возвращаемое значение функции дописывается в главное окно игры.+A timer can be repeatable (called every ''step'' number of steps) or one-time (is removed after the first call).
  
-**Argument 3:** флаг повторения. По умолчанию ''false''.+**Argument 1:** timer name, mandatory
  
-**Аргумент 4:** количество ходов. По умолчанию ''1''.+**Argument 2:** timer action, mandatory. Can be a string or a function. The value returned by the function is appended to the game text. 
 + 
 +**Argument 3:** repeatable flag, ''false'' by default. 
 + 
 +**Аргумент 4:** number of steps, ''1'' by default.
  
 ==== dropTimer ==== ==== dropTimer ====
-Функция необратимо удаляет указанный таймер.+The function drops the specified timer. This action cannot be undone.
  
-**Argument:** имя таймера+**Argument:** timer name
 ==== resetTimer ==== ==== resetTimer ====
-Функция сбрасывает указанный таймер.+Resets the specified timer.
  
-**Argument:** имя таймера+**Argument:** timer name
 ==== checkTimer ==== ==== checkTimer ====
-Системная функция, проверяет и вызывает все установленные таймеры. +A system function that checks and calls all game timers.
- +
-Вызывается после каждого клика в игре.+
  
 +Called after every click in the game.
  
 {{tag>api}} {{tag>api}}
  • en/api/core.txt
  • Last modified: 2021/01/24 10:42
  • (external edit)