twine2.neocities.orgHarlowe 3.1.0 manual

1.2.4 | 2.1.0 | 3.1.0 Introduction The Harlowe issues page has moved! Some of what’s new in 3.1 Passage markup basics Link Style coding Macro Variable Hook Named hook Hidden hook Unclosed hook extra HTML Verbatim list Bulleted list Numbered list section Aligner Column Heading Horizontal rule whitespace Whitespace Collapsing whitespace Escaped line break List of macros basics (set:) Instant (put:) Instant (move:) Instant (print:) Command (display:) Command (if:) Changer (unless:) Changer (else-if:) Changer (else:) Changer (for:) Changer (loop:) (either:) Any (cond:) Any (nth:) Any (enchant:) Command colour (gradient:) Gradient (hsl:) Colour (hsla:) (rgb:) Colour (rgba:) data structure (a:) Array (array:) (dm:) Datamap (datamap:) (ds:) Dataset (dataset:) (all-pass:) Boolean (altered:) Array (count:) Number (dataentries:) Array (datanames:) Array (datavalues:) Array (find:) Array (folded:) Any (interlaced:) Array (none-pass:) Boolean (range:) Array (repeated:) Array (reversed:) Array (rotated:) Array (shuffled:) Array (some-pass:) Boolean (sorted:) Array date and time (current-date:) String (current-time:) String (monthday:) Number (weekday:) String game state (history:) Array (passage:) Datamap (passages:) Array input (cycling-link:) Command (dropdown:) Command links (link:) Changer (link-replace:) (link-reveal:) Changer (link-repeat:) Changer (link-goto:) Command (link-reveal-goto:) Changer (link-show:) Command (link-undo:) Command (click:) Changer (click-replace:) Changer (click-append:) Changer (click-prepend:) Changer (click-goto:) Command (mouseover:) Changer (mouseover-replace:) Changer (mouseover-append:) Changer (mouseover-prepend:) Changer (mouseover-goto:) Command (mouseout:) Changer (mouseout-replace:) Changer (mouseout-append:) Changer (mouseout-prepend:) Changer (mouseout-goto:) Command (go-to:) Command (undo:) Command live (live:) Changer (stop:) Command (event:) Changer (more:) Changer maths (abs:) Number (cos:) Number (exp:) Number (log:) Number (log10:) Number (log2:) Number (max:) Number (min:) Number (pow:) Number (sign:) Number (sin:) Number (sqrt:) Number (tan:) Number number (ceil:) Number (floor:) Number (num:) Number (number:) (random:) Number (round:) Number popup (alert:) Command (confirm:) Boolean (prompt:) String revision (append:) Changer (prepend:) Changer (replace:) Changer saving (load-game:) Command (save-game:) Boolean (saved-games:) Datamap showing and hiding (hidden:) Changer (show:) Command string (lowercase:) String (lowerfirst:) String (str-repeated:) String (string-repeated:) (str-reversed:) String (string-reversed:) (str:) String (string:), (text:) (uppercase:) String (upperfirst:) String (words:) Array styling (align:) Changer (background:) Changer (css:) Changer (font:) Changer (hook:) Changer (hover-style:) Changer (text-colour:) Changer (colour:), (text-color:), (color:) (text-rotate:) Changer (text-style:) Changer transitions (transition:) Changer (t8n:) (transition-time:) Changer (t8n-time:) (transition-depart:) Changer (t8n-depart:) (transition-arrive:) Changer (t8n-arrive:) url (goto-url:) Command (open-url:) Command (page-url:) String (reload:) Command deprecated (substring:) String (subarray:) Array Special keywords exits Number exit it Any time Number visits Number visit Special passage tags header footer startup debug-header debug-footer debug-startup Types of data Any Array Bind Boolean Changer Colour Command Datamap Dataset Datatype Gradient HookName Instant Lambda Number String VariableToValue Change log 3.1.0 changes 3.0.2 changes Appendix Syntax comparison with SugarCube 1 Introduction The Harlowe issues page has moved! Harlowe’s source code and issues page has been forced to move to foss.heptapod.net , and the project’s issues page can now be found there, where you can submit your bug reports and feature requests. Big thanks to Octobus SAS for providing this free open-source software hosting service, and Clever Cloud SAS for that service’s hosting. Some of what’s new in 3.1 Harlowe 3.1, ostensibly a minor release of Harlowe, nonetheless has a surprising amount of new features, which are summarised as follows: New implementations of (alert:) , (confirm:) and (prompt:) that should work in more browsers and browser-like environments, and whose dialogs are customisable with CSS. The identifiers visits and exits . Special data names for hooks : ?hook’s links , ?hook’s chars and ?hook’s lines . Subarray and substring data names, such as $arr ’s 1stto3rd . New macros: (cond:) , (nth:) , (more:) , (passages:) and (gradient:) . Unclosed hook markup , a shorthand that you can use with changers. For a complete list of changes and outlines of how to use the above features, consult the change log section. Passage markup Link markup Hyperlinks are the player’s means of moving between passages and affecting the story. They consist of link text , which the player clicks on, and a passage name to send the player to. Inside matching non-nesting pairs of [[ and ]] , place the link text and the passage name, separated by either -or- , with the arrow pointing to the passage name. You can also write a shorthand form, where there is no- or -separator. The entire content is treated as a passage name, and its evaluation is treated as the link text. Example usage: [ [ Go to the cellar -C e l l a r ] ] is a link that goes to a passage named "Cellar". [ [ P a r a c h u t i n g- Jump ] ] is a link that goes to a passage named "Parachuting". [ [ Down the hatch ] ] is a link that goes to a passage named "Down the hatch". Details: The interior of a link (the text between [[ and ]] ) may contain any character except ] . If additional -s or- s appear, the rightmost right arrow or leftmost left arrow is regarded as the canonical separator. [ [ A -B -C -D -E ] ] has a link text of "A-B-C-D" and a passage name of "E" [ [ A- B- C- D- E ] ] has a link text of "B-C-D-E" and a passage name of "A". If the passage name of a link does not exactly match that of an existing passage, but it does if you render the markup in or around it, then Harlowe will use that name. So, you can put markup inside the link, as well as variables or value macros like (either:) . [ [ / / Seagulls! / / ] ] will link to the passage named "//Seagulls!//" if it exists, or the passage named "Seagulls!" if that exists. [ [ Shelly? -$ s h e l l y P l a c e ] ] is a link that goes to the passage whose name is in the variable $shellyPlace . However, you can’t put commands or changers in the passage name. [ [ Really , now. -( p r i n t : $ e x p l a i n ) ] ] will cause an error. Links can be customised by attaching changer macros, like (transition-depart:) or (text-style:) . Just place one in front of the link, like so: ( t8n-depart: " dissolve " ) [ [ Recall that day ] ] - or attach a variable containing one: $memory [ [ Recall that day ] ] . You can also customise every link in the passage using (enchant:) and ?Link. This syntax is not the only way to create links – there are many link macros, such as (link:), which can be used to make more versatile hyperlinks in your story. Style markup Often, you’d like to apply styles to your text – to italicize a book title, for example. You can do this with simple formatting codes that are similar to the double brackets of a link. Here is what’s available to you: Styling Markup code Result HTML produced Italics / / text / / textitext/ iBoldface ’’ text ’’ textbtext/ bStrikethrough text ~~text~~ textstext/ sEmphasis * text * textemtext/ emStrong emphasis * * text * * textstr ongtext/ str ongSuperscript meters / second^^ 2 ^^ meters/second 2 meters / secondsup2/ supExample usage: You / / can’t / / be serious! I have to go through the ’ ’ whole game ’...