ChapelR

Differences From Harlowe

There are many differences between Harlowe and SugarCube, this section will document some of the most critical you will need to account for if you're coming in to SugarCube from a background in Harlowe.

Macros

Aside from general syntax, SugarCube macros don't use hooks, separate arguments differently, and don't allow other macros to be passed as arguments into macros.

Container Macros

Where Harlowe uses hook syntax (brackets) to associate a macro with its contents, SugarCube instead uses 'container' macros; macros that can have content associated with them have opening and closing tags.

ChapelR

(function () {
    'use strict';

    var passageWeights = {};

    function weightedEither (test) {
        var passages;
        if (test) {
            passages = [].slice.call(arguments);
        } else {

ChapelR

Usage

Add the tag preserve-scroll to a passage.

ChapelR

Macro: <<css>>

Syntax

<<css selector propert value [property] [value] [etc...]>>

Arguments

• selector: the CSS/jQuery selector to an element on the page.
• porperty value pairs: pairs of CSS properties and the values you wish to set each to. Any number of pairs may be passed to the macro.

ChapelR

Add new tags to the system using tagImages().

Function: tagImages()

Assigns a tag to represent an image. Use with fg: and bg: tags (see below) to form layered background images from tags.

Syntax: tagImage(tagName, URL)

• tagName: the name of the tag to assign the image to.
• URL: the URL path to the image.

ChapelR

The articles macro set allows you to prepend words or phrases with the appropriate idenfitine article ("a" or "an").

<<A 'European man'>>.
It's been <<a 'honor'>>.

You can use this macro set for when you need to determine the correct article to use when generating, for example, random loot.

<<set _mats to either('iron', 'wooden', 'steel', 'adamantium', 'crystal')>>\
@@#output;You found <<a _mats>> sword!@@

ChapelR

/*
    the following `(function () {...}());` statement creates a local scope for our JavaScript code.
    this is called an IIFE, or "immediately invoked function expression". most langauges have block scoping,
    JS has function scoping. think of this as a way to get block scoping to prevent any of our stuff from
    polluting the global scope.
*/

(function () {

    /*

ChapelR

(function () {
    // transfer Harlowe data between stories via local storage

    var _state = State; // scope hack the state

    var storageKey = '%%twine-game-episode-transfer'; // change this to something with your story's title in it

    var hasStorage = (function () {
        return !!window.localStorage;
    }());

ChapelR

CSS:

#link-dock {
  /* base styles */
  position: fixed;
  left: 0; right: 0; top: 0;
  width: 100%;
  height: 6em;
  overflow: hide;
  border-bottom: 2px solid #555;

ChapelR

\<<widget 'tenth'>>
\    <span id="typewriter"></span>
\    <<set _textArrayLength to 0, _i to 0, _output to ''>>
\    <<repeat .1s>>
\        <<if _textArrayLength gte $args[_i].length>>
\            <<set _i++, _textArrayLength to 0>>
\            <<if _i gte $args.length>>
\                <<stop>>
\            <</if>>
\        <<set _output to _output + '<br />'>>