Twine Wiki

Site Tools

macro

This is an old revision of the document!

A macro is a piece of code that is inserted into passage text. Macros are used to accomplish many effects, such as altering the game's state, displaying different text depending on the game's state, and altering the manner in which text is displayed.

List of built-in macros

The following macros *control variables and text* in the story, or use them to alter the displayed passage text:

The following macros *display special text*, such as the contents of variables, or the text of another passage. They can provide powerful means of expression in a story.

The following macros create special kinds of links:

The following macro controls how its contained text is displayed, and can be useful when combined with other macros:

The following macros are not as useful as they were in previous versions of Twine, but remain for backwards-compatibility:

• «silently» (now supplanted by the «nobr» macro and the “nobr” passage tag.)
• «back» / «return» (now supplanted by the previous() function.)