Gettok: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(Undo revision 55324 by Pirulax (talk))
 
(8 intermediate revisions by 6 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Server client function}}
{{Server client function}}
This function splits a string using the given seperating character and returns one part as a string.
This function splits a string using the given separating character and returns one specified substring.


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
string gettok ( string text, int tokenNumber, int separatingCharacter )
string gettok ( string text, int tokenNumber, string / int separatingCharacter )
</syntaxhighlight>  
</syntaxhighlight>  


===Required Arguments===  
===Required Arguments===  
*'''text:''' The string that should be split
*'''text:''' the string that should be split.
*'''tokenNumber:''' Which token should be returned (1 for the first, 2 for the second, ..)
*'''tokenNumber:''' which token should be returned (1 for the first, 2 for the second, and so on).
*'''separatingCharacter:''' The ASCII number of the character that seperates the strings (for example 44 for ',')
*'''separatingCharacter:''' the [[ASCII|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===
Returns the token if it exists, ''false'' otherwise.
Returns a [[string]] containing the token if it exists, ''false'' otherwise.


==Example==  
==Example==  
<section name="Server" class="server" show="true">
<section name="Server" class="server" show="true">
This example retrieves the startskin and endskin for spawning a player
This example retrieves the startskin and endskin for spawning a player from a string of two numbers "a,b"
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- Put the string with the skins in a variable. Normally you would read it from a .map file or something.
-- Put the string with the skins in a variable. Normally you would read it from a .map file or something.
local skins = "20,30"
local skins = "20,30"
-- Get the startskin and endskin (20 and 30)
-- Get the startskin and endskin strings ("20" and "30" in this case)
local startskin = gettok ( skins, 1, 44 )
local startskin = gettok ( skins, 1, ',')
local endskin = gettok ( skins, 2, 44 )
local endskin = gettok ( skins, 2, ',' )
-- Get a random skin of the range
-- Get a random skin in the range
local skin = randInt ( tonumber(startskin), tonumber(endskin) )
local skin = math.random ( tonumber(startskin), tonumber(endskin) )
</syntaxhighlight>
</syntaxhighlight>
</section>
</section>
Line 32: Line 32:
==See Also==
==See Also==
{{Utility functions}}
{{Utility functions}}
[[Category:Incomplete]]

Latest revision as of 12:48, 20 February 2019

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, ',')
local endskin = gettok ( skins, 2, ',' )
-- Get a random skin in the range
local skin = math.random ( tonumber(startskin), tonumber(endskin) )

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/Gettok?oldid=62260"