[[modding:function:subst]]

=== subst ===

[[modding:function:subst]]

^ Syntax | (subst string string^1) |
^ Arguments | string: A string that contains %number% parts. |
^ | string: The strings you are inserting into the first string. |
^ | ^1 |
^ Returns | string: The string with the appropriate parts replaced. |
^ Category | [[string operator]] |
^ Description | Replaces the %number% parts of the first string with the element referenced by that number in the argument list and returns it. Can have unused arguments. |

=== Example ===

<code lisp>(subst "%1% and %4% and %3% and %4%" "runs" 5000 "four" "bob" "not used")</code>
Returns the string "runs and bob and four and bob".

<code lisp>(subst "%8% %7% %6% %5% %4% %3% %2% %1%." "function" "subst" "the" "of" "example" "an" "is" "This")</code>
Returns the string "This is an example of the subst function.".
Return to [[:Functions]] list