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:43]
Alexander Yakovlev
en:api:core [2021/01/24 10:42] (current)
Line 11: 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 37: 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 43: 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 69: 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 144: Line 144:
  
 ==== goBack ==== ==== goBack ====
-Returns the player to ''N'' rooms back. It's not an UNDO, but a movement back in history.+Returns the player to ''N'' rooms back. It's not an UNDO command, but rather "go where I've been" command.
  
 ''N = 1'' is the current room. ''N = 1'' is the current room.
  • en/api/core.1481870635.txt.gz
  • Last modified: 2021/01/24 10:41
  • (external edit)