Gettok: Difference between revisions

Revision as of 01:05, 12 June 2006

@@ Line 1: / Line 1: @@
-__NOTOC__
+#REDIRECT split
-==Description==
-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, you could split up the string "This is a sentence", using spaces as separators. This would return "This","is","a","sentence". Each sub-string is assigned an ID number ascending from 1. In this example, ID 2 would return "is".
-This function is commonly used to check the first word against a list of known commands. If the command is found, all subsequent words will be used as arguments.
-==Syntax==
-<syntaxhighlight lang="lua">string Gettok ( string, index, separatingchar )</syntaxhighlight>
-==Example==
-<syntaxhighlight lang="lua">function onPlayerChat ( player, chat )
- if (gettok (chat, 1, " ")) == "!createhydra")
-   x, y, z = getPlayerPosition ( player )
-   createVehicle ( 520, x + 5, y, z )
-   outputChatBox ( "You got a hydra", player )
- end
-end</syntaxhighlight>
-==See Also==
-{{Utility functions}}
-[[Category:Incomplete]]