Lua Tutorials - Revision history

=FF=im2good4u: command dumpuserid part 2

2006-08-29T16:35:12Z

command dumpuserid part 2

=FF=im2good4u: command dumpuserid part 1

2006-08-29T08:35:23Z

command dumpuserid part 1

=FF=im2good4u: fixed a litle lol / dumpuserid thingy

2006-08-28T20:16:37Z

fixed a litle lol / dumpuserid thingy

=FF=im2good4u: added spaces in the code exmple

2006-04-29T13:04:21Z

added spaces in the code exmple

WeblionX: JFF (It never ends!)

2006-04-29T01:32:21Z

JFF (It never ends!)

WeblionX: JF

2006-04-29T01:31:25Z

=FF=im2good4u: 2goodish fixes

2006-04-28T16:15:47Z

2goodish fixes

=FF=im2good4u: added ServerCmdLol 1e try

2006-04-28T15:54:49Z

added ServerCmdLol 1e try

=FF=im2good4u: samm fixes

2006-04-28T10:25:59Z

samm fixes

WeblionX: 'Category:' change

2006-04-27T21:13:46Z

'Category:' change

@@ Line 179: / Line 179: @@
 ::It is called for every server command but not for engine commands like ''say'',''broadcast'',''echo''.
-:2. Inside our file at line ''1'' we will write '''function et_ConsoleCommand()--called when someone types a command in conosle or uses sa todo a server command'''
+:2. Inside our file at line ''1'' we will write '''function et_ConsoleCommand() --called when someone types a command in conosle or uses sa todo a server command'''
 ::Now the first thing we need to know is what command was entered.
@@ Line 220: / Line 220: @@
 ::Now we go on assuming we got a normal client slot id so we will try to parse his name. there are 3 ways to parse a name but i use the most simpel one. the other ways are to get it out of a configstring or userinfo. but we will use the  et.gentity_get() on the 'pers.netname'
-:10. So at line ''9'' we write '''        		local idnickname = et.gentity_get(id,"pers.netname") --get the player name for player slot 'id'
+:10. So at line ''9'' we write '''        		local idnickname = et.gentity_get(id,"pers.netname") --get the player name for player slot "id"'''
 ::Now if the person entered a wrong number where there is no client connected then we get an enpty string so first we now check if our string is not empty. if its empty we will print an error but we handle that at line ''13''
-:11. At line ''10'' write '''        		if idnickname ~= "" then --check if the username isnt empty
+:11. At line ''10'' write '''        		if idnickname ~= "" then --check if the username isnt empty'''
-::oke the rest comes soon :p
+::Now we go on. We got a username so wut we can do next is make a server command whit it
-::Now save and load your script and you will be able to use ''dumpuserod'' as a server command.
+:13. So at line ''12'' write '''            		et.trap_SendConsoleCommand(et.EXEC_APPEND,servercommand) --send our command to the server tobe executed'''
 <hr>
 [[Category:Lua]]

@@ Line 108: / Line 108: @@
 ::To start we need an ETPro Lua function that will be called automatically by ETPro when a certain server command has been entered.
 ::To do this we will use et_ConsoleCommand()''.
-::It is called for every server command but now for engine commands like ''say'',''broadcast'',''echo''.
+::It is called for every server command but not for engine commands like ''say'',''broadcast'',''echo''.
 :2. Inside our file at line ''1'' we will write '''function et_ConsoleCommand()--called when someone types a command in conosle or uses sa todo a server command'''
@@ Line 169: / Line 169: @@
 <hr>
 [[Category:Lua]]

@@ Line 131: / Line 131: @@
 ::Now we can use a simple ''if'' statement to check if the command is ''lol''.
-:5. At line ''4'' write '''	if cmd == "lol" then --run our code if the command was "dumpuserid"'''
+:5. At line ''4'' write '''	if cmd == "lol" then --run our code if the command was "lol"'''
 ::If thats true then the script should print "hihi".
@@ Line 159: / Line 159: @@
       <font color="blue">local</font> cmd = et.trap_Argv(<font color="blue">0</font>) <font color="green">--load out the first parameter of the test typed in console (the command itself)</font>
       cmd = string.lower(cmd) <font color="green">--convert it to lower case so its easyer to match in our if statements</font>
-      <font color="blue">if</font> cmd == <font color="darkblue">"lol"</font> <font color="blue">then</font> <font color="green">--run our code if the command was 'dumpuserid'</font>
+      <font color="blue">if</font> cmd == <font color="darkblue">"lol"</font> <font color="blue">then</font> <font color="green">--run our code if the command was 'lol'</font>
           et.G_Print(<font color="darkblue">"hihi\n"</font>) <font color="green">--print out 'hihi'</font>
           <font color="blue">return</font> <font color="blue">1</font> <font color="green">--return 1 to make etpro ignore the command so u wont get an 'invalid command' warning</font>

@@ Line 160: / Line 160: @@
       cmd = string.lower(cmd) <font color="green">--convert it to lower case so its easyer to match in our if statements</font>
       <font color="blue">if</font> cmd == <font color="darkblue">"lol"</font> <font color="blue">then</font> <font color="green">--run our code if the command was 'dumpuserid'</font>
-     et.G_Print(<font color="darkblue">"hihi\n"</font>) <font color="green">--print out 'hihi'</font>
+         et.G_Print(<font color="darkblue">"hihi\n"</font>) <font color="green">--print out 'hihi'</font>
-     <font color="blue">return</font> <font color="blue">1</font> <font color="green">--return 1 to make etpro ignore the command so u wont get an 'invalid command' warning</font>
+         <font color="blue">return</font> <font color="blue">1</font> <font color="green">--return 1 to make etpro ignore the command so u wont get an 'invalid command' warning</font>
       <font color="blue">end</font> <font color="green">--close the if at line 7</font>
       <font color="blue">return</font> <font color="blue">0</font> <font color="green">--if the command wasnt 'lol' then we will get here and return 0 to make etpro handle it</font>

@@ Line 104: / Line 104: @@
 :Just follow the steps and read the comments.
-:1. First we need to create a new file so for the script.  Create a new file and name it ''ServerCmdLol.lua''.
+:1. First we need to create a new file for the script.  Create a new file and name it ''ServerCmdLol.lua''.
 ::To start we need an ETPro Lua function that will be called automatically by ETPro when a certain server command has been entered.

@@ Line 101: / Line 101: @@
 ===Server Command lol===
-:Here we will show how to make a new server command that, will simpely print back ''hihi''.
+:Here we will show how to make a new server command that will simply print ''hihi''.
 :Just follow the steps and read the comments.
-:1. First we need a new file so, create a new file and name it ''ServerCmdLol.lua''.
+:1. First we need to create a new file so for the script.  Create a new file and name it ''ServerCmdLol.lua''.
-::To start we need a [[ETPro]] [http://www.lua.org/ lua] function that will be called automatically by [[ETPro]] when a server command has been entered.
+::To start we need an ETPro Lua function that will be called automatically by ETPro when a certain server command has been entered.
 ::To do this we will use et_ConsoleCommand()''.
-::Its called for every server command but now for engine commands like ''say'',''broadcast'',''echo''.
+::It is called for every server command but now for engine commands like ''say'',''broadcast'',''echo''.
 :2. Inside our file at line ''1'' we will write '''function et_ConsoleCommand()--called when someone types a command in conosle or uses sa todo a server command'''
-::Now the first thing we need to know is wut command was entered.
+::Now the first thing we need to know is what command was entered.
-::Commands there are entered will be split up by spaces so, ''cmd1 hello all'' will be split up in "cmd1", "hello" and "all".
+::Commands that are entered will be split up by spaces, so ''cmd1 hello all'' will be split up into "cmd1", "hello" and "all".
-::The only ecception is that ''cmd2 "hello all"'' will be split up in "cmd2" and "hello all" becase, "hello all" is entered as 1 string
+::The only exception is that ''cmd2 "hello all"'' will be split up in "cmd2" and "hello all" because, "hello all" is entered as one string by enclosing them in quotes.
 ::To get a part of the command you should use et.trap_Argv(''partnumber'')
 ::''partnumber'' 0 is the actual command and, ''partnumber'' 1 is the first parameter of the command
@@ Line 122: / Line 122: @@
 :::et.trap_Argv(2) = "all"
-:3. so at line ''2'' we will write '''	local cmd = et.trap_Argv(0) --load out the first parameter of the test typed in console (the command itself)'''
+:3. At line ''2'' we will write '''	local cmd = et.trap_Argv(0) --load out the first parameter of the test typed in console (the command itself)'''
-::The commands are send on like they way they where entered so if you enter ''cMd3'' you will get ''cMd3''.
+::The commands are sent the same way they were entered, so if you enter ''cMd3'' you will get ''cMd3''.
-::But that makes them harder to detect there for we will convert the string to lower case using a normal [http://www.lua.org/ lua] function.
+::To detect all variations, we will convert the string to lowercase using a normal Lua function.
-:4. to make it lower case we will write '''	cmd = string.lower(cmd) --convert it to lower case so its easyer to match in our if statements''' at line ''3''
+:4. To make it lower case we will write '''	cmd = string.lower(cmd) --convert it to lowercase so it is easier to match in our if statements''' at line ''3''
-::Ok, now we can use a simpel ''if'' statement to check if the command is ''lol''.
+::Now we can use a simple ''if'' statement to check if the command is ''lol''.
-:5. So now at line ''4'' write '''	if cmd == "lol" then --run our code if the command was "dumpuserid"'''
+:5. At line ''4'' write '''	if cmd == "lol" then --run our code if the command was "dumpuserid"'''
-::If thats true then we will print "hihi".
+::If thats true then the script should print "hihi".
-:6. So at line ''5'' write '''        et.G_Print("hihi\n") --print out "hihi"'''
+:6. To do this, at line ''5'' write '''        et.G_Print("hihi\n") --print out "hihi"'''
-::Now we handled the command in our [[ETPro]] [http://www.lua.org/ lua] script therefor, we dont need to send it on to the normal [[ETPro]] code since that will return "Uknown Command" anyway
+::Now that we have handled the command in our [[ETPro]] [http://www.lua.org/ Lua] script, we do not need to send it to the normal ETPro code since that will return "Unknown Command" anyway.
-::We can let [[ETPro]] ignore the command by returning 1 out of our function.
+::We can let ETPro ignore the command by returning 1 out of our function.
-:7. So at line ''6'' we will write '''        return 1 --return 1 to make etpro ignore the command so u wont get an 'invalid command' warning'''
+:7. So at line ''6'' we will write '''        return 1 --return 1 to make ETPro ignore the command so you wont get an 'invalid command' warning'''
-::Thats all we need todo for this command so we can start closing our function
+::Thats all we need to do for this command so we can start closing our function
 :8. At line ''7'' we end our if statement of line ''4'' so we will write '''	end                       	--close the if at line 4'''
 ::Now we get to the code that gets executed when the command was not ''lol''.
-::We got nothing todo here so we will return 0 to make [[ETPro]] habdle it.
+::We got nothing todo here so we will return 0 to make [[ETPro]] handle it.
-:9. make etpro handle all other commands so write '''	return 0 --if the command wasnt 'lol' then we will get here and return 0 to make etpro handle it''' at line ''8''
+:9. To make ETPro handle all other commands, write '''	return 0 --if the command wasnt 'lol' then we will get here and return 0 to make ETPro handle it''' at line ''8''
 ::Now we are almost done just end our function.

@@ Line 113: / Line 113: @@
 ::Now the first thing we need to know is wut command was entered.
-::Commands there are entered will be split up by spaces so, ''cmd1 hello all'' will split in "cmd1", "hello" and "all".
+::Commands there are entered will be split up by spaces so, ''cmd1 hello all'' will be split up in "cmd1", "hello" and "all".
 ::The only ecception is that ''cmd2 "hello all"'' will be split up in "cmd2" and "hello all" becase, "hello all" is entered as 1 string
-::To get a part of the command u should use et.trap_Argv(''partnumber'')
+::To get a part of the command you should use et.trap_Argv(''partnumber'')
 ::''partnumber'' 0 is the actual command and, ''partnumber'' 1 is the first parameter of the command
 :: so in our example above we would get:
@@ Line 124: / Line 124: @@
 :3. so at line ''2'' we will write '''	local cmd = et.trap_Argv(0) --load out the first parameter of the test typed in console (the command itself)'''
-::The commands are send on like they way they where entered so ifu enter ''cMd3'' you will get ''cMd3''.
+::The commands are send on like they way they where entered so if you enter ''cMd3'' you will get ''cMd3''.
 ::But that makes them harder to detect there for we will convert the string to lower case using a normal [http://www.lua.org/ lua] function.
@@ Line 166: / Line 166: @@
   <font color="blue">end</font> <font color="green">-- close et_ConsoleCommand()</font>
-::Now save and load your script and you will see Hello World!!! in the client's console at the begin of a round.
+::Now save and load your script and you will be able to use ''lol'' as a server command.
 <hr>

@@ Line 26: / Line 26: @@
 :Just follow the steps and read the comments.
-:1. First we need a new file so, create a new file and name it HelloWorld.lua.
+:1. First we need a new file so, create a new file and name it ''HelloWorld.lua''.
 ::Now we need an [[ETPro]] [http://www.lua.org/ lua] function that will be called automatically by [[ETPro]] when we want it. Therefore we will use ''et_InitGame(levelTime,randomSeed,restart)''. That function is called once every round at the beginning. It's a good function to do some initial settings. We do not have to worry about those parameters (levelTime,randomSeed,restart) in this example.
@@ Line 52: / Line 52: @@
 :Just follow the steps and read the comments.
-:1. First we need a new file so, create a new file and name it '''HelloSpam.lua'''.
+:1. First we need a new file so, create a new file and name it ''HelloSpam.lua''.
 ::Now we need an [[ETPro]] [http://www.lua.org/ lua] function that will be called automatically by [[ETPro]] many times to make it spammy. Therefore we will use ''et_RunFrame(levelTime)''. That function is called every server frame. It is a good function for stuff you need to constantly check but you should not put to much code in here. We do not have to worry about those parameter (levelTime) in this example.
@@ Line 76: / Line 76: @@
 :Just follow the steps and read the comments.
-:1. First we need a new file so, create a new file and name it HelloClient.lua.
+:1. First we need a new file so, create a new file and name it ''HelloClient.lua''.
 ::Now we need a [[ETPro]] [http://www.lua.org/ lua] function that will be called automatically by [[ETPro]] when we want it. To do this we will use ''et_InitGame(levelTime,randomSeed,restart)'' as shown in the ''Hello World'' example.
@@ Line 99: / Line 99: @@
 ::Now save and load your script and you will see Hello World!!! in the client's console at the begin of a round.
 <hr>
 [[Category:Lua]]

@@ Line 16: / Line 16: @@
 ===Development Environment===
-:While scripting you will see your code gets hard to read, its much easier to read with syntax highlighting. This can be done be scripting inside an [http://www.lua.org/ lua] development environment.
+:While scripting you will see your code gets hard to read, its much easier to read with syntax highlighting. This can be done by scripting inside an [http://www.lua.org/ lua] development environment.
 :These can be found under the ''Development Environments'' heading at  [http://lua-users.org/wiki/LuaAddons this page].
 ==Tutorials==
-:'''NOTE''': Lines written in '''Bold''' are the actual lines we are going to write in our script.
+:'''NOTE''': Lines written in '''Bold''' are the actual lines we are going to write in our scripts.
 ===Hello World===
 :Here we will show a simple hello world example for the server console.