Harlowe

https://twine2.neocities.org/
Admin
Harlowe is a story format for Twine, a tool for creating interactive, nonlinear stories, with a...
Tokens:142,147
Snippets:1,902
Trust Score:10
Update:5 months ago
Show doc for...
Tokens:
Raw
### Example Macro Call for Replay

Source: https://twine2.neocities.org/

This is an example of a macro call that can be used to generate replay data. Replay data is only recorded when Debug Mode is enabled.

```harlowe
(if: 2 + 5 > (max: 3, 8))
```

--------------------------------

### Interlace Arrays Example

Source: https://twine2.neocities.org/

This example demonstrates the (interlaced:) macro, which pairs elements from multiple arrays. It shows how to combine arrays by taking the first element from each, then the second, and so on.

```twine
(interlaced: (a: 'A', 'B', 'C', 'D'), (a: 1, 2, 3))

```

--------------------------------

### Example Usage of (put:)

Source: https://twine2.neocities.org/

Demonstrates various ways to use the (put:) macro for variable assignment, including string concatenation, temporary variables, and typed variables.

```Harlowe
(put: "Save a " + $favouritefood + " for me!" into $battlecry)
```

```Harlowe
(put: $altitude - $enemyAltitude into _dist)
```

```Harlowe
(put: 0 into num-type $funds)
```

--------------------------------

### Example of click-append usage

Source: https://twine2.neocities.org/

Demonstrates how (click-append:) can be used to add supplementary content to a passage, written separately from the main prose.

```Harlowe
Ah. You remember her eldest well - [a frail, anxious child]<extra|. Unlikely to raise too much of a fuss.

(click-append: ?extra)[, constantly frowning, mumbling every word they utter, flinching at the slightest noise]


```

--------------------------------

### Folded Macro with Where Clause Example

Source: https://twine2.neocities.org/

Example of using a `where` clause with the `(folded:)` macro. The `where` clause now correctly applies to the accumulator and not the first value.

```Harlowe
_a making _b via _b + _a where _a's length > 5
```

--------------------------------

### Set and Print Variables

Source: https://twine2.neocities.org/

Demonstrates setting both normal ($) and temporary (_) variables and printing their contents directly in passage prose. Variables cannot start with a numeral.

```harlowe
(set: $plushieName to "Whispy", _heldItem to "briefcase")
Your beloved plushie, $plushieName, awaits you after a long work day.
You put your _heldItem down and lift it for a snuggle.
```

--------------------------------

### Checking Array Start and End Sequences

Source: https://twine2.neocities.org/

Use 'start' and 'end' data names with 'is' or 'is not' to check for specific sequences at the beginning or end of an array.

```Harlowe
$array's start is (a:2,4)
```

```Harlowe
$array's end is (a:3,6,9)
```

--------------------------------

### Iterate and Sum Enemy HP with (for:)

Source: https://twine2.neocities.org/

This example demonstrates using the (for:) macro to iterate through a list of enemies and sum their HP. It initializes an array of enemy datamaps and then calculates the total HP.

```twine
(set:$enemies to (a:(dm:"Name","Mossling", "HP",7), (dm:"Name","Moldling","HP",2)))
{(set:_allHP to 0)
(for: each _enemy, ...$enemies)[
    (set:_allHP to it + _enemy's HP)
]}
TOTAL HEART POINTS: _allHP



```

--------------------------------

### Using Named Colours

Source: https://twine2.neocities.org/

Examples of using built-in named colours like 'red', 'blue', and 'white' directly in macros.

```twine
(bg: red)
```

```twine
(text-colour: blue)
```

```twine
(bg: white)
```

--------------------------------

### Rerun Hook with Transition and Shuffle/Draw Link

Source: https://twine2.neocities.org/

This example shows how to use the (rerun:) macro to re-execute a hook, specified by its hook name (e.g., ?1), and apply a transition effect.

```twine
|1>[You drew a (either:...(range:2,10), "Jack", "Queen", "King", "Ace") of (either:"Hearts","Clubs","Spades","Diamonds").]
(link-rerun:"Shuffle and draw.")[(t8n:"dissolve")(rerun:?1)]
```

--------------------------------

### Example of show usage with link

Source: https://twine2.neocities.org/

Illustrates the typical usage of (show:) where the inserted text is a continuation of the passage's prose, written together with it. This pattern is simplified by (link-show:).

```Harlowe
"Look, it's important to comment even the simplest code...|extra)[ You might remember what it does now, but not at 4:50 PM on Friday \nafternoon, when you're about to push to production and a runtime error shows up in it.]"

You (link-reveal:"struggle to listen.")[(show: ?extra)]

```

--------------------------------

### Creating Colours with RGB

Source: https://twine2.neocities.org/

Example of creating a colour using the RGB macro. The values for red, green, and blue should be between 0 and 255.

```twine
(rgb: 255, 0, 0)
```

--------------------------------

### Using (folded:) with a 'making' lambda

Source: https://twine2.neocities.org/

This example details the usage of the (folded:) macro with a 'making' lambda. It explains how temporary variables are used and updated through the 'via' clause to accumulate a result.

```twine
(set:$enemies to (a:(dm:"Name","Mossling", "HP",7), (dm:"Name","Moldling","HP",2)))
(folded: _enemy making _allHP via _allHP + _enemy's HP, 0, ...$enemies)



```

--------------------------------

### Example Usage of Text Styling Markup

Source: https://twine2.neocities.org/

Demonstrates how to combine different text styling markup codes within passage text. Ensure nested styles are symmetrical.

```Harlowe
You //can't// be serious! I have to go through the ''whole game''
again? ^^Jeez, Louise!^^
```

--------------------------------

### Open Debug Mode Panel with (debug:)

Source: https://twine2.neocities.org/

This command opens the Debug Mode panel, regardless of whether the story initially started in debug mode. It takes no arguments.

```Harlowe
(debug:)
```

--------------------------------

### Store and Use (folded:) Lambda

Source: https://twine2.neocities.org/

This example demonstrates storing a (folded:) lambda in a variable for reuse. This allows the complex folding operation to be called with a simpler syntax later.

```twine
(set:$enemies to (a:(dm:"Name","Mossling", "HP",7), (dm:"Name","Moldling","HP",2)))
(set: $totalEnemyHP to (_enemy making _allHP via _allHP + _enemy's HP))
TOTAL HEART POINTS: (folded: $totalEnemyHP, 0, ...$enemies)



```

--------------------------------

### Pattern Matching with (p-many:)

Source: https://twine2.neocities.org/

Example of using the (p-many:) macro within a pattern to match repeated sequences of a datatype, followed by a literal character.

```twine
(p: (p-many:"A"), "!") matches "AAAAAAAA!"
```

--------------------------------

### Find digits or 'A' at the start of a string

Source: https://twine2.neocities.org/

Use (p-start:) with (str-find:) to search for a pattern (digits or 'A') only at the beginning of the string. Returns an array of matching digits or an empty array if no match.

```twine
(str-find: (p-start: (p-many:(p-either: digit, "A"))), _text)
```

--------------------------------

### Create a Changer with Prepending Text and Font

Source: https://twine2.neocities.org/

Use (prepend-with:) to add text to the start of a hook and combine it with other changers like (font:) to modify its appearance.

```twine
(set: $commandPrompt to (prepend-with:" >")+(font:"Courier"))
```

--------------------------------

### Replace (if:)/(else:) with (cond:) for simple assignments

Source: https://twine2.neocities.org/

This example demonstrates how to simplify conditional assignments using (cond:) instead of multiple (if:)/(else:) macros, making the code more concise.

```Harlowe
{(set:$lostTheSword to (either:true,false))
(if: not $lostTheSword)[
(set: $weapon to "a holy sword")
](else:)[
(set:$weapon to "an unholy swear-word")
]}
```

--------------------------------

### Create a Changer with Prepending Formatted Date and Location

Source: https://twine2.neocities.org/

This example demonstrates using (prepend-with:) with a code hook to prepend formatted text, including variables and HTML, to a hook.

```twine
(set: $dateStamp to (prepend-with:[**$location, $date.**<br>]))
```

--------------------------------

### Sum Enemy HP with (folded:)

Source: https://twine2.neocities.org/

This example shows a more concise way to sum enemy HP using the (folded:) macro. It achieves the same result as the (for:) loop in a single line.

```twine
(set:$enemies to (a:(dm:"Name","Mossling", "HP",7), (dm:"Name","Moldling","HP",2)))
TOTAL HEART POINTS: (folded: _enemy making _allHP via _allHP + _enemy's HP, 0, ...$enemies)



```

--------------------------------

### Executing Code on First Passage Load with 'startup' Tag

Source: https://twine2.neocities.org/

The 'startup' tag ensures a passage's content is included only in the very first passage of the game, ideal for initializing story-wide variables or setup code.

```Harlowe
startup
```

--------------------------------

### Get Day of Month - (monthday:)

Source: https://twine2.neocities.org/

Use this macro to get the current day of the month (1-31) from the player's system clock. Example: Display the current day of the month.

```twine
(monthday:)
```

--------------------------------

### Get Weekday Name - (weekday:)

Source: https://twine2.neocities.org/

Use this macro to get the current day of the week (e.g., 'Sunday', 'Monday') from the player's system clock. Example: Display the current day of the week.

```twine
(weekday:)
```

--------------------------------

### Create a Dataset with Initial Values

Source: https://twine2.neocities.org/

Create a dataset with initial string values by providing them as arguments to the (ds:) macro. The order of values does not matter.

```twine
(ds: "gold", "frankincense", "myrrh")
```

--------------------------------

### Equivalent (live:) implementation for (event:)

Source: https://twine2.neocities.org/

This example demonstrates how the functionality of the (event:) macro can be replicated using the (live:) macro combined with an (if:) condition and a (stop:) command. It shows the more verbose nature of this approach compared to using (event:).

```harlowe
(cycling-link: bind _recall, "Dennis?", "Denver?", "Denzel?", "Duncan?", "Danny?", "Denton?")
{(live: )[
		(if: time > 10s or _recall is 'Denton?')[
			No, you don't remember his name. [[Go east]].(stop: )
		]
]}
```

--------------------------------

### Get Typed Variable Datatype

Source: https://twine2.neocities.org/

Retrieves the datatype of a typed variable. For example, '(num-type _grains)' has the datatype 'num'.

```twine
(num-type _grains)'s datatype
```

--------------------------------

### Conditional Debug Initialization with 'debug-startup' Tag

Source: https://twine2.neocities.org/

Similar to the 'startup' tag, 'debug-startup' includes passage content only during debug mode, but specifically for the initial game load, useful for setting up late-game states for testing.

```Harlowe
debug-startup
```

--------------------------------

### Get Typed Variable Name

Source: https://twine2.neocities.org/

Retrieves the name of a typed variable. For example, '(num-type _grains)' has the name 'grains'.

```twine
(num-type _grains)'s name
```

--------------------------------

### Get Current Turn Count with `turns` Keyword

Source: https://twine2.neocities.org/

The `turns` keyword provides the current number of turns taken by the player. This is a reliable alternative to `(history:)'s length` after using (redirect:). Example: `(print: turns)`

```Harlowe
(print: turns)
```

--------------------------------

### Extract a subarray using start and end positions

Source: https://twine2.neocities.org/

The (subarray:) macro extracts elements from an array between specified start and end positions (inclusive). Negative numbers count from the end of the array. If the end position is less than the start, it still functions, returning elements from the start position onwards.

```harlowe
(subarray: $a, 3, 7)
```

```harlowe
(subarray: $a, 3, $b)
```

```harlowe
(subarray: (a:1,2,3,4), 4, 2)
```

--------------------------------

### Custom Commands in (source:)

Source: https://twine2.neocities.org/

Custom commands created with macros using (output:) can now be passed to (source:) and (v6m-source:).

```Harlowe
(source: (my-custom-command:))
(v6m-source: (my-custom-command:))
```

--------------------------------

### Create Live Content with live Macro

Source: https://twine2.neocities.org/

The (live:) macro makes a hook 'live', causing it to re-run repeatedly at a specified interval (e.g., 0.5 seconds). This is useful for dynamic content that updates automatically.

```harlowe
{(live: 0.5s)[
		(either: "Bang!", "Kaboom!", "Whammo!", "Pow!")
]}
```

--------------------------------

### Create a Partial Macro Call with (partial:)

Source: https://twine2.neocities.org/

Use (partial:) to create a macro that pre-fills arguments for another macro. This is useful for creating reusable macro variations. Example: `(set: $nextLink to (partial:"link-goto","==>"))`

```Harlowe
(set: $nextLink to (partial:"link-goto","==>"))
```

```Harlowe
($nextLink:"Laundry")
```

--------------------------------

### Basic 'matches' Operator Example

Source: https://twine2.neocities.org/

A fundamental example of the 'matches' operator, checking if an array of two numbers matches a pattern expecting two numbers.

```twine
(a:2,3) matches (a: num, num)
```

--------------------------------

### Enabling (background:) with Fractional Colors

Source: https://twine2.neocities.org/

Corrects an issue where `(background:)` did not function correctly when provided with a Harlowe color that had fractional `r`, `g`, or `b` datavalues.

```Harlowe
(background:)
```

--------------------------------

### Create an inclusive range of numbers with (range:)

Source: https://twine2.neocities.org/

Generates an array of whole numbers from a starting number to an ending number, inclusive. If the end number is smaller than the start, the order is reversed.

```twine
(range:1,14)
```

```twine
(range:2,-2)
```

--------------------------------

### Create a link that navigates to another passage

Source: https://twine2.neocities.org/

Use (link-goto:) to create a link that navigates to a specified passage. This macro allows for dynamic link text based on variables, unlike the standard link syntax.

```twine
(link-goto: "Enter the cellar", "Cellar")
```

```twine
(link-goto: "Cellar")
```

```twine
(link-goto: "Move " + $name + "to the cellar", "Cellar")
```

--------------------------------

### String Start and End Matching with (p-start:) and (p-end:)

Source: https://twine2.neocities.org/

String pattern macros that match only if the given values align with the start or end of a string. Effective when used with (str-find:), (str-replaced:), and (trimmed:).

```Harlowe
(p-start:)
```

```Harlowe
(p-end:)
```

--------------------------------

### Example of Invalid JavaScript in Harlowe Macro

Source: https://twine2.neocities.org/

Arbitrary JavaScript syntax embedded within Harlowe macro calls is no longer permitted and will produce an error. This example shows an invalid usage.

```harlowe
(if: (document.title = "Wowie") is 1)[]
```

--------------------------------

### Use command datatype

Source: https://twine2.neocities.org/

The `command` datatype now functions correctly. Previously, it was not supported.

```Harlowe
(set:$myCommand to (command: "print", "Hello"))
```

--------------------------------

### Get LCH Chroma Value

Source: https://twine2.neocities.org/

Retrieves the chroma value from an LCH colour definition.

```harlowe
(lch: 0.6, 80, 10)'s lch's c
```

--------------------------------

### Base-2 Logarithm (log2:)

Source: https://twine2.neocities.org/

Calculates the base-2 logarithm of a given number. Example: (log2: 256) produces 8.

```twine
(log2: 256)
```

--------------------------------

### Open URL in Browser with (open-url:)

Source: https://twine2.neocities.org/

Opens a given URL in the browser. Relative URLs are resolved based on the story's hosting location. This command does not support changers.

```harlowe
(open-url: "http://www.example.org/page2.html")
```

--------------------------------

### Base-10 Logarithm (log10:)

Source: https://twine2.neocities.org/

Calculates the base-10 logarithm of a given number. Example: (log10: 100) produces 2.

```twine
(log10: 100)
```

--------------------------------

### Redirecting and Counting Visits

Source: https://twine2.neocities.org/

Using (redirect:) to navigate to a passage counts as a visit for that passage, even if a new turn is not started.

```Harlowe
(redirect:)
```

--------------------------------

### The (transition-arrive:) macro

Source: https://twine2.neocities.org/

Controls the entry transition animation for passages. It can alter passage links, (link-goto:)s, and other links to change the fade-in animation.

```APIDOC
## The (transition-arrive:) macro

### Description
A changer that alters passage links, (link-goto:)s, and most every other kind of link, changing which passage fade-in animation the link uses.

### Example usage:
* `(t8n-arrive: "instant")[[Next morning]]` changes the `[[Next morning]]` link, such that clicking it takes you to the "Next morning" passage, which instantly pops in instead of slowly fading in as usual.
* `(enchant: ?Link, (t8n-arrive: "instant"))` causes ALL passage links to use the instant pop-in. This is best used in a "header" or "footer" tagged passage.

### Available Transitions:
This macro accepts the exact same transition names as (transition:).
* "instant" (causes the passage to instantly vanish)
* "dissolve" or "fade" (causes the passage to gently fade out)
* "flicker" (causes the passage to roughly flicker out - don't use with a long (transition-time:))
* "shudder" (causes the passage to disappear while shaking back and forth)
* "rumble" (causes the passage to instantly appear while shaking up and down)
* "slide-right" (causes the passage to slide in from left to right)
* "slide-left" (causes the passage to slide in from right to left)
* "slide-up" (causes the passage to slide in from bottom to top)
* "slide-down" (causes the passage to slide in from top to bottom)
* "fade-right" (causes the passage to gently fade in while sliding rightward)
* "fade-left" (causes the passage to gently fade in while sliding leftward)
* "fade-up" (causes the passage to gently fade in while sliding upward)
* "fade-down" (causes the passage to gently fade in while sliding downward)
* "pulse" (causes the passage to disappear while pulsating rapidly)
* "zoom" (causes the passage to scale up from the mouse pointer)
* "blur" (causes the passage to appear from a blur)

### Notes:
* Attaching this macro to a hook that isn't a passage link won't do anything (no error message will be produced).
* You can't combine transitions by adding them together, like you can with (text-style:) - `(t8n-depart:"dissolve")+(t8n-depart:"shudder")` won't make a transition that simultaneously dissolve-fades and shudders.
* The "blur" transition will not work in Internet Explorer 10 or 11.

### See also:
(transition-depart:)
```

--------------------------------

### The (debug:) Macro

Source: https://twine2.neocities.org/

A command that opens the Debug Mode panel, regardless of whether the story initially started in Debug Mode.

```APIDOC
## (debug:) Macro

### Description
This command, which takes no values, opens the Debug Mode panel if it wasn't open already. This can be used even if the story didn't begin in Debug Mode initially.

### Method
Command

### Endpoint
N/A (Macro)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```
(debug:)
```

### Response
#### Success Response (200)
None (opens the debug panel)

#### Response Example
None
```

--------------------------------

### Define a Typed Variable for a Number Array

Source: https://twine2.neocities.org/

This example defines a typed variable '$a' that can only be set to an array containing a single number.

```twine
(a: num)-type $a
```

--------------------------------

### Using (click-goto:) Macro

Source: https://twine2.neocities.org/

This macro turns a hook or text into a link to another passage. It is equivalent to (click: ?HookName)[(goto:'Passage Name')]. Passage transitions can be applied.

```twine
Time to get in your crimchair, plug in your crimphones, power up your crimrig and your crimgrip - the next page in your crimming career awaits.
(click-goto: "crim", "Test")

```

--------------------------------

### Item Is In Dataset Check (Array)

Source: https://twine2.neocities.org/

This example demonstrates checking if elements from an array are present in a dataset using the 'is in' operator.

```twine
(a:3,4) is in (ds:1,2,3)
```

--------------------------------

### Live Re-rendering with (live:) and (stop:)

Source: https://twine2.neocities.org/

Use (live:) to re-render a hook periodically. Include (stop:) within the hook to terminate the live updates when a condition is met, preventing unnecessary processing.

```harlowe
{(set:$packedBags to true)(live: 1s)[
		(if: $packedBags)[OK, let's go!(stop:)]
		(else: )[(either:"Are you ready yet?","We mustn't be late!")]
]}
```

--------------------------------

### Create Link to Passage with Side Effects

Source: https://twine2.neocities.org/

Use (link-reveal-goto:) to create a link that executes commands before navigating to a new passage. The first string is the link text, the second is the destination passage, and an optional changer styles the link.

```Harlowe
(link-reveal-goto: "Study English", "Afternoon 1")[(set:$eng to it + 1)]
```

```Harlowe
(link-reveal-goto: "Fight the King of England", "Death")[(dialog:"You asked for it!")]
```

--------------------------------

### Saving and Re-using Changers

Source: https://twine2.neocities.org/

Save changers into variables for repeated use. The example defines a font changer and applies it to text.

```twine
(set: $robotic to (font:'Courier New'))
$robotic[Hi, it's me. Your clanky, cold friend.]
```

--------------------------------

### Link Markup Examples in Harlowe

Source: https://twine2.neocities.org/

Demonstrates various ways to create hyperlinks in Harlowe passages. Links can specify text and destination passage, use shorthand, or incorporate variables and macros in the destination.

```harlowe
[[Go to the cellar->Cellar]] is a link that goes to a passage named "Cellar".
```

```harlowe
[[Parachuting<-Jump]] is a link that goes to a passage named "Parachuting".
```

```harlowe
[[Down the hatch]] is a link that goes to a passage named "Down the hatch".
```

```harlowe
[[A->B->C->D->E]] has a link text of "A->B->C->D" and a passage name of "E"
```

```harlowe
[[A<-B<-C<-D<-E]] has a link text of "B<-C<-D<-E" and a passage name of "A".
```

```harlowe
[[//Seagulls!//]] will link to the passage named "//Seagulls!//" if it exists, or the passage named "Seagulls!" if that exists.
```

```harlowe
[[Shelly?->$shellyPlace]] is a link that goes to the passage whose name is in the variable $shellyPlace.
```

```harlowe
[[Really, now.->(print:$explain)]] will cause an error.
```

```harlowe
(t8n-depart:"dissolve")[ [Recall that day] ] - or attach a variable containing one: $memory[[Recall that day]].
```

--------------------------------

### Square Root Calculation (sqrt:)

Source: https://twine2.neocities.org/

Calculates the square root of a given number. Example: (sqrt: 25) produces 5.

```twine
(sqrt: 25)
```

--------------------------------

### Natural Logarithm (log:)

Source: https://twine2.neocities.org/

Calculates the natural logarithm (base-e) of a given number. Example: (log: (exp:5)) produces 5.

```twine
(log: (exp:5))
```

--------------------------------

### Toggle Hook Visibility with (hide:) and (show:)

Source: https://twine2.neocities.org/

This example shows how to hide and show specific hooks using their identifiers. It's useful for creating interactive elements where content appears or disappears based on player actions, without re-running the hook's content.

```Harlowe
The exam paper sits before you.
|2>[(link-rerun:"Peek at palm")[(show:?1)(hide:?2)]]
|1)[It says:
(random:10,90)0m, (random:2,10)deg, 1/(either:2,3,4)
(link-rerun:"Hide palm")[(hide:?1)(show:?2)]]
```

--------------------------------

### Cosine Calculation (cos:)

Source: https://twine2.neocities.org/

Computes the cosine of a given number, which must be in radians. Example: (cos: 3.14159265) produces -1.

```twine
(cos: 3.14159265)
```

--------------------------------

### Using 'exits' with (print:)

Source: https://twine2.neocities.org/

Demonstrates how 'exits' counts elements that have already appeared. The (print:) macro will show 'false' if the link appears after it in the passage.

```Harlowe
(print: exits is 1) [[Retreat->Hall]]
```

--------------------------------

### Create a Gradient Background

Source: https://twine2.neocities.org/

Use the (gradient:) macro with an angle and color stops to create a dynamic background. The first argument is the angle, followed by pairs of percentage and color.

```harlowe
(set: $desertChrome to (gradient: 0, 0, #e6a860, 0.49, black, 0.5, white, 1, blue))
(background: $desertChrome)+(text-color:white)[Sunshine Desert]
```

--------------------------------

### The (transition-skip:) macro

Source: https://twine2.neocities.org/

Allows players to skip or accelerate transitions by holding down a key, mouse button, or by touching the screen.

```APIDOC
## The (transition-skip:) macro

### Description
A changer that, when added to a (transition:) changer, allows the player to skip or accelerate the transition by holding down a keyboard key or mouse button, or by touching the touch device.

### Example usage:
`(t8n:"slide-right")+(t8n-time:3s)+(t8n-skip:0.2s)[OK! I'm comin'!]` makes the text slide in from the right, but only after 3 seconds have passed... but if the player holds a key, mouse button, or the screen, it gets advanced by an additional 0.2 seconds each millisecond they hold.

### Rationale:
It's tempting to use transitions a lot in your story, but these can come at a cost to the player - watching and waiting for transitions to complete can be tiring and detrimental to your story's pacing, especially if they have to revisit certain parts of your story a lot. This macro can help by providing them with a means of skipping or accelerating the transitions if they so choose.
```

--------------------------------

### Getting the current date

Source: https://twine2.neocities.org/

The (current-date:) macro retrieves the current date from the player's system clock and formats it as a string.

```harlowe
(current-date:)
```

--------------------------------

### Sine Calculation (sin:)

Source: https://twine2.neocities.org/

Computes the sine of a given number, which must be in radians. Example: (sin: 3.14159265 / 2) produces 1.

```twine
(sin: 3.14159265 / 2)
```

--------------------------------

### Combine Restart Icon and Label

Source: https://twine2.neocities.org/

Combine a custom icon character with a text label using the (icon-restart:) macro. Both arguments must be strings.

```Harlowe
(icon-restart:"⟲", "Restart")
```

--------------------------------

### Power Calculation (pow:)

Source: https://twine2.neocities.org/

Raises the first number to the power of the second number. Example: (pow: 2, 8) produces 256.

```twine
(pow: 2, 8)
```

--------------------------------

### Getting the current time

Source: https://twine2.neocities.org/

The (current-time:) macro retrieves the current time from the player's system clock and formats it as a 12-hour string.

```harlowe
(current-time:)
```

--------------------------------

### Turn-Based Combat Engine in Harlowe

Source: https://twine2.neocities.org/

Implement a simple 1-vs-1 turn-based combat engine using Harlowe macros. This example demonstrates custom macros, temp variables, datamaps for opponents, and arrays for battle state.

```Harlowe
(click: ?page)[(click: ?page to only advance the story when the mouse is clicked)]
(macro "custom-macro" [code to run])
(set: _tempVar to 10)
(dm: "opponent" "name" "Goblin" "hp" 50 "attack" 5)
(a: "item1" "item2" "item3")
(move: $myArray to $newArray)
(rotated: $myArray)
```

--------------------------------

### Creating Substrings in TwineScript

Source: https://twine2.neocities.org/

Extract substrings by specifying a range of character positions. This can be done with an array of positions or a 'start to end' data name.

```twinescript
"Dogs"'s (a: 2,4)
```

```twinescript
"Ducks"'s 1stto3rd
```

```twinescript
"Rags"'s 2ndlasttolast
```

--------------------------------

### Twine 2 Transition Arrive Macro Example

Source: https://twine2.neocities.org/

The (transition-arrive:) macro modifies the entry animation for links. Clicking the link will cause the target passage to animate in using the specified transition. It can also be used with (enchant:) to affect all links.

```twine
(t8n-arrive: "instant")[[Next morning]]
```

```twine
(enchant: ?Link, (t8n-arrive: "instant"))
```

--------------------------------

### Replace 'Ben:' only at the start of a string

Source: https://twine2.neocities.org/

Use (p-start:) with (str-replaced:) to modify a string only if it begins with 'Ben:'. Other instances of 'Ben:' within the string are unaffected.

```twine
(str-replaced: (p-start:"Ben:"), "Former Ben:", _text)
```

--------------------------------

### Using Hooks with Macros for Text Modification

Source: https://twine2.neocities.org/

Demonstrates how to use square brackets to create a 'hook' in prose and attach macros to it. This is essential for applying text styles, conditional logic (like (if:)), and other dynamic changes to your story's text.

```harlowe
(set: $ringStolen to false)
(if: $ringStolen)[The ring, as expected, is gone.]
```

--------------------------------

### Create a Text Input Box with (input-box:)

Source: https://twine2.neocities.org/

Use this macro to create a text input field where players can type. The first argument defines the box's size and appearance, similar to (box:). An optional number specifies the height in text lines; if omitted, it defaults to 3 lines. The macro automatically applies CSS to prevent resizing.

```Harlowe
(input-box: "Type your name here")
```

```Harlowe
(input-box: "Enter a description" 5)
```

--------------------------------

### Dataset Type Check (Is not an)

Source: https://twine2.neocities.org/

Use 'is not an' to check if a value or collection is NOT of a specified datatype. This example checks if the left side is not an empty type.

```twine
(ds:2,3) is not an empty
```

--------------------------------

### Create a Datamap with Readable Layout

Source: https://twine2.neocities.org/

Use the (dm:) macro to create a datamap with names and values laid out for readability. Each name-value pair is on a new line.

```twine
(dm:
    "Susan", "A petite human in a yellow dress",
    "Tina", "A ten-foot lizardoid in a three-piece suit",
    "Gertie", "A griffin draped in a flowing cape",
)
```

--------------------------------

### Box Sizing with (box:)

Source: https://twine2.neocities.org/

Use the (box:) macro to create a visual container with a specified sizing line and optional height. The sizing line defines the horizontal proportions, and the height is given in text lines. Ensure the sizing string is valid and the height is a whole number.

```Harlowe
(box:"=XxxxXxxxXxxxX=", 0.25)
```

--------------------------------

### Absolute Value (abs:)

Source: https://twine2.neocities.org/

Calculates the absolute value of a number, returning the number without its sign. Example: (abs: -4) produces 4.

```twine
(abs: -4)
```

--------------------------------

### Styling Displayed Elements

Source: https://twine2.neocities.org/

Demonstrates how elements generated by macros like (display:), (print:), or (link:) can be styled using changers, similar to hooks.

```twine
(print: "Hello" + (colour: red))
```

--------------------------------

### Trim whitespace from the start of a string

Source: https://twine2.neocities.org/

Use (p-start:) with (trimmed:) to remove whitespace characters exclusively from the beginning of a string. Whitespace at the end of the string is preserved.

```twine
(trimmed: (p-start: whitespace), _text)
```

--------------------------------

### Initialize and Add to a Datamap

Source: https://twine2.neocities.org/

Initialize an empty datamap using (dm:) and then add new key-value pairs to it using the '+' operator with another (dm:) macro.

```twine
(set: $map to (dm:))
(set: $map to it + (dm: "Name 1", "Value 1", "Name 2", "Value 2"))
```

--------------------------------

### Initiate Turn-Based Combat

Source: https://twine2.neocities.org/The_Basics_of_TBC.html

Call this macro to start a turn-based combat sequence. It requires player and opponent stats, and the names of passages for winning and losing.

```Twee
($turnBasedCombat: _playerBaseStats, _allOpponents's Angy, "Win Room", "Lose Room")
```

```Twee
($turnBasedCombat: _playerBaseStats, _allOpponents's Foxy, "Win Room", "Lose Room")
```

```Twee
($turnBasedCombat: _playerBaseStats, _allOpponents's Moss, "Win Room", "Lose Room")
```

--------------------------------

### Create a fullscreen link

Source: https://twine2.neocities.org/

Use this macro to create a link that toggles fullscreen mode. Provide text for the link, the text for when fullscreen is off, and optional text for when fullscreen is unavailable.

```Harlowe
(link-fullscreen: "Turn fullscreen on", "Turn fullscreen off", "Fullscreen unavailable")
```

--------------------------------

### Sign of a Number (sign:)

Source: https://twine2.neocities.org/

Returns -1 for a negative number, 0 for zero, and 1 for a positive number. Example: (sign: -4) produces -1.

```twine
(sign: -4)
```

--------------------------------

### Twine 2 Transition Skip Macro Example

Source: https://twine2.neocities.org/

The (transition-skip:) macro allows players to accelerate transitions by holding a key or mouse button. It's useful for improving pacing in stories with frequent transitions. The value specifies how much to advance the transition per millisecond of input.

```twine
(t8n:"slide-right")+(t8n-time:3s)+(t8n-skip:0.2s)[OK! I'm comin'!] 
```

--------------------------------

### Move Value from Array Element

Source: https://twine2.neocities.org/

Example of using the (move:) macro to transfer a value from a specific element of an array to a variable, deleting the source value.

```Harlowe
(move: $arr's 1st into $var)
```
Tokens:
Raw