Function reference[link]

abbr[link]

Overloads: 1

[abbr: value][link]

Abbreviates the specified string.

Parameters

Name Type Description
value String The string to abbreviate.

accent[link]

Overloads: 2

[accent: accent][link]

Accents the previous character.

Parameters

Name Type Description
accent Mode
  • acute
  • grave
  • circumflex
  • tilde
  • ring
  • diaeresis
  • caron
  • macron

[accent: character; accent][link]

Accents the specified character.

Parameters

Name Type Description
character String No description
accent Mode
  • acute
  • grave
  • circumflex
  • tilde
  • ring
  • diaeresis
  • caron
  • macron

acute[link]

Aliases: act
Overloads: 1

[acute: character][link]

Accents the specified character with an acute (á) accent.

Parameters

Name Type Description
character String No description

add[link]

Overloads: 1

[add: a; b][link]

Prints the num of the specified values.

Parameters

Name Type Description
a Number The first operand.
b Number The second operand.

after[link]

Overloads: 1

[after: after-action][link]

Sets the postfix pattern for the next block.

Parameters

Name Type Description
after-action Pattern The pattern to run after each iteration of the next block.

and[link]

Overloads: 1

[and: a; b...][link]

Parameters

Name Type Description
a Boolean No description
b... Boolean No description

arg[link]

Overloads: 1

[arg: name][link]

Returns the specified argument from the current subroutine.

Parameters

Name Type Description
name String The name of the argument to retrieve.

at[link]

Overloads: 1

[at: input; pos][link]

Prints the character at the specified position in the input. Throws an exception if the position is outside of the string.

Parameters

Name Type Description
input String The input string.
pos Number The position of the character to find.

b[link]

Overloads: 1

[b][link]

Prints a bullet character.


before[link]

Overloads: 1

[before: before-action][link]

Sets the prefix pattern for the next block.

Parameters

Name Type Description
before-action Pattern The pattern to run before each iteration of the next block.

branch[link]

Overloads: 2

[branch: seed][link]

Branches the internal RNG according to a seed.

Parameters

Name Type Description
seed String The seed for the branch.

[branch: seed; branch-action][link]

Branches the internal RNG, executes the specified pattern, and then merges the branch.

Parameters

Name Type Description
seed String The seed for the branch.
branch-action Pattern The pattern to run on the branch.

c[link]

Overloads: 1

[c][link]

Prints the copyright symbol.


capsinfer[link]

Overloads: 1

[capsinfer: sample][link]

Infers the capitalization of a given string and sets the capitalization mode to match it.

Parameters

Name Type Description
sample String A string that is capitalized in the format to be set.

caron[link]

Aliases: crn
Overloads: 1

[caron: character][link]

Accents the specified character with a caron (č) accent.

Parameters

Name Type Description
character String No description

case[link]

Aliases: caps
Overloads: 1

[case: mode][link]

Changes the capitalization mode for all open channels.

Parameters

Name Type Description
mode Mode The capitalization mode to use.

  • none
    No capitalization.
  • lower
    Convert to lowercase.
  • upper
    Convert to uppercase.
  • title
    Convert to title case.
  • first
    Capitalize the first letter.
  • sentence
    Capitalize the first letter of every sentence.
  • word
    Capitalize the first letter of every word.

cedilla[link]

Aliases: ced
Overloads: 1

[cedilla: character][link]

Accents the specified character with a cedilla (ç) accent.

Parameters

Name Type Description
character String No description

chan[link]

Overloads: 1

[chan: channel-name; visibility; pattern][link]

Opens a channel for writing and executes the specified pattern inside of it.

Parameters

Name Type Description
channel-name String No description
visibility Mode
  • public
    Channel outputs to itself and 'main'.
  • private
    Channel outputs only to itself.
  • internal
    Channel outputs only to itself and all immediate parent channels also set to Internal.
pattern Pattern No description

chance[link]

Overloads: 1

[chance: chance][link]

Modifies the likelihood that the next block will execute. Specified in percentage.

Parameters

Name Type Description
chance Number The percent probability that the next block will execute.

char[link]

Overloads: 1

[char: name][link]

Prints a Unicode character given its official Unicode-designated name (e.g. 'LATIN CAPITAL LETTER R' -> 'R').

Parameters

Name Type Description
name String The name of the character to print (case-insensitive).

chlen[link]

Overloads: 1

[chlen: channel-name][link]

Prints the current length of the specified channel, in characters.

Parameters

Name Type Description
channel-name String The channel for which to retrieve the length.

circumflex[link]

Aliases: cflex
Overloads: 1

[circumflex: character][link]

Accents the specified character with a circumflex (â) accent.

Parameters

Name Type Description
character String No description

clrt[link]

Overloads: 1

[clrt: target-name][link]

Clears the contents of the specified target.

Parameters

Name Type Description
target-name String The name of the target to be cleared.

define[link]

Overloads: 1

[define: flags...][link]

Defines the specified flags.

Parameters

Name Type Description
flags... String The list of flags to define.

depth[link]

Overloads: 1

[depth][link]

Prints the number of currently active blocks.


diaeresis[link]

Aliases: dia
Overloads: 1

[diaeresis: character][link]

Accents the specified character with a diaeresis (ä) accent.

Parameters

Name Type Description
character String No description

digits[link]

Overloads: 1

[digits: format; digits][link]

Specifies the current digit formatting mode for numbers.

Parameters

Name Type Description
format Mode The digit format to use.

  • normal
    Use as many digits as necessary to accomodate the number.
  • pad
    Pad numbers to a specific number of digits.
  • truncate
    Truncate numbers over a specific number of digits.
digits Number The digit count to associate with the mode.

div[link]

Overloads: 1

[div: a; b][link]

Prints the quotient of the two specified numbers.

Parameters

Name Type Description
a Number The dividend.
b Number The divisor.

else[link]

Overloads: 1

[else: condition-fail-pattern][link]

Executes a pattern if the current flag condition fails.

Parameters

Name Type Description
condition-fail-pattern Pattern No description

em[link]

Overloads: 1

[em][link]

Prints an emdash.


emoji[link]

Overloads: 1

[emoji: shortcode][link]

Takes an emoji shortcode and prints the corresponding emoji.

Parameters

Name Type Description
shortcode String The emoji shortcode to use, without colons.

en[link]

Overloads: 1

[en][link]

Prints an endash.


end[link]

Overloads: 1

[end: end-pattern][link]

Sets a pattern that will run after the next block.

Parameters

Name Type Description
end-pattern Pattern The pattern to run after the next block.

endian[link]

Overloads: 1

[endian: endianness][link]

Sets the current endianness for hex and binary formatted numbers.

Parameters

Name Type Description
endianness Mode The endianness to use.

  • big
    Big endian.
  • little
    Little endian.
  • default
    Whatever endianness your system uses.

ends[link]

Overloads: 1

[ends: action][link]

Runs a pattern if the current block iteration is either the first or last.

Parameters

Name Type Description
action Pattern The pattern to run when the condition is met.

eq[link]

Overloads: 1

[eq: a; b][link]

Prints a boolean value indicating whether the two values have equal string representations.

Parameters

Name Type Description
a String No description
b String No description

eqi[link]

Overloads: 1

[eqi: a; b][link]

Prints a boolean value indicating whether the two values have equal string representations, ignoring case.

Parameters

Name Type Description
a String No description
b String No description

even[link]

Overloads: 1

[even: action][link]

Runs a pattern if the current block iteration is an even number.

Parameters

Name Type Description
action Pattern The pattern to run when the condition is met.

first[link]

Overloads: 1

[first: action][link]

Runs a pattern if the current block iteration is the first.

Parameters

Name Type Description
action Pattern The pattern to run when the condition is met.

ge[link]

Overloads: 1

[ge: a; b][link]

Parameters

Name Type Description
a Number No description
b Number No description

grave[link]

Aliases: grv
Overloads: 1

[grave: character][link]

Accents the specified character with a grave (à) accent.

Parameters

Name Type Description
character String No description

group[link]

Overloads: 1

[group: group-name][link]

Retrieves and prints the specified group value of the current match from the active replacer.

Parameters

Name Type Description
group-name String The name of the match group whose value will be retrieved.

gt[link]

Overloads: 1

[gt: a; b][link]

Parameters

Name Type Description
a Number No description
b Number No description

if[link]

Overloads: 2

[if: condition; body][link]

Parameters

Name Type Description
condition Boolean No description
body Pattern No description

[if: condition; body; else-body][link]

Parameters

Name Type Description
condition Boolean No description
body Pattern No description
else-body Pattern No description

ifdef[link]

Overloads: 1

[ifdef: flags...][link]

Sets the current flag condition for [then] ... [else] calls to be true if all the specified flags are set.

Parameters

Name Type Description
flags... String No description

ifndef[link]

Overloads: 1

[ifndef: flags...][link]

Sets the current flag condition for [then] ... [else] calls to be true if all the specified flags are unset.

Parameters

Name Type Description
flags... String No description

ifnot[link]

Aliases: ifn
Overloads: 2

[ifnot: condition; body][link]

Parameters

Name Type Description
condition Boolean No description
body Pattern No description

[ifnot: condition; body; else-body][link]

Parameters

Name Type Description
condition Boolean No description
body Pattern No description
else-body Pattern No description

in[link]

Overloads: 1

[in: arg-name][link]

Prints the value of the specified pattern argument.

Parameters

Name Type Description
arg-name String The name of the argument to access.

index[link]

Aliases: i
Overloads: 1

[index][link]

Prints the zero-based index of the block item currently being executed.


index1[link]

Aliases: i1
Overloads: 1

[index1][link]

Prints the one-based index of the block item currently being executed.


init[link]

Overloads: 1

[init: index][link]

Sets the index of the element to execute on the next block. Set to -1 to disable.

Parameters

Name Type Description
index Number No description

item[link]

Overloads: 2

[item][link]

Prints the main output from the current block iteration.


[item: channel][link]

Prints the specified channel from the current block iteration.

Parameters

Name Type Description
channel String The output channel to print from.

join[link]

Overloads: 2

[join: list-obj][link]

Joins the specified list into a string.

Parameters

Name Type Description
list-obj RantObject The list to join.

[join: list-obj; delimiter][link]

Joins the specified list into a string seperated by the delimiter and returns it.

Parameters

Name Type Description
list-obj RantObject The list to join.
delimiter String The delimiter.

ladd[link]

Aliases: ladds
Overloads: 1

[ladd: list-obj; values...][link]

Adds one or more strings to a list.

Parameters

Name Type Description
list-obj RantObject The list to add to.
values... String The strings to add.

laddn[link]

Overloads: 1

[laddn: list-obj; values...][link]

Adds one or more numbers to a list.

Parameters

Name Type Description
list-obj RantObject The list to add to.
values... Number The numbers to add.

laddp[link]

Overloads: 1

[laddp: list-obj; values...][link]

Adds one or more patterns to a list.

Parameters

Name Type Description
list-obj RantObject The list to add to.
values... Pattern The patterns to add.

laddv[link]

Overloads: 1

[laddv: list-obj; values...][link]

Adds one or more variables to a list.

Parameters

Name Type Description
list-obj RantObject The list to add to.
values... RantObject The variables to add.

last[link]

Overloads: 1

[last: action][link]

Runs a pattern if the current block iteration is the last.

Parameters

Name Type Description
action Pattern The pattern to run when the condition is met.

lclone[link]

Overloads: 1

[lclone: list-obj; variable][link]

Clones a list to another variable.

Parameters

Name Type Description
list-obj RantObject No description
variable String No description

lclr[link]

Overloads: 1

[lclr: list-obj][link]

Clears the specified list.

Parameters

Name Type Description
list-obj RantObject No description

lcpy[link]

Overloads: 1

[lcpy: list-obj; index; variable][link]

Copies an item from a list into a variable.

Parameters

Name Type Description
list-obj RantObject No description
index Number No description
variable String No description

le[link]

Overloads: 1

[le: a; b][link]

Parameters

Name Type Description
a Number No description
b Number No description

len[link]

Overloads: 1

[len: str][link]

Gets the length of the specified string.

Parameters

Name Type Description
str String The string to measure.

lfilter[link]

Overloads: 2

[lfilter: list-name; varname; condition][link]

Filters out elements of a list when the condition returns false. Mutates list.

Parameters

Name Type Description
list-name String The name of the list object to filter.
varname String The name of the variable that will contain the current item within the condition.
condition Pattern The condition that will be checked for each item.

[lfilter: list-name; output-list-name; varname; condition][link]

Filters out elements of a list when the condition returns false. Creates new list with results.

Parameters

Name Type Description
list-name String The name of the list object to filter.
output-list-name String The name of the list that will contain the filtered result.
varname String The name of the variable that will contain the current item within the condition.
condition Pattern The condition that will be checked for each item.

lfind[link]

Overloads: 1

[lfind: list-obj; value][link]

Searches a list for the specified value and prints the index if found. Otherwise, prints -1.

Parameters

Name Type Description
list-obj RantObject No description
value String No description

lfindi[link]

Overloads: 1

[lfindi: list-obj; value][link]

Searches a list for the specified value, ignoring case, and prints the index if found. Otherwise, prints -1.

Parameters

Name Type Description
list-obj RantObject No description
value String No description

lfindv[link]

Overloads: 1

[lfindv: list-obj; value][link]

Searches a list for the specified variable and prints the index if found. Otherwise, prints -1.

Parameters

Name Type Description
list-obj RantObject No description
value RantObject No description

lget[link]

Overloads: 1

[lget: list-obj; index][link]

Prints a list item from the specified index.

Parameters

Name Type Description
list-obj RantObject No description
index Number No description

lins[link]

Overloads: 1

[lins: list-obj; index; value][link]

Inserts a string at the specified index in a list.

Parameters

Name Type Description
list-obj RantObject No description
index Number No description
value String No description

linsn[link]

Overloads: 1

[linsn: list-obj; index; value][link]

Inserts a number at the specified index in a list.

Parameters

Name Type Description
list-obj RantObject No description
index Number No description
value Number No description

linsp[link]

Overloads: 1

[linsp: list-obj; index; value][link]

Inserts a pattern at the specified index in a list.

Parameters

Name Type Description
list-obj RantObject No description
index Number No description
value Pattern No description

linsv[link]

Overloads: 1

[linsv: list-obj; index; value][link]

Inserts a variable at the specified index in a list.

Parameters

Name Type Description
list-obj RantObject No description
index Number No description
value RantObject No description

lmap[link]

Overloads: 2

[lmap: list-name; varname; body][link]

Replaces each item in the input list with its value when run through body.

Parameters

Name Type Description
list-name String The name of the list object to map.
varname String The name of the variable that will contain the current item within the body.
body Pattern The body that will be run for each item.

[lmap: list-name; output-list-name; varname; body][link]

Runs each item in the input list through the body and adds results to output list.

Parameters

Name Type Description
list-name String The name of the list object to map.
output-list-name String The name of the list that will contain the mapped result.
varname String The name of the variable that will contain the current item within the body.
body Pattern The body that will be run for each item.

lpop[link]

Overloads: 1

[lpop: list-obj][link]

Removes the last item from a list.

Parameters

Name Type Description
list-obj RantObject No description

lpopf[link]

Overloads: 1

[lpopf: list-obj][link]

Removes the first item from a list.

Parameters

Name Type Description
list-obj RantObject No description

lpre[link]

Aliases: lpres
Overloads: 1

[lpre: list-obj; value][link]

Prepends a string to a list.

Parameters

Name Type Description
list-obj RantObject No description
value String No description

lpren[link]

Overloads: 1

[lpren: list-obj; value][link]

Prepends a number to a list.

Parameters

Name Type Description
list-obj RantObject No description
value Number No description

lprep[link]

Overloads: 1

[lprep: list-obj; value][link]

Prepends a pattern to a list.

Parameters

Name Type Description
list-obj RantObject No description
value Pattern No description

lrand[link]

Overloads: 1

[lrand: obj][link]

Returns a random value from the specified list.

Parameters

Name Type Description
obj RantObject The list to pick from.

lset[link]

Overloads: 1

[lset: list-obj; index; value][link]

Sets the item at a specified index in a list.

Parameters

Name Type Description
list-obj RantObject No description
index Number No description
value String No description

lsetn[link]

Overloads: 1

[lsetn: list-obj; index; value][link]

Sets the item at a specified index in a list to a number.

Parameters

Name Type Description
list-obj RantObject No description
index Number No description
value Number No description

lsetp[link]

Overloads: 1

[lsetp: list-obj; index; value][link]

Sets the item at a specified index in a list to a pattern.

Parameters

Name Type Description
list-obj RantObject No description
index Number No description
value Pattern No description

lsetv[link]

Overloads: 1

[lsetv: list-obj; index; value][link]

Sets the item at a specified index in a list to a variable.

Parameters

Name Type Description
list-obj RantObject No description
index Number No description
value RantObject No description

lt[link]

Overloads: 1

[lt: a; b][link]

Parameters

Name Type Description
a Number No description
b Number No description

macron[link]

Aliases: mcn
Overloads: 1

[macron: character][link]

Accents the specified character with a macron (c̄) accent.

Parameters

Name Type Description
character String No description

match[link]

Overloads: 1

[match][link]

Retrieves and prints the current match string of the active replacer.


maybe[link]

Overloads: 1

[maybe][link]


merge[link]

Overloads: 1

[merge][link]

Merges the topmost branch of the internal RNG, if it has been branched at least once.


middle[link]

Overloads: 1

[middle: action][link]

Runs a pattern if the current block iteration is neither the first nor last.

Parameters

Name Type Description
action Pattern The pattern to run when the condition is met.

mod[link]

Overloads: 1

[mod: a; b][link]

Parameters

Name Type Description
a Number No description
b Number No description

mul[link]

Overloads: 1

[mul: a; b][link]

Prints the product of the specified numbers.

Parameters

Name Type Description
a Number The first operand.
b Number The second operand.

nand[link]

Overloads: 1

[nand: a; b...][link]

Parameters

Name Type Description
a Boolean No description
b... Boolean No description

ne[link]

Overloads: 1

[ne: a; b][link]

Prints a boolean value indicating whether the two values do not have equal string representations.

Parameters

Name Type Description
a String No description
b String No description

nei[link]

Overloads: 1

[nei: a; b][link]

Prints a boolean value indicating whether two values do not have equal string representations, ignoring case.

Parameters

Name Type Description
a String No description
b String No description

not[link]

Overloads: 1

[not: a][link]

Parameters

Name Type Description
a Boolean No description

notfirst[link]

Overloads: 1

[notfirst: action][link]

Runs a pattern if the current block iteration is not the first.

Parameters

Name Type Description
action Pattern The pattern to run when the condition is met.

notlast[link]

Overloads: 1

[notlast: action][link]

Runs a pattern if the current block iteration is not the last.

Parameters

Name Type Description
action Pattern The pattern to run when the condition is met.

notnth[link]

Overloads: 1

[notnth: interval; pattern][link]

Runs a pattern if the current block iteration is not a multiple of the specified number.

Parameters

Name Type Description
interval Number The interval at which the pattern should not be run.
pattern Pattern The pattern to run when the condition is satisfied.

notntho[link]

Overloads: 1

[notntho: interval; offset; pattern][link]

Runs a pattern if the current block iteration is not a multiple of the specified number offset by a specific amount.

Parameters

Name Type Description
interval Number The interval at which the pattern should not be run.
offset Number The number of iterations to offset the interval by.
pattern Pattern The pattern to run when the condition is satisfied.

nth[link]

Overloads: 1

[nth: interval; pattern][link]

Runs a pattern if the current block iteration is a multiple of the specified number.

Parameters

Name Type Description
interval Number The interval at which the pattern should be run.
pattern Pattern The pattern to run when the condition is satisfied.

ntho[link]

Overloads: 1

[ntho: interval; offset; pattern][link]

Runs a pattern if the current block iteration is a multiple of the specified number offset by a specific amount.

Parameters

Name Type Description
interval Number The interval at which the pattern should be run.
offset Number The number of iterations to offset the interval by.
pattern Pattern The pattern to run when the condition is satisfied.

num[link]

Aliases: n
Overloads: 2

[num: input][link]

Formats an input string using the current number format settings and prints the result.

Parameters

Name Type Description
input String The string to convert into a number.

[num: min; max][link]

Prints a random number between the specified minimum and maximum bounds.

Parameters

Name Type Description
min Number The minimum value of the number to generate.
max Number The maximum value of the number to generate.

numfmt[link]

Overloads: 2

[numfmt: format][link]

Sets the current number formatting mode.

Parameters

Name Type Description
format Mode The number format to use.

  • normal
    No special formatting.
  • group
    Group digits with the system's digit separator.
  • group-commas
    Group digits by commas.
  • group-dots
    Group digits by dots.
  • roman
    Uppercase Roman numerals.
  • roman-upper
    Uppercase Roman numerals.
  • roman-lower
    Lowercase Roman numerals.
  • verbal
    Number verbalization. Only works with integers.
  • hex
    Uppercase hexadecimal.
  • hex-upper
    Uppercase hexadecimal.
  • hex-lower
    Lowercase hexadecimal.
  • binary
    Robot language.

[numfmt: format; range-action][link]

Runs the specified pattern under a specific number formatting mode.

Parameters

Name Type Description
format Mode The number format to use.

  • normal
    No special formatting.
  • group
    Group digits with the system's digit separator.
  • group-commas
    Group digits by commas.
  • group-dots
    Group digits by dots.
  • roman
    Uppercase Roman numerals.
  • roman-upper
    Uppercase Roman numerals.
  • roman-lower
    Lowercase Roman numerals.
  • verbal
    Number verbalization. Only works with integers.
  • hex
    Uppercase hexadecimal.
  • hex-upper
    Uppercase hexadecimal.
  • hex-lower
    Lowercase hexadecimal.
  • binary
    Robot language.
range-action Pattern The pattern to run.

odd[link]

Overloads: 1

[odd: action][link]

Runs a pattern if the current block iteration is an odd number.

Parameters

Name Type Description
action Pattern The pattern to run when the condition is met.

or[link]

Overloads: 1

[or: a; b...][link]

Parameters

Name Type Description
a Boolean No description
b... Boolean No description

pipe[link]

Overloads: 1

[pipe: redirect-callback][link]

Redirects the output from the next block into the specified callback. Access block output with [item].

Parameters

Name Type Description
redirect-callback Pattern The callback to redirect block output to.

plural[link]

Aliases: pl
Overloads: 1

[plural: word][link]

Infers and prints the plural form of the specified word.

Parameters

Name Type Description
word String No description

protect[link]

Overloads: 1

[protect: pattern][link]

Spawns a new block attribute context for the specified callback so any blocks therein will not consume the current attributes.

Parameters

Name Type Description
pattern Pattern The callback to protect.

qcc[link]

Overloads: 1

[qcc: id; component-id; component-type][link]

Adds a carrier component to a constructed query.

Parameters

Name Type Description
id String The ID string for the constructed query.
component-id String The ID to assign to the carrier component.
component-type Mode The component type.

  • match
  • dissociative
  • match-dissociative
  • associative
  • match-associative
  • divergent
  • match-divergent
  • relational
  • match-relational
  • unique
  • match-unique
  • rhyme

qcf[link]

Overloads: 1

[qcf: id; classes...][link]

Adds positive class filters to a constructed query.

Parameters

Name Type Description
id String The ID string for the constructed query.
classes... String The names of the classes that the returned entry must belong to.

qcfn[link]

Overloads: 1

[qcfn: id; classes...][link]

Adds negative class filters to a constructed query.

Parameters

Name Type Description
id String The ID string for the constructed query.
classes... String The names of the classes that the returned entry must not belong to.

qdel[link]

Overloads: 1

[qdel: id][link]

Removes all stored data associated with the specified constructed query ID.

Parameters

Name Type Description
id String The ID string for the constructed query.

qexists[link]

Overloads: 1

[qexists: id][link]

Prints a boolean value indicating whether a constructed query with the specified ID exists.

Parameters

Name Type Description
id String The ID string for the constructed query.

qhas[link]

Overloads: 1

[qhas: id; regex-pattern; options][link]

Adds a positive regex filter to a constructed query.

Parameters

Name Type Description
id String The ID string for the constructed query.
regex-pattern String The regex pattern for the filter.
options String The regex option string for the filter.

qhasno[link]

Overloads: 1

[qhasno: id; regex-pattern; options][link]

Adds a positive regex filter to a constructed query.

Parameters

Name Type Description
id String The ID string for the constructed query.
regex-pattern String The regex pattern for the filter.
options String The regex option string for the filter.

qname[link]

Overloads: 1

[qname: id; name][link]

Sets the table name for a constructed query.

Parameters

Name Type Description
id String The ID string for the constructed query.
name String The name of the table.

qphr[link]

Overloads: 1

[qphr: id; complement][link]

Adds a phrasal complement to a constructed query.

Parameters

Name Type Description
id String The ID string for the constructed query.
complement Pattern The phrasal complement pattern.

qsub[link]

Overloads: 1

[qsub: id; subtype][link]

Sets the subtype for a constructed query.

Parameters

Name Type Description
id String The ID string for the constructed query.
subtype String The subtype of the term to select from the returned entry.

qsubp[link]

Overloads: 1

[qsubp: id; plural-subtype][link]

Sets the plural subtype for a constructed query.

Parameters

Name Type Description
id String The ID string for the constructed query.
plural-subtype String The subtype of the term to select from the returned entry, if the plural flag is set.

qsyl[link]

Overloads: 2

[qsyl: id; syllables][link]

Adds an syllable count range filter to a constructed query that defines an absolute syllable count.

Parameters

Name Type Description
id String The ID string for the constructed query.
syllables Number The number of syllables.

[qsyl: id; min-syllables; max-syllables][link]

Adds a syllable count range filter to a constructed query.

Parameters

Name Type Description
id String The ID string for the constructed query.
min-syllables Number The minimum syllable count.
max-syllables Number The maximum syllable count.

qsylmax[link]

Overloads: 1

[qsylmax: id; max-syllables][link]

Adds a syllable count range filter to a constructed query that defines only a maximum bound.

Parameters

Name Type Description
id String The ID string for the constructed query.
max-syllables Number The maximum syllable count.

qsylmin[link]

Overloads: 1

[qsylmin: id; min-syllables][link]

Adds a syllable count range filter to a constructed query that defines only a minimum bound.

Parameters

Name Type Description
id String The ID string for the constructed query.
min-syllables Number The minimum syllable count.

query[link]

Aliases: q
Overloads: 2

[query][link]

Runs the last-accessed constructed query.


[query: id][link]

Runs the constructed query with the specified identifier.

Parameters

Name Type Description
id String The ID string for the constructed query.

quote[link]

Aliases: quot
Overloads: 1

[quote: quote-action][link]

Surrounds the specified pattern in quotes. Nested quotes use the secondary quotes defined in the format settings.

Parameters

Name Type Description
quote-action Pattern The pattern to run whose output will be surrounded in quotes.

rcc[link]

Overloads: 1

[rcc: ids...][link]

Resets the specified carrier components.

Parameters

Name Type Description
ids... String The list of carrier component identifiers to reset.

reg[link]

Overloads: 1

[reg][link]

Prints the registered trademark symbol.


rep[link]

Aliases: r
Overloads: 1

[rep: times][link]

Sets the repetition count for the next block.

Parameters

Name Type Description
times Number The number of times to repeat the next block.

repcount[link]

Aliases: rc
Overloads: 1

[repcount][link]

Prints the repetition count of the current block.


repeach[link]

Overloads: 1

[repeach][link]

Sets the repetition count to the number of items in the next block.


repelapsed[link]

Aliases: re
Overloads: 1

[repelapsed][link]

Prints the number of iterations remaining to be performed on the current block.


repnum[link]

Aliases: rn
Overloads: 1

[repnum][link]

Prints the iteration number of the current block.


repqueued[link]

Aliases: rq
Overloads: 1

[repqueued][link]

Prints the number of repetitions remaining to be completed on the current block.


reprem[link]

Aliases: rr
Overloads: 1

[reprem][link]

Prints the number of remaining repetitions queued after the current one.


require[link]

Overloads: 1

[require: name][link]

Loads and runs a pattern from cache or file.

Parameters

Name Type Description
name String The name or path of the pattern to load.

rev[link]

Overloads: 1

[rev: input][link]

Reverses the specified string and prints it to the output.

Parameters

Name Type Description
input String The string to reverse.

revx[link]

Overloads: 1

[revx: input][link]

Reverses the specified string and inverts common brackets and quotation marks, then prints the result to the output.

Parameters

Name Type Description
input String The string to reverse.

rhyme[link]

Overloads: 1

[rhyme: flags][link]

Sets the current rhyming mode for queries.

Parameters

Name Type Description
flags Flags The rhyme types to use.

  • perfect
    Everything after the first stressed vowel matches in pronunciation (picky / icky).
  • weak
    The penultimate syllable is stressed and the final syllable rhymes (coffin / raisin).
  • syllabic
    The final syllable rhymes (senator / otter).
  • semirhyme
    The words would rhyme if not for the final syllable (broom / broomstick).
  • forced
    The words might rhyme if you really pushed it.
  • slant-rhyme
    The ending consonants are the same (rant / ant).
  • pararhyme
    All the consonants match (tuna / teen).
  • alliteration
    All consonants up to the first vowel rhyme (dog / dude).

ring[link]

Overloads: 1

[ring: character][link]

Accents the specified character with a ring (å) accent.

Parameters

Name Type Description
character String No description

rs[link]

Overloads: 1

[rs: times; separator][link]

Sets the repetitions and separator for the next block. A combination of rep and sep.

Parameters

Name Type Description
times Number The number of times to repeat the next block.
separator Pattern The separator pattern to run between iterations of the next block.

rvl[link]

Overloads: 1

[rvl: var-names...][link]

Rotates the values of a list of variables once to the left.

Parameters

Name Type Description
var-names... String The list of the names of variables whose values will be rotated in order.

rvr[link]

Overloads: 1

[rvr: var-names...][link]

Rotates the values of a list of variables once to the right.

Parameters

Name Type Description
var-names... String The list of the names of variables whose values will be rotated in order.

send[link]

Overloads: 1

[send: target-name; value][link]

Appends a string to the specified target's contents.

Parameters

Name Type Description
target-name String The name of the target to send to.
value String The string to send to the target.

sendover[link]

Overloads: 1

[sendover: target-name; value][link]

Overwrites the specified target's contents with the provided value.

Parameters

Name Type Description
target-name String The name of the target to send to.
value String The string to send to the target.

sep[link]

Aliases: s
Overloads: 4

[sep][link]


[sep: separator][link]

Sets the separator pattern for the next block.

Parameters

Name Type Description
separator Pattern The separator pattern to run between iterations of the next block.

[sep: separator; conjunction][link]

Flags the next block as a series and sets the separator and conjunction patterns.

Parameters

Name Type Description
separator Pattern The separator pattern to run between items.
conjunction Pattern The conjunction pattern to run before the last item.

[sep: separator; oxford; conjunction][link]

Sets the separator, Oxford comma, and conjunction patterns for the next series.

Parameters

Name Type Description
separator Pattern The separator pattern to run between items.
oxford Pattern The Oxford comma pattern to run before the last item.
conjunction Pattern The conjunction pattern to run before the last item in the series.

split[link]

Overloads: 2

[split: list-name; input][link]

Splits the specified string into a list of chars.

Parameters

Name Type Description
list-name String The name of the variable that will contain the output list.
input String The string to split.

[split: list-name; delimiter; input][link]

Splits the specified string by the given delimiter.

Parameters

Name Type Description
list-name String The name of the variable that will contain the output list.
delimiter String The delimiter.
input String The string to split.

ss[link]

Overloads: 1

[ss][link]

Prints an eszett (ß).


start[link]

Overloads: 1

[start: before-pattern][link]

Sets a pattern that will run before the next block.

Parameters

Name Type Description
before-pattern Pattern The pattern to run before the next block.

sub[link]

Overloads: 1

[sub: a; b][link]

Prints the difference of the specified values.

Parameters

Name Type Description
a Number The first operand.
b Number The second operand.

swap[link]

Overloads: 1

[swap: a; b][link]

Swaps the values of the variables with the two specified names.

Parameters

Name Type Description
a String The name of the first variable.
b String The name of the second variable.

switch[link]

Overloads: 1

[switch: input; case-pairs...][link]

Parameters

Name Type Description
input String No description
case-pairs... Pattern No description

sync[link]

Aliases: x
Overloads: 1

[sync: name; type][link]

Creates and applies a synchronizer with the specified name and type.

Parameters

Name Type Description
name String The name of the synchronizer.
type Mode The synchronization type to use.

  • none
    A random element is selected each time.
  • forward
    Executes from left to right.
  • reverse
    Executes from right to left.
  • deck
    Shuffles items and executes in order. Re-shuffled each time all items are used up.
  • cdeck
    Shuffles items and executes in order. The same order is reused for each traversal.
  • locked
    Chosen randomly, the same element is selected each time.
  • ping
    Starting at the first item, iterates through all elements in order and then reverses without repeating boundary elements.
  • pong
    Starting at the last item, iterates through all elements backwards and then reverses without repeating boundary elements.
  • no-repeat
    The same element will never be chosen twice in a row, as long as the block contains at least two elements.

target[link]

Aliases: t
Overloads: 1

[target: target-name][link]

Places a target with the specified name at the current write position.

Parameters

Name Type Description
target-name String The name of the target.

targetval[link]

Overloads: 1

[targetval: target-name][link]

Prints the current value of the specified target. This function will not spawn a target.

Parameters

Name Type Description
target-name String The name of the target whose value to print.

then[link]

Overloads: 1

[then: condition-pass-pattern][link]

Executes a pattern if the current flag condition passes.

Parameters

Name Type Description
condition-pass-pattern Pattern No description

tilde[link]

Aliases: tld
Overloads: 1

[tilde: character][link]

Accents the specified character with a tilde (ã) accent.

Parameters

Name Type Description
character String No description

tm[link]

Overloads: 1

[tm][link]

Prints the trademark symbol.


toggle[link]

Overloads: 1

[toggle: flags...][link]

Toggles the specified flags.

Parameters

Name Type Description
flags... String No description

txtfmt[link]

Overloads: 1

[txtfmt: format][link]

Sets the text conversion format for all open channels.

Parameters

Name Type Description
format Mode The conversion mode to use.

  • none
    No conversion.
  • fullwidth
    Fullwidth characters.
  • cursive
    Cursive script.
  • bold-cursive
    Bold cursive script.

typeof[link]

Overloads: 1

[typeof: name][link]

Gets the type of the specified variable.

Parameters

Name Type Description
name String No description

undef[link]

Overloads: 1

[undef: flags...][link]

Undefines the specified flags.

Parameters

Name Type Description
flags... String The list of flags to undefine.

v[link]

Overloads: 1

[v: name][link]

Prints the value of the specified variable.

Parameters

Name Type Description
name String The name of the variable to retrieve.

vadd[link]

Overloads: 1

[vadd: a; b][link]

Adds a number to the specified variable.

Parameters

Name Type Description
a String The name of the variable to add to.
b Number The value to add.

vb[link]

Overloads: 1

[vb: name; value][link]

Creates a new string variable with the specified name and value.

Parameters

Name Type Description
name String The name of the variable.
value Boolean The value of the variable.

vcpy[link]

Overloads: 1

[vcpy: a; b][link]

Copies the value of the variable with the first name to the variable with the second name.

Parameters

Name Type Description
a String The variable to copy from.
b String The variable to copy to.

vdiv[link]

Overloads: 1

[vdiv: a; b][link]

Divides the specified variable by a number.

Parameters

Name Type Description
a String The name of the variable to divide.
b Number The divisor.

veq[link]

Overloads: 1

[veq: a; b][link]

Prints a boolean value indicating whether the variables with the two specified names are equal to each other.

Parameters

Name Type Description
a RantObject No description
b RantObject No description

vexists[link]

Overloads: 1

[vexists: name][link]

Prints a boolean value indicating whether a variable with the specified name exists.

Parameters

Name Type Description
name String The name of the variable to check.

vl[link]

Overloads: 2

[vl: name][link]

Creates a new list.

Parameters

Name Type Description
name String The name of the list.

[vl: name; length][link]

Creates a new list with a specified length.

Parameters

Name Type Description
name String The name of the list.
length Number The length of the list.

vlen[link]

Overloads: 1

[vlen: obj][link]

Gets the length of the specified variable.

Parameters

Name Type Description
obj RantObject No description

vmod[link]

Overloads: 1

[vmod: a; b][link]

Parameters

Name Type Description
a String No description
b Number No description

vmul[link]

Overloads: 1

[vmul: a; b][link]

Multiplies the specified variable by a number.

Parameters

Name Type Description
a String The name of the variable to multiply.
b Number The value to multiply by.

vn[link]

Overloads: 2

[vn: name; value][link]

Creates a new number variable with the specified name and value.

Parameters

Name Type Description
name String The name of the variable.
value Number The value of the variable.

[vn: name; min; max][link]

Creates a new number variable with a random value between the specified minimum and maximum bounds.

Parameters

Name Type Description
name String The name of the variable.
min Number The minimum bound of the value.
max Number The maximum bound of the value.

vne[link]

Overloads: 1

[vne: a; b][link]

Prints a boolean value indicating whether the variables with the two specified names are not equal to each other.

Parameters

Name Type Description
a RantObject No description
b RantObject No description

vnot[link]

Overloads: 1

[vnot: a][link]

Parameters

Name Type Description
a String No description

vp[link]

Overloads: 1

[vp: name; value][link]

Creates a new pattern variable with the specified callback.

Parameters

Name Type Description
name String The name of the variable.
value Pattern The value of the variable.

vs[link]

Overloads: 1

[vs: name; value][link]

Creates a new string variable with the specified name and value.

Parameters

Name Type Description
name String The name of the variable.
value String The value of the variable.

vsub[link]

Overloads: 1

[vsub: a; b][link]

Subtracts a number from the specified variable.

Parameters

Name Type Description
a String The name of the variable to subtract from.
b Number The value to subtract.

while[link]

Aliases: loop
Overloads: 1

[while: condition; body][link]

Runs the body over and over while condition remains true.

Parameters

Name Type Description
condition Pattern The condition to check each iteration.
body Pattern The body of the loop.

xdel[link]

Overloads: 1

[xdel: name][link]

Deletes a synchronizer.

Parameters

Name Type Description
name String The name of the synchronizer to delete.

xor[link]

Overloads: 1

[xor: a; b...][link]

Parameters

Name Type Description
a Boolean No description
b... Boolean No description

xpin[link]

Overloads: 1

[xpin: name][link]

Pins a synchronizer.

Parameters

Name Type Description
name String The name of the synchronizer to pin.

xreset[link]

Overloads: 1

[xreset: name][link]

Resets a synchronizer to its initial state.

Parameters

Name Type Description
name String The name of the synchronizer to reset.

xstep[link]

Overloads: 1

[xstep: name][link]

Iterates a synchronizer.

Parameters

Name Type Description
name String The name of the synchronizer to iterate.

xunpin[link]

Overloads: 1

[xunpin: name][link]

Unpins a synchronizer.

Parameters

Name Type Description
name String The name of the synchronizer to unpin.

yield[link]

Overloads: 1

[yield][link]

Yields the currenty written output.


Comments