Split: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 2: Line 2:
This function splits a string into sub-strings. You specify a character that will act as a separating character; this will determine where to split the sub-strings. For example, it can split the string "Hello World" into two strings containing the two words, by spliting using a space as a seperating character.
This function splits a string into sub-strings. You specify a character that will act as a separating character; this will determine where to split the sub-strings. For example, it can split the string "Hello World" into two strings containing the two words, by spliting using a space as a seperating character.


'''Note:''' You can use the function name 'getok' is an alias for this function, both functions are exactly the same. Split is recommended as it is easier to understand.
'''Note:''' You can use the function [[gettok]] to retrieve a single token from the string at a specific index. This may be faster for one-off lookups, but considerably slower if you are going to check each token in a long string.


==Syntax==
==Syntax==

Revision as of 19:54, 18 November 2006

This function splits a string into sub-strings. You specify a character that will act as a separating character; this will determine where to split the sub-strings. For example, it can split the string "Hello World" into two strings containing the two words, by spliting using a space as a seperating character.

Note: You can use the function gettok to retrieve a single token from the string at a specific index. This may be faster for one-off lookups, but considerably slower if you are going to check each token in a long string.

Syntax

table split ( string stringToSplit, string separatingChar )

Required Arguments

  • stringToSplit The string you wish to split into parts.
  • separatingChar The character you want to use to split

Returns

Returns a table of the sub-strings.

Example

This examples takes any console text input and splits it into parts.

function onConsole ( player, text )
    splittext = split ( text, 32 ) -- Grab the table of tokens
    for splitKey, splitVal in splittext do -- for each token there..
        outputChatBox ( "key: " .. splitKey .. " val: " .. splitVal ) -- output the index and token
    end
end

See Also