Utf8.fold: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Redirected page to Utf8.lower)
m (Split syntax into different boxes)
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
#REDIRECT [[Utf8.lower]]
__NOTOC__
{{Shared function}}
{{Note|You may want to read up on [https://www.w3.org/International/wiki/Case_folding case folding] for more information about the use of this function.}}
Converts a UTF-8 string to folded case (lowercase), which can be used to compare two strings. If ''input'' is an integer, it's treat as a codepoint and a convert codepoint (integer) is returned.
 
==Syntax==
<syntaxhighlight lang="lua">
string|int utf8.fold ( string|int input )
</syntaxhighlight>
<syntaxhighlight lang="lua">
string|int utf8.lower ( string|int input )
</syntaxhighlight>
 
===Required Arguments===
*'''input:''' A string character sequence OR an integer value
 
===Returns===
Returns a ''string'' in lowercase OR returns an ''integer'' (see description).
 
==Example==
<section name="Server" class="server" show="true">
This example shows how to convert a string to lowercase, which can be used to compare with other folded strings.
<syntaxhighlight lang="lua">
local output = utf8.lower( "WHAT ARE YOU UP TO? Do you like uppercase?" )
print( output ) -- what are you up to? do you like uppercase?
 
local value = utf8.fold( 1088 )
print( type( value ) ) -- number
</syntaxhighlight>
</section>
 
==See Also==
{{UTF8 functions}}

Latest revision as of 13:12, 30 April 2021

[[{{{image}}}|link=|]] Note: You may want to read up on case folding for more information about the use of this function.

Converts a UTF-8 string to folded case (lowercase), which can be used to compare two strings. If input is an integer, it's treat as a codepoint and a convert codepoint (integer) is returned.

Syntax

string|int utf8.fold ( string|int input )
string|int utf8.lower ( string|int input )

Required Arguments

  • input: A string character sequence OR an integer value

Returns

Returns a string in lowercase OR returns an integer (see description).

Example

Click to collapse [-]
Server

This example shows how to convert a string to lowercase, which can be used to compare with other folded strings.

local output = utf8.lower( "WHAT ARE YOU UP TO? Do you like uppercase?" )
print( output ) -- what are you up to? do you like uppercase?

local value = utf8.fold( 1088 )
print( type( value ) ) -- number

See Also

Shared