Gettok: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 4: Line 4:


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
string gettok ( string text, int tokenNumber, int separatingCharacter )
</syntaxhighlight>
{{New feature|3.0110|1.1|
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
string gettok ( string text, int tokenNumber, string / int separatingCharacter )
string gettok ( string text, int tokenNumber, string / int separatingCharacter )
</syntaxhighlight>  
</syntaxhighlight>  
}}


===Required Arguments===  
===Required Arguments===  

Revision as of 11:53, 13 September 2011

This function splits a string using the given separating character and returns one specified substring.

Syntax

string gettok ( string text, int tokenNumber, string / int separatingCharacter )

Required Arguments

  • text: the string that should be split.
  • tokenNumber: which token should be returned (1 for the first, 2 for the second, and so on).
  • separatingCharacter: the ASCII number representing the character you want to use to separate the tokens. You can easily retrieve this by running string.byte on a string containing the separating character.

Returns

Returns a string containing the token if it exists, false otherwise.

Example

Click to collapse [-]
Server

This example retrieves the startskin and endskin for spawning a player from a string of two numbers "a,b"

-- Put the string with the skins in a variable. Normally you would read it from a .map file or something.
local skins = "20,30"
-- Get the startskin and endskin strings ("20" and "30" in this case)
local startskin = gettok ( skins, 1, string.byte(',') )
local endskin = gettok ( skins, 2, string.byte(',') )
-- Get a random skin in the range
local skin = math.random ( tonumber(startskin), tonumber(endskin) )

See Also