capitalize

From RPTools Wiki
Jump to navigationJump 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

capitalize(input)
capitalize(input, treatNumbersSymbolsAsBoundaries)

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.
[r: name = getTokenName()]<br>
[r: capitalize(name)]

Returns:

ichabod crane
Ichabod Crane

String with numbers and symbols.

[r: capitalize("a 4ever 2/una")]

Returns:

A 4Ever 2Una

Since 1.8

String with numbers and symbols:

[h: vLine = "he's sure i'll see you 1st, o'shea"]
[r: capitalize(vLine)]
[r: capitalize(vLine, 0)]

Returns:

He'S Sure I'Ll See You 1St, O'Shea
He's Sure I'll See You 1st, O'shea

See Also

Version Changes

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