capitalize: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (Text replacement - "<source" to "<syntaxhighlight") |
||
| (5 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{MacroFunction | {{MacroFunction | ||
|name=capitalize | |name=capitalize | ||
|proposed= | |proposed=false | ||
|trusted=false | |trusted=false | ||
|version=1.5.7 | |version=1.5.7 | ||
|description= | |description= | ||
Returns the passed string back with the first letter of each word capitalized. This means that "bump player health" becomes "Bump Player Health". | 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= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
capitalize(input) | capitalize(input) | ||
</ | capitalize(input, treatNumbersSymbolsAsBoundaries) | ||
</syntaxhighlight> | |||
'''Parameters''' | '''Parameters''' | ||
{{param|input|String to be converted.}} | {{param|input|String to be converted.}} | ||
{{param|treatNumbersSymbolsAsBoundaries|''Since 1.8''. Whether numbers and symbols should be treated as word boundaries - defaults to {{code|true}}({{code|1}}).}} | |||
|example= | |example= | ||
Converting character name. | Converting character name. | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[r: name = getTokenName()]<br> | [r: name = getTokenName()]<br> | ||
[r: capitalize(name)] | [r: capitalize(name)] | ||
</ | </syntaxhighlight> | ||
Returns: | Returns: | ||
< | <syntaxhighlight lang="mtmacro"> | ||
ichabod crane | ichabod crane | ||
Ichabod Crane | Ichabod Crane | ||
</ | </syntaxhighlight> | ||
String with numbers and symbols. | String with numbers and symbols. | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[r: capitalize("a 4ever 2/una")] | [r: capitalize("a 4ever 2/una")] | ||
</ | </syntaxhighlight> | ||
Returns: | Returns: | ||
< | <syntaxhighlight lang="mtmacro"> | ||
A 4Ever 2Una | A 4Ever 2Una | ||
</ | </syntaxhighlight> | ||
==== Since 1.8 ==== | |||
String with numbers and symbols: | |||
<syntaxhighlight lang="mtmacro" line> | |||
[h: vLine = "he's sure i'll see you 1st, o'shea"] | |||
[r: capitalize(vLine)] | |||
[r: capitalize(vLine, 0)] | |||
</syntaxhighlight> | |||
Returns: | |||
<syntaxhighlight lang="mtmacro"> | |||
He'S Sure I'Ll See You 1St, O'Shea | |||
He's Sure I'll See You 1st, O'shea | |||
</syntaxhighlight> | |||
|also= | |also= | ||
{{func|upper}} {{func|lower}} | {{func|upper}} {{func|lower}} | ||
| Line 40: | Line 52: | ||
|changes= | |changes= | ||
* '''1.5.7''' - Added function. | * '''1.5.7''' - Added function. | ||
* '''1.8''' - Added optional param to control treatment of numbers and symbols as word boundaries. | |||
}} | }} | ||
[[Category:String Function]] | [[Category:String Function]] | ||
Latest revision as of 20:47, 14 March 2023
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 totrue(1).
Example
Converting character name.
[r: name = getTokenName()]<br>
[r: capitalize(name)]Returns:
ichabod crane
Ichabod CraneString with numbers and symbols.
[r: capitalize("a 4ever 2/una")]Returns:
A 4Ever 2UnaSince 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'sheaSee Also
Version Changes
- 1.5.7 - Added function.
- 1.8 - Added optional param to control treatment of numbers and symbols as word boundaries.