capitalize

From RPTools Wiki
Revision as of 17:53, 14 March 2023 by Taustin (talk | contribs) (Text replacement - "source>" to "syntaxhighlight>")
Jump to navigation Jump to search

capitalize() Function

Introduced in version 1.5.7
Returns the passed string back with the first letter of each word capitalized. This means that "bump player health" becomes "Bump Player Health". By default, numbers and symbols in the strings are treated as word boundaries.

Usage

<source lang="mtmacro" line> capitalize(input) capitalize(input, treatNumbersSymbolsAsBoundaries) </syntaxhighlight> Parameters

  • input - String to be converted.
  • treatNumbersSymbolsAsBoundaries - Since 1.8. Whether numbers and symbols should be treated as word boundaries - defaults to true(1).

Example

Converting character name.

<source lang="mtmacro" line> [r: name = getTokenName()]
[r: capitalize(name)] </syntaxhighlight> Returns: <source lang="mtmacro"> ichabod crane Ichabod Crane </syntaxhighlight>

String with numbers and symbols. <source lang="mtmacro" line> [r: capitalize("a 4ever 2/una")] </syntaxhighlight> Returns: <source lang="mtmacro"> A 4Ever 2Una </syntaxhighlight>

Since 1.8

String with numbers and symbols: <source lang="mtmacro" line> [h: vLine = "he's sure i'll see you 1st, o'shea"] [r: capitalize(vLine)] [r: capitalize(vLine, 0)] </syntaxhighlight> Returns: <source lang="mtmacro"> He'S Sure I'Ll See You 1St, O'Shea He's Sure I'll See You 1st, O'shea

</syntaxhighlight>

See Also

Version Changes

  • 1.5.7 - Added function.
  • 1.8 - Added optional param to control treatment of numbers and symbols as word boundaries.