Returns the number of turns that have passed since the last instance of the passage with the given title occurred within the story history or -1 if it does not exist.
Warning:
VIDEO Returns whether any of the given members were found within the array. The links go to the most recent release versions of each in SugarCube's source code repository.
As an example, the default replacement strings make use of this to handle various warning intros and outros. Navigation events allow the execution of JavaScript code at specific points during passage navigation. Returns the total number (count) of played turns currently in effecti.e., the number of played moments up to the present moment; future (rewound/undone) moments are not included within the total. Calling the State.prng.init() methodformerly History.initPRNG()outside of story initialization will now throw an error. There's no way for the system to know ahead of time whether it's safe to re-execute a passage's contents.
Iterates through all enumerable entries of the given collection. They are defined via the Template API. Both of these features can be constructed in SugarCube, however, using macros like <
> or by combining <>/<> macros, so that authors don't have to resort to various kludges to get whitespace where they want it. > macro for its replacement. The starting passage, the first passage displayed. The story history contains moments (states) created during play. Note: Note: Though, using SugarCube global is most definitely the wrong way. .off() in the jQuery API docs for more information. > macro will have side effects. Note: VIDEO Removes and returns a random member from the base array. >, into a group via its <> children. Create a save, then edit the code as follows: Running that, you'll see $x is 0 and $y is 1. You can set the autosave to save either on every passage or only on certain passages. The (execution) context object of the macro's parent, or null if the macro has no parent. The document element. > to run code, <> to set variables. For example: A better solution, however, would be to use a backquote1 (`) expression, which is really just a special form of quoting available in macro arguments that causes the contents of the backquotes to be evaluated and then yields the result as a singular argument. >. > for more information. All properties of Passage objects should be treated as if they were read-only, as modifying them could result in unexpected behavior. The JSON.reviveWrapper() method for additional information on implementing the .toJSON() method. >. > and <>, if any <> definitions used the copy keyword, for which you want the loading screen displayed. > macro, any story or other temporary variables used within widgets are part of a story's normal variable store, so care must be taken not to accidentally either overwrite or pick up an existing value. >, save that it also encodes HTML special characters in the output. Global event triggered once just before the dismissal of the loading screen at startup. To simply add a delay to the dismissal of the loading screen to hide initial flashes of unstyled content (FOUC)e.g., style changes and page reflowsyou do not need to use this API. .hasData() method is generally more useful. >. > macro, but are run each time passage navigation occurs. > are in the reverse order (link then text). Note: >the deprecated <> may be used instead, though it is not recommended. To install the package via NPM, use the following command: This is a reference on how to install SugarCube in Tweego, Twine2, and Twine1/Twee. > macro instance to finish typing its content immediately. > as there are often better and easier ways to forward the player.