{"id":772,"date":"2024-06-10T13:24:40","date_gmt":"2024-06-10T13:24:40","guid":{"rendered":"https:\/\/x-change.life\/wiki\/?post_type=docs&p=772"},"modified":"2025-06-26T20:30:42","modified_gmt":"2025-06-26T20:30:42","slug":"custom-x-change-life-macros-you-can-use-in-mods","status":"publish","type":"docs","link":"https:\/\/x-change.life\/wiki\/docs\/custom-x-change-life-macros-you-can-use-in-mods\/","title":{"rendered":"Custom X-Change Life macros you can use in mods"},"content":{"rendered":"\n

Javascript Macros<\/h2>\n\n\n\n

X-Change Life uses a customized version of the Twine Harlowe engine. The following custom macros are for modders – these are some macros we have added to Twine Harlowe in order to extend its functionality. <\/p>\n\n\n\n

1. average<\/code><\/h3>\n\n\n\n

Function:<\/strong> Calculates the average of a series of numbers.
Usage:<\/strong><\/p>\n\n\n\n

(set: $avg to (average: 1, 2, 3, 4, 5))  <!-- $avg will be 3 --><\/code><\/pre>\n\n\n\n
2. rnd<\/code><\/h3>\n\n\n\n
Function:<\/strong> Rounds a number to a specified precision.
Usage:<\/strong><\/p>\n\n\n\n
(set: $rounded to (rnd: 3.14159, 2))  <!-- $rounded will be 3.14 --><\/code><\/pre>\n\n\n\n
3. indexof<\/code><\/h3>\n\n\n\n
Function:<\/strong> Finds the 1-based index of an item in an array. Returns -1 if the item is not found.
Usage:<\/strong><\/p>\n\n\n\n
(set: $index to (indexof: (a: \"apple\", \"banana\", \"cherry\"), \"banana\"))  <!-- $index will be 2 --><\/code><\/pre>\n\n\n\n
4. intersection<\/code><\/h3>\n\n\n\n
Function:<\/strong> Calculates the intersection of two arrays, returning their common elements.
Usage:<\/strong><\/p>\n\n\n\n
(set: $common to (intersection: (a: \"apple\", \"banana\"), (a: \"banana\", \"cherry\")))  <!-- $common will be (a: \"banana\") --><\/code><\/pre>\n\n\n\n
5. savegameto<\/code><\/h3>\n\n\n\n
Function:<\/strong> Saves the game to the specified slot name.
Usage:<\/strong><\/p>\n\n\n\n
(savegameto: \"slot1\")  <!-- Saves the game to slot \"slot1\" --><\/code><\/pre>\n\n\n\n
6. win<\/code><\/h3>\n\n\n\n
Function:<\/strong> Checks if the variable $result<\/code> is “pass”.
Usage:<\/strong><\/p>\n\n\n\n
(set: $result to \"pass\")\n(set: $didWin to (win:))  <!-- $didWin will be true --><\/code><\/pre>\n\n\n\n
7. is_fem<\/code><\/h3>\n\n\n\n
Function:<\/strong> Checks if the character’s gender is female.
Usage:<\/strong><\/p>\n\n\n\n
(set: $character to (dm: \"gender\", \"female\"))\n(set: $isFemale to (is_fem:))  <!-- $isFemale will be true --><\/code><\/pre>\n\n\n\n
8. is_male<\/code><\/h3>\n\n\n\n
Function:<\/strong> Checks if the character’s gender is male.
Usage:<\/strong><\/p>\n\n\n\n
(set: $character to (dm: \"gender\", \"male\"))\n(set: $isMale to (is_male:))  <!-- $isMale will be true --><\/code><\/pre>\n\n\n\n
9. is_preg<\/code><\/h3>\n\n\n\n
Function:<\/strong> Checks if the character is pregnant.
Usage:<\/strong><\/p>\n\n\n\n
(set: $character to (dm: \"pregnant\", \"true\"))\n(set: $isPregnant to (is_preg:))  <!-- $isPregnant will be true --><\/code><\/pre>\n\n\n\n
10. knows_preg<\/code><\/h3>\n\n\n\n
Function:<\/strong> Checks if the character’s pregnancy is known.
Usage:<\/strong><\/p>\n\n\n\n
(set: $character to (dm: \"pregnancy known\", \"true\"))\n(set: $knowsPregnancy to (knows_preg:))  <!-- $knowsPregnancy will be true --><\/code><\/pre>\n\n\n\n
11. is_bim<\/code><\/h3>\n\n\n\n
Function:<\/strong> Checks if the character has the “bimbo” side effect.
Usage:<\/strong><\/p>\n\n\n\n
(set: $character to (dm: \"side effects\", (a: \"bimbo\")))\n(set: $isBimbo to (is_bim:))  <!-- $isBimbo will be true --><\/code><\/pre>\n\n\n\n
12. is_pp<\/code><\/h3>\n\n\n\n
Function:<\/strong> Checks if the character has the “people pleaser” side effect.
Usage:<\/strong><\/p>\n\n\n\n
(set: $character to (dm: \"side effects\", (a: \"people pleaser\")))\n(set: $isPeoplePleaser to (is_pp:))  <!-- $isPeoplePleaser will be true --><\/code><\/pre>\n\n\n\n
13. pill<\/code><\/h3>\n\n\n\n
Function:<\/strong> Checks if the value of $pill_taken<\/code> matches the provided pill name (case-insensitive).
Usage:<\/strong><\/p>\n\n\n\n
(set: $pill_taken to \"Cum-Cure\")\n(set: $isCumCure to (pill: \"cum-cure\"))  <!-- $isCumCure will be true --><\/code><\/pre>\n\n\n\n
14. clamp<\/code><\/h3>\n\n\n\n
Function:<\/strong> Clamps a number within a specified range.
Usage:<\/strong><\/p>\n\n\n\n
(set: $clampedValue to (clamp: 15, 10, 20))  <!-- $clampedValue will be 15 -->\n(set: $clampedValue to (clamp: 25, 10, 20))  <!-- $clampedValue will be 20 --><\/code><\/pre>\n\n\n\n
15. currency<\/code><\/h3>\n\n\n\n
Function:<\/strong> Formats a number as currency (USD) without cents.
Usage:<\/strong><\/p>\n\n\n\n
(set: $formattedCurrency to (currency: 1234))  <!-- $formattedCurrency will be \"$1,234\" --><\/code><\/pre>\n\n\n\n
16. del<\/code><\/h3>\n\n\n\n
Function:<\/strong> Deletes the specified variables.
Usage:<\/strong><\/p>\n\n\n\n
(del: \"$variable1\", \"$variable2\")  <!-- Deletes $variable1 and $variable2 --><\/code><\/pre>\n\n\n\n
17. outfitdb<\/code><\/h3>\n\n\n\n
Function:<\/strong> Retrieves a list of outfits for a specified character, optionally filtered by outfit IDs.
Usage:<\/strong><\/p>\n\n\n\n
(set: $outfits to (outfitdb: \"characterName\"))  <!-- Retrieves all outfits for \"characterName\" -->\n(set: $filteredOutfits to (outfitdb: \"characterName\", (a: \"outfit1\", \"outfit2\")))  <!-- Retrieves specific outfits for \"characterName\" --><\/code><\/pre>\n\n\n\n
18. getoutfit<\/code><\/h3>\n\n\n\n
Function:<\/strong> Retrieves details of a specific outfit by its ID.
Usage:<\/strong><\/p>\n\n\n\n
(set: $outfitDetails to (getoutfit: \"characterName category outfitName\"))  <!-- Retrieves details of the specified outfit --><\/code><\/pre>\n\n\n\n
19. checkdm<\/code><\/h3>\n\n\n\n
Function:<\/strong> Checks if a datamap contains a specified value based on an operation.
Usage:<\/strong><\/p>\n\n\n\n
(set: $dm to (dm: \"key1\", \"value1\", \"key2\", (a: \"value2\", \"value3\")))\n(set: $result1 to (checkdm: $dm, \"key1\", \"is\", \"value1\"))  <!-- $result1 will be true -->\n(set: $result2 to (checkdm: $dm, \"key2\", \"contains\", \"value2\"))  <!-- $result2 will be true --><\/code><\/pre>\n\n\n\n
20. newseed<\/code><\/h3>\n\n\n\n
Function:<\/strong> Generates a new seed based on the current time.
Usage:<\/strong><\/p>\n\n\n\n
(set: $seed to (newseed:))  <!-- Generates a seed string based on the current time --><\/code><\/pre>\n\n\n\n
21. clearstandardvars<\/code><\/h3>\n\n\n\n
Function:<\/strong> Clears standard variables.
Usage:<\/strong><\/p>\n\n\n\n
(clearstandardvars:)  <!-- Clears standard variables --><\/code><\/pre>\n\n\n\n
22. twist<\/code><\/h3>\n\n\n\n
Function:<\/strong> Generates a random integer between a specified minimum and maximum value (inclusive) using the Mersenne Twister algorithm.
Usage:<\/strong><\/p>\n\n\n\n
(set: $randomNumber to (twist: 1, 10))  <!-- Generates a random number between 1 and 10 using Mersenne Twister algorithm --><\/code><\/pre>\n\n\n\n
Note:<\/strong> This macro uses the Mersenne Twister algorithm, which provides a higher degree of randomness compared to Harlowe’s native randomness functions.<\/p>\n\n\n\n
23. twirl<\/code><\/h3>\n\n\n\n
Function:<\/strong> Picks a random value from a list of arguments using the Mersenne Twister algorithm.
Usage:<\/strong><\/p>\n\n\n\n
(set: $randomValue to (twirl: \"apple\", \"banana\", \"cherry\"))  <!-- Picks a random fruit from the list using Mersenne Twister algorithm --><\/code><\/pre>\n\n\n\n
Note:<\/strong> This macro uses the Mersenne Twister algorithm, which provides a higher degree of randomness compared to Harlowe’s native randomness functions.<\/p>\n\n\n\n
24. twisted<\/code><\/h3>\n\n\n\n
Function:<\/strong> Shuffles an array using the Fisher-Yates algorithm with the Mersenne Twister algorithm for randomness.
Usage:<\/strong><\/p>\n\n\n\n
(set: $shuffledArray to (twisted: (a: \"apple\", \"banana\", \"cherry\")))  <!-- Shuffles the array using Fisher-Yates algorithm with Mersenne Twister algorithm --><\/code><\/pre>\n\n\n\n
Note:<\/strong> This macro uses the Mersenne Twister algorithm, which provides a higher degree of randomness compared to Harlowe’s native randomness functions.<\/p>\n\n\n\n
25. remove<\/code><\/h3>\n\n\n\n
Function:<\/strong> Removes a specified number of occurrences of an item from an array.
Usage:<\/strong><\/p>\n\n\n\n
(set: $originalArray to (a: \"apple\", \"banana\", \"cherry\", \"apple\"))\n(set: $modifiedArray to (remove: $originalArray, \"apple\", 1))  <!-- Removes one occurrence of \"apple\" --><\/code><\/pre>\n\n\n\n
<\/p>\n\n\n\n
Harlowe Macros<\/h2>\n\n\n\n
There are custom harlowe macros that you can also use. These are slightly different than the ones above since they perform native harlowe functions, opposed to the ones above that do background things in javascript. These are usually utility macros that shorten other functions or allows you to cut out repeated tasks.<\/p>\n\n\n\n
\ud83c\udfa5 Media & Visuals<\/h2>\n\n\n\n
$pic<\/code><\/h3>\n\n\n\n
Parameters:<\/strong>
(str) image_path<\/code>, (str) position = \"left\"<\/code>, (str) css_class = \"small\"<\/code><\/p>\n\n\n\n
Function:<\/strong>
Displays an image from the img\/<\/code> folder. Optional parameters adjust position and CSS class. \"small\"<\/code> sets width to 50%.<\/p>\n\n\n\n
Usage Examples:<\/strong><\/p>\n\n\n\n
($pic:\"places\/gym\/locker room.jpg\") <\/code>($pic:\"places\/gym\/locker room.jpg\",\"left\") <\/code>($pic:\"places\/gym\/locker room.jpg\",\"right\",\"small\")<\/code><\/code><\/pre>\n\n\n\n
<\/p>\n\n\n\n
\n\n\n\n
$vid<\/code><\/h3>\n\n\n\n
Parameters:<\/strong>
(str) video_path<\/code>, (str) position = \"left\"<\/code><\/p>\n\n\n\n
Function:<\/strong>
Embeds an autoplaying, looping video with mute behavior determined by $audio_toggle<\/code>. Optional \"left\"<\/code> or \"right\"<\/code> positions it using top_left_pic<\/code> or top_right_pic<\/code>.<\/p>\n\n\n\n
Usage Examples:<\/strong><\/p>\n\n\n\n
($vid:\"scenes\/characters\/jade\/sex\/workout\/02 get towel.mp4\") <\/code>($vid:\"scenes\/characters\/jade\/sex\/workout\/02 get towel.mp4\",\"left\")<\/code><\/code><\/pre>\n\n\n\n
\n\n\n\n
\ud83d\uddbc Display & Styling<\/h2>\n\n\n\n
$centered<\/code><\/h3>\n\n\n\n
Parameters:<\/strong>
(codehook) _content<\/code><\/p>\n\n\n\n
Function:<\/strong>
Wraps content in a centered <div class='options'><\/code> block. Used to center text or UI blocks visually.<\/p>\n\n\n\n
Usage Examples:<\/strong><\/p>\n\n\n\n
($centered: [\"You feel warm and slutty inside.\"]) <\/code>($centered: [(print:\"<b>Warning:<\/b> You're being watched.\")])<\/code><\/code><\/pre>\n\n\n\n
\n\n\n\n
$highlight<\/code><\/h3>\n\n\n\n
Parameters:<\/strong>
(codehook) _content<\/code><\/p>\n\n\n\n
Function:<\/strong>
Displays the content inside a <span class='highlight'><\/code>, useful for drawing attention to text.<\/p>\n\n\n\n
Usage Examples:<\/strong><\/p>\n\n\n\n
($highlight: [\"Objective Updated!\"]) <\/code>($highlight: [(print:$her_name + \" seems impressed.\")])<\/code><\/code><\/pre>\n\n\n\n
\n\n\n\n
$shadow<\/code><\/h3>\n\n\n\n
Parameters:<\/strong>
(codehook) _content<\/code><\/p>\n\n\n\n
Function:<\/strong>
Displays the content inside a <span class='shadow'><\/code> for stylized text with a drop-shadow effect.<\/p>\n\n\n\n
Usage Examples:<\/strong><\/p>\n\n\n\n
($shadow: [\"Your heart skips a beat.\"]) <\/code>($shadow: [(print:\"Round \" + $round_number)])<\/code><\/code><\/pre>\n\n\n\n
\n\n\n\n
$bimbo<\/code><\/h3>\n\n\n\n
Parameters:<\/strong>
(codehook) _content<\/code><\/p>\n\n\n\n
Function:<\/strong>
Wraps the content in a <span class='bimbo'><\/code> and centers it in a <div class='options'><\/code>. Used for bimbo-styled thoughts or narration.<\/p>\n\n\n\n
Usage Examples:<\/strong><\/p>\n\n\n\n
($bimbo: [\"Like, I dunno what that means... but it sounds sexy! \ud83d\udc8b\"]) <\/code>($bimbo: [(print:\"Ughhh... math is, like, soooo hard!\")])<\/code><\/code><\/pre>\n\n\n\n
\n\n\n\n
$bimbo_dialogue<\/code><\/h3>\n\n\n\n
Parameters:<\/strong>
(codehook) _content<\/code><\/p>\n\n\n\n
Function:<\/strong>
Displays the content as bimbo-styled dialogue wrapped in quotation marks so you don’t have to add them.<\/p>\n\n\n\n
Usage Examples:<\/strong><\/p>\n\n\n\n
($bimbo_dialogue: [Omigod, did you, like, feel that too?])<\/code>\n($bimbo_dialogue: [(twirl:<\/code>\"This is like, so totally embarrassing... *nervous giggle*\",<\/span><\/code>\"Omigosh, I'm like, so sorry! Was I using too much teeth? My jaw's just sooo tiny compared to your huge-\")])<\/span><\/code><\/code><\/pre>\n\n\n\n
\n\n\n\n
$heading<\/code><\/h3>\n\n\n\n
Parameters:<\/strong>
(str) _text<\/code><\/p>\n\n\n\n
Function:<\/strong>
Displays _text<\/code> in a large heading styled using the palette color, with a shadow effect.<\/p>\n\n\n\n
Usage Examples:<\/strong><\/p>\n\n\n\n
($heading: \"New Objective\") <\/code>($heading: \"Alexia\u2019s Bedroom\")<\/code><\/code><\/pre>\n\n\n\n
\n\n\n\n
$notification<\/code><\/h3>\n\n\n\n
Parameters:<\/strong>
(str) _message<\/code><\/p>\n\n\n\n
Function:<\/strong>
Displays _message<\/code> inside a <mark><\/code> block that fades in and out automatically.<\/p>\n\n\n\n
Usage Examples:<\/strong><\/p>\n\n\n\n
($notification: \"You gained 1 charm.\")<\/code>($notification: \"Your outfit is now dirty.\")<\/code><\/code><\/pre>\n\n\n\n
\n\n\n\n
$notification_still<\/code><\/h3>\n\n\n\n
Parameters:<\/strong>
(str) _message<\/code><\/p>\n\n\n\n
Function:<\/strong>
Displays _message<\/code> inside a non-animated <mark><\/code> block. Remains visible until removed by logic.<\/p>\n\n\n\n
Usage Examples:<\/strong><\/p>\n\n\n\n
($notification_still: \"Your makeup has worn off.\") <\/code>($notification_still: \"You have unread messages.\")<\/code><\/code><\/pre>\n\n\n\n
\n\n\n\n
\ud83d\udd0a Audio & Sound Control<\/h2>\n\n\n\n
\n\n\n\n
$play<\/code><\/h3>\n\n\n\n
Parameters:<\/strong>
(any) type<\/code>, (str) track<\/code>, (str) delay = \"none\"<\/code><\/p>\n\n\n\n
Function:<\/strong>
Plays a sound or music track. Supports custom routing based on type:<\/p>\n\n\n\n
    \n
  • \"sound\"<\/code>, \"sex loop\"<\/code>, \"ambience\"<\/code>, \"song\"<\/code><\/li>\n\n\n\n
  • Directory-specific: \"scene\"<\/code>, \"story\"<\/code>, \"secretary\"<\/code>, \"workout\"<\/code><\/li>\n<\/ul>\n\n\n\n
    Usage Examples:<\/strong><\/p>\n\n\n\n
    ($play:\"sound\",\"wet_squish\") <!-- Plays a sound effect immediately --> <\/code>\n($play:\"ambience\",\"cafe\") <!-- Plays ambience immediately --> <\/code>\n($play:\"sex loop\",\"slow_ride\") <!-- Loops a sex sound --> <\/code>\n($play:\"scene\",\"thwack\",\"2s\") <!-- Delays playback 2 seconds --> <\/code>\n($play:\"song no loop\",\"main_theme\") <!-- Plays a song once without looping --><\/code><\/code><\/pre>\n\n\n\n
    \n\n\n\n
    \ud83d\udcac Text & Language Tools<\/h2>\n\n\n\n
    \n\n\n\n
    $caps<\/code><\/h3>\n\n\n\n
    Parameters:<\/strong>
    (str) sentence<\/code><\/p>\n\n\n\n
    Function:<\/strong>
    Capitalizes the first letter of each word in the string.<\/p>\n\n\n\n
    Usage Examples:<\/strong><\/p>\n\n\n\n
    (set:_title to ($caps:\"just another slutty day\")) (print:_title) <!-- Output: Just Another Slutty Day --> <\/code>\n(print: $caps's \"turn me into a girl\") <!-- Output: Turn Me Into A Girl --><\/code><\/code><\/pre>\n\n\n\n
    \n\n\n\n
    \ud83d\udcbe Storage Macros<\/h2>\n\n\n\n
    \n\n\n\n
    $get_session_storage<\/code> \/ $get_local_storage<\/code><\/h3>\n\n\n\n
    Parameters:<\/strong>
    (str) name<\/code>, (any) default<\/code><\/p>\n\n\n\n
    Function:<\/strong>
    Reads a value from browser session or local storage. Returns the default if nothing is found.<\/p>\n\n\n\n
    Usage Examples:<\/strong><\/p>\n\n\n\n
    (set:_mood to ($get_session_storage:\"last_mood\",\"bored\")) <\/code>(set:_flags to ($get_local_storage:\"debug_flags\",(a:)))<\/code><\/code><\/pre>\n\n\n\n
    \n\n\n\n
    $set_session_storage<\/code> \/ $set_local_storage<\/code><\/h3>\n\n\n\n
    Parameters:<\/strong>
    (str) name<\/code>, (any) value<\/code><\/p>\n\n\n\n
    Function:<\/strong>
    Saves a value into session or local storage.<\/p>\n\n\n\n
    Usage Examples:<\/strong><\/p>\n\n\n\n
    ($set_session_storage:\"last_mood\",\"humiliated\") <\/code>($set_local_storage:\"debug_flags\",(a:\"showIDs\"))<\/code><\/code><\/pre>\n\n\n\n
    \n\n\n\n
    $delete_global_variable<\/code><\/h3>\n\n\n\n
    Parameters:<\/strong>
    (str) var_name<\/code><\/p>\n\n\n\n
    Function:<\/strong>
    Resets a named variable by setting it to 0. Used to “delete” global state cleanly.<\/p>\n\n\n\n
    Usage Examples:<\/strong><\/p>\n\n\n\n
    ($delete_global_variable:\"$her_name\") <!-- Resets $her_name to 0 --><\/code><\/code><\/pre>\n\n\n\n
    \n\n\n\n
    $use_global<\/code><\/h3>\n\n\n\n
    Parameters:<\/strong>
    (str) var_name<\/code>, (str) js_var_name<\/code>, (codehook) hook<\/code><\/p>\n\n\n\n
    Function:<\/strong>
    Temporarily loads a JS value, runs a hook with it, then resets the Twine variable.<\/p>\n\n\n\n
    Usage Examples:<\/strong><\/p>\n\n\n\n
    ($use_global: \"$scene_select\", \"window.GE.scene_select\", [(set:$scene to $scene_select)])<\/code><\/pre>\n\n\n\n
    \n\n\n\n
    \ud83e\uddea Logic & Utility<\/h2>\n\n\n\n
    \n\n\n\n
    $char_passage<\/code><\/h3>\n\n\n\n
    Parameters:<\/strong>
    (str) base_passage<\/code>, (codehook) core<\/code>, (codehook) fallback<\/code><\/p>\n\n\n\n
    Function:<\/strong>
    Tries to display a character-specific version of a passage for non-base girls (modded). Falls back to a default block if none exists.<\/p>\n\n\n\n
    Usage Examples:<\/strong><\/p>\n\n\n\n
    ($char_passage:\"sex transactional kiss\",[\n      (set:$kiss_variant to (cond:\n      $character's \"race\" is \"white\", \"kiss \" + (text:(twist:1,3)),\n      $character's \"race\" is \"latin\", \"kiss \" + (text:(twist:4,6)),\n      $character's \"id\" is \"asian\", \"kiss \" + (text:(twist:7,8)),\n      $character's \"id\" is \"black\", \"kiss \" + (text:(twist:9,10)),\n      \"kiss\"\n      )\n    )],[(set:$kiss_variant to \"kiss\")])<\/code><\/pre>\n\n\n\n
    \n\n\n\n
    $passage_tags<\/code><\/h3>\n\n\n\n
    Parameters:<\/strong>
    (str) tag<\/code><\/p>\n\n\n\n
    Function:<\/strong>
    Inserts a “blank” section with the assigned tag, so modders can inject code into this location. Popular for options like adding a new button in a set list of options – mall locations, pills, etc.<\/p>\n\n\n\n
    Usage Examples:<\/strong><\/p>\n\n\n\n
    ($passage_tags:\"bar_options\")<\/code>\n<!-- \nThen you'd inject code into that spot like this: \n:: new bar options [bar_options]\n{(link:\"yell at a patron\")[etc]}\n--> <\/code><\/pre>\n\n\n\n
    \n\n\n\n
    $rnd<\/code><\/h3>\n\n\n\n
    Parameters:<\/strong>
    (num) value<\/code>, (num) precision<\/code><\/p>\n\n\n\n
    Function:<\/strong>
    Rounds a number to a given decimal precision.<\/p>\n\n\n\n
    Usage Examples:<\/strong><\/p>\n\n\n\n
    (set:_chance to ($rnd:0.75488,2)) <!-- _chance = 0.75 --> <\/code>\n(print: $rnd:12.347,1) <!-- Output: 12.3 --><\/code><\/code><\/pre>\n\n\n\n
    $clamp<\/code><\/h3>\n\n\n\n
    Parameters:<\/strong>
    (num) value<\/code>, (num) min<\/code>, (num) max<\/code><\/p>\n\n\n\n
    Function:<\/strong>
    Limits a value between a minimum and maximum. If the value is lower than min, returns min; if higher than max, returns max.<\/p>\n\n\n\n
    Usage Examples:<\/strong><\/p>\n\n\n\n
    (set:_speed to ($clamp:12,5,10)) <!-- _speed = 10 --> <\/code>\n(set:_volume to ($clamp:-3,0,100)) <!-- _volume = 0 --> <\/code>\n(set:_sanity to ($clamp:$sanity,0,100)) <!-- Ensures stat stays in bounds --><\/code><\/code><\/pre>\n\n\n\n
    \n\n\n\n
    \ud83e\udde0 Mood & Status<\/h2>\n\n\n\n
    \n\n\n\n
    $set_mood<\/code><\/h3>\n\n\n\n
    Parameters:<\/strong>
    (str) mood_name<\/code>, (str) reason<\/code><\/p>\n\n\n\n
    Function:<\/strong>
    Sets the current mood, including icon, stat changes, and duration. Triggers mood refresh visuals. Mood must exist (current existing moods are “awesome”, “bored”, and “humiliated”.)<\/p>\n\n\n\n
    Usage Examples:<\/strong><\/p>\n\n\n\n
    ($set_mood:\"humiliated\",\"because ' + (text: $her_name) + ' rejected you due to your small cock.\")\n($set_mood:\"bored\",\"because you've been hanging around the house too much recently!\")<\/code><\/pre>\n\n\n\n
    \n\n\n\n
    $set_status<\/code><\/h3>\n\n\n\n
    Parameters:<\/strong>
    (str) status_name<\/code>, (str) reason<\/code><\/p>\n\n\n\n
    Function:<\/strong>
    Adds a temporary status effect that modifies charm, intellect, or fitness. Triggers status display and stat refresh. Status must exist (current existing statuses are “cum breath”, “nasty cum breath”, “cum shoes”, “walking funny”.)<\/p>\n\n\n\n
    Usage Examples:<\/strong><\/p>\n\n\n\n
    ($set_status:\"cum breath\",\"' + (text: $npc's \"sex name\") + ' came in your mouth, and your breath smells...\")\n\n($set_status:\"walking funny\",\"You're not walking straight... maybe because your ass was so ruthlessly physically dominated in that machine...\")<\/code><\/pre>\n\n\n\n
    \n\n\n\n
    \ud83d\udd79 Game Interaction<\/h2>\n\n\n\n
    \n\n\n\n
    $register_orgasm<\/code><\/h3>\n\n\n\n
    Parameters:<\/strong>
    None<\/p>\n\n\n\n
    Function:<\/strong>
    Logs an orgasm event, resets arousal, reduces action points, and updates stats.<\/p>\n\n\n\n
    Usage Examples:<\/strong><\/p>\n\n\n\n
    ($register_orgasm:) <!-- Call at the end of orgasm scenes --><\/code><\/code><\/pre>\n\n\n\n
    \n\n\n\n
    $simple_option<\/code><\/h3>\n\n\n\n
    Parameters:<\/strong>
    (str) result<\/code>, (...str) labels<\/code><\/p>\n\n\n\n
    Function:<\/strong>
    Creates simple clickable links to set $choice<\/code> and optionally go to next<\/code>, display<\/code>, or use nostop<\/code> logic.<\/p>\n\n\n\n
    Usage Examples:<\/strong><\/p>\n\n\n\n
    ($simple_option:\"passage\",\"transition type (optional)\",\"choice 1\",\"choice 2\",\"choice 3\") <!-- Any number of choices -->\n\n($simple_option:\"buy flowers\",\"Daisies\",\"Roses\",\"Lilies\")\n<!-- ^ this is the same as \n(link:\"Daisies\")[(set:$choice to \"Daisies\")($cs:\"buy flowers\")\n(link:\"Roses\")[(set:$choice to \"Roses\")($cs:\"buy flowers\")\n(link:\"Lilies\")[(set:$choice to \"Lilies\")($cs:\"buy flowers\")\n-->\n\nif you add \"display\" then it uses (display:) instead of ($cs)\n($simple_option:\"buy flowers\",\"display\",\"Daisies\",\"Roses\",\"Lilies\")\n\nif you use \"next\", then it uses ($nx) instead.\n($simple_option:\"buy flowers\",\"next\",\"Daisies\",\"Roses\",\"Lilies\")<\/code><\/pre>\n\n\n\n
    \n\n\n\n
    $cs<\/code><\/h3>\n\n\n\n
    Parameters:<\/strong>
    (str) passage_name<\/code><\/p>\n\n\n\n
    Function:<\/strong>
    Sets $next<\/code> and displays the \"change screen\"<\/code> passage.<\/p>\n\n\n\n
    *Special note: Calling this will clear the content on the “center screen” and replace it with the passage that you call, but it will leave the left and right sidebars alone. The exception to this rule is if the passage you call is a [fullscreen] passage.<\/p>\n\n\n\n
    Usage Examples:<\/strong><\/p>\n\n\n\n
    ($cs:\"scene 04 page 2\")<\/code>\n($cs:\"scene 04 page 3\")<\/code><\/pre>\n\n\n\n
    \n\n\n\n
    $nx<\/code><\/h3>\n\n\n\n
    Parameters:<\/strong>
    (str) passage_name<\/code><\/p>\n\n\n\n
    Function:<\/strong>
    Sets $next<\/code> and displays the \"next\"<\/code> passage. This works similar to $cs except it replaces the ENTIRE screen. This means the passage you call needs to be [fullscreen] and rebuild both the left and right sidebars.<\/p>\n\n\n\n
    Usage Examples:<\/strong><\/p>\n\n\n\n
    ($nx:\"Go to the bar\")<\/code>($nx:\"Do chores\")<\/code>($nx:\"Workout\")<\/code><\/code><\/pre>\n\n\n\n
    \ud83d\udcb0 Economy & Currency<\/h2>\n\n\n\n
    \n\n\n\n
    $gain_money<\/code><\/h3>\n\n\n\n
    Parameters:<\/strong>
    (num) amount<\/code><\/p>\n\n\n\n
    Function:<\/strong>
    Adds money to the player\u2019s total and updates the money display with a visual fade-up transition. Also plays a \u201ckaching\u201d sound if the amount is greater than zero.<\/p>\n\n\n\n
    Usage Examples:<\/strong><\/p>\n\n\n\n
    ($gain_money:50) <!-- Adds $50 and shows animated currency update --> <\/code>($gain_money:200) <!-- Plays sound and fades in the new amount --><\/code><\/code><\/pre>\n\n\n\n
    \n\n\n\n
    $pay_money<\/code><\/h3>\n\n\n\n
    Parameters:<\/strong>
    (num) amount<\/code><\/p>\n\n\n\n
    Function:<\/strong>
    Subtracts money from the player. Ensures balance never drops below zero. Updates display and plays a cash sound.<\/p>\n\n\n\n
    Usage Examples:<\/strong><\/p>\n\n\n\n
    ($pay_money:25) <!-- Deducts $25 and updates the money display --> <\/code>($pay_money:100) <!-- Deducts and plays sound if amount > 0 --><\/code><\/code><\/pre>\n\n\n\n
    \n\n\n\n
    \ud83d\udd25 Arousal & Emotion<\/h2>\n\n\n\n
    \n\n\n\n
    $gain_arousal<\/code><\/h3>\n\n\n\n
    Parameters:<\/strong>
    (num) gain<\/code><\/p>\n\n\n\n
    Function:<\/strong>
    Sets $gain<\/code> to the given value and displays the \"gain arousal\"<\/code> passage. Used to increment arousal in a stylized way.<\/p>\n\n\n\n
    Usage Examples:<\/strong><\/p>\n\n\n\n
    ($gain_arousal:10) <!-- Increases arousal by 10 and shows UI feedback --><\/code>($gain_arousal:5) <!-- Triggers gain arousal logic for smaller amounts --><\/code><\/code><\/pre>\n\n\n\n
    \n\n\n\n
    \ud83c\udfb2 Skill Checks<\/h2>\n\n\n\n
    \n\n\n\n
    $willpower_check<\/code><\/h3>\n\n\n\n
    Parameters:<\/strong>
    (str) next_passage<\/code>, (num) difficulty<\/code><\/p>\n\n\n\n
    Function:<\/strong>
    Performs a willpower check based on a fixed chance (101 - difficulty<\/code>). If successful, jumps to the next_passage<\/code>.<\/p>\n\n\n\n
    Usage Examples:<\/strong><\/p>\n\n\n\n
    ($willpower_check:\"resist temptation\",40) <!-- 61% chance to resist --> <\/code>($willpower_check:\"walk away\",70) <!-- 31% chance to succeed --><\/code><\/code><\/pre>\n\n\n\n
    \n\n\n\n
    $charm_check<\/code><\/h3>\n\n\n\n
    Parameters:<\/strong>
    (str) next_passage<\/code>, (num) difficulty<\/code><\/p>\n\n\n\n
    Function:<\/strong>
    Performs a charm-based skill check. Chance is calculated from charm * 10, averaged with 101 - difficulty<\/code>.<\/p>\n\n\n\n
    Usage Examples:<\/strong><\/p>\n\n\n\n
    ($charm_check:\"flirt with him\",60) <!-- Based on player\u2019s charm stat --> <\/code>($charm_check:\"convince guard\",75) <!-- Harder charm check --><\/code><\/code><\/pre>\n\n\n\n
    \n\n\n\n
    $intellect_check<\/code><\/h3>\n\n\n\n
    Parameters:<\/strong>
    (str) next_passage<\/code>, (num) difficulty<\/code><\/p>\n\n\n\n
    Function:<\/strong>
    Performs an intellect-based skill check. Chance is based on intellect * 10, blended with 101 - difficulty<\/code>.<\/p>\n\n\n\n
    Usage Examples:<\/strong><\/p>\n\n\n\n
    ($intellect_check:\"solve puzzle\",50) <!-- Average difficulty logic check --> <\/code>($intellect_check:\"hack the console\",80) <!-- Requires high intellect --><\/code><\/code><\/pre>\n\n\n\n
    \n\n\n\n
    $fitness_check<\/code><\/h3>\n\n\n\n
    Parameters:<\/strong>
    (str) next_passage<\/code>, (num) difficulty<\/code><\/p>\n\n\n\n
    Function:<\/strong>
    Performs a fitness-based skill check. Chance uses fitness * 10 with a difficulty modifier.<\/p>\n\n\n\n
    Usage Examples:<\/strong><\/p>\n\n\n\n
    ($fitness_check:\"climb out window\",65) <!-- Physical escape or action --> <\/code>($fitness_check:\"lift heavy object\",40) <!-- Easier physical task --><\/code><\/code><\/pre>\n\n\n\n
    \n","protected":false},"excerpt":{"rendered":"
    Javascript Macros X-Change Life uses a customized version of the Twine Harlowe engine. The following custom macros are for modders – these are some macros we have added to Twine Harlowe in order to extend its functionality. 1. average Function: Calculates the average of a series of numbers.Usage: 2. rnd Function: Rounds a number to […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"closed","template":"","meta":[],"doc_category":[16],"doc_tag":[],"_links":{"self":[{"href":"https:\/\/x-change.life\/wiki\/wp-json\/wp\/v2\/docs\/772"}],"collection":[{"href":"https:\/\/x-change.life\/wiki\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/x-change.life\/wiki\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/x-change.life\/wiki\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/x-change.life\/wiki\/wp-json\/wp\/v2\/comments?post=772"}],"version-history":[{"count":7,"href":"https:\/\/x-change.life\/wiki\/wp-json\/wp\/v2\/docs\/772\/revisions"}],"predecessor-version":[{"id":1045,"href":"https:\/\/x-change.life\/wiki\/wp-json\/wp\/v2\/docs\/772\/revisions\/1045"}],"wp:attachment":[{"href":"https:\/\/x-change.life\/wiki\/wp-json\/wp\/v2\/media?parent=772"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/x-change.life\/wiki\/wp-json\/wp\/v2\/doc_category?post=772"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/x-change.life\/wiki\/wp-json\/wp\/v2\/doc_tag?post=772"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}