WolfWiki - User contributions [en]

Lua Tutorials

2006-08-29T16:35:12Z

=FF=im2good4u: command dumpuserid part 2

__NOEDITSECTION__

This page is here to help you understand [[ETPro]] [http://www.lua.org/ Lua] functions.

Before you start on this tutorial I assume you know basic [http://www.lua.org/ Lua] scripting. If not then I suggest you take a look at the online edition of the book [http://www.lua.org/pil/ Programming in Lua] or the [http://lua-users.org/wiki/ lua-users wiki].
You can also take a look at code made by someone else, a list of [[ETPro]] mods that can be found [[:Category:ETPro:Mods|here]], or our [[ETPro:Lua Sample Code|Lua Sample Code]].

==Getting started==
===Loading a Script===
:Scripts are loaded by their file name out of the /etpro sub directory of your Enemy Territory installation, so don't forget to save them in the right folder. 
:if you want to load HelloWorld.lua you would have to set the server cvar '''lua_modules''' to ''"HelloWorld.lua"''. 
:If you want to load more mods you can add them to the same variables separated by a space like ''"HelloWorld.lua lol.lua pingpong.lua"''
:'''NOTE''': if you modify this cvar all currently loaded [http://www.lua.org/ lua] modules will be unloaded.

:After editing your script you save it and then reload it in [[ETPro]] to make your chances take effect, this can simply be done by '''reset_match''' server command.

===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 scripts.
===Hello World===
:Here we will show a simple hello world example for the server console.
: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''.

::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.

:2. Inside our file at line ''1'' we will write '''function et_InitGame(levelTime,randomSeed,restart) -- called at beginning of a gameround'''

::Now we got a part of our script that is called at the beginning of a round so now we can add our code to it. We are going to print ''"hello world"'' in the server console. To do this we will use ''et.G_Print("message")''. That function will simply print the ''"message"'' in the server console.

:3. At line ''2'' we will write ''' et.G_Print("Hello World!!!\n") -- printout our text to the console'''

::Lastly we need to end out function at line ''1'' with a simple ''end''

:4. At line ''3'' place '''end --close et_InitGame()'''

::Now if you did it right you should have something like [http://home.zonnet.nl/westhof99/lua/HelloWorld.lua this]:
function et_InitGame(levelTime,randomSeed,restart) -- called at beginning of a gameround
et.G_Print("Hello World!!!\n") -- printout our text to the console
end --close et_InitGame()

::Now save and load your script and you will see Hello World!!! in the server console.

<hr>
===Hello Spam===
:Here we will show a simple Spammy hello world example for the server console.
: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''.

::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.

:2. Inside our file at line ''1'' we will write '''function et_RunFrame(levelTime) --called every serverframe'''

::Now we got a part of our script that is called at the beginning of a round so, now we can add our code to it. We are going to print ''"hello world"'' in the server console. To do this we will use ''et.G_Print("message")''; that function will simply print the ''"message"'' in the server console

:3. Now at line ''2'' we will write ''' et.G_Print("Hello Spam!!!\n") -- printout our text to the console'''

::Lastly we need to end our function at line ''1'' with a simple at line ''3'' ''end''

:4. At line ''3'' place '''end --close et_RunFrame()'''

::Now if you did it right you should have something like [http://home.zonnet.nl/westhof99/lua/HelloSpam.lua this]:
function et_RunFrame(levelTime) --called every serverframe
et.G_Print("Hello Spam!!!\n") -- printout our text to the console
end --close et_RunFrame()
::Now save and load your script and you will see Hello Spam!!! in the server console.
<hr>
===Hello Client===
:Here we will show a simple hello world example for the client console.
: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''.

::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.

:2. Inside our file at line ''1'' we will write '''function et_InitGame(levelTime,randomSeed,restart) --called at beginning of a gameround'''

::Now we need a function to print a message to the client his console. We will use et.trap_SendServerCommand(-1,"print \"message\n\"")'' to achieve this. That function will simply print the ''"message"'' in the client's console.
::The first parameter is the client slot to send to. When this is -1 ETPro will send the message to all clients. The 2nd parameter looks confusing and like the original author's spelling, it is. First you have the main command witch is "print ..". Then, at the place of the dots, comes the data to send with the print. In our case this is "message\n"".
::The \n will send a newline command to the console so the next message written to the console is on the next line. The \" are just quotes but since they are already inside a string you need to prefix them with a \ (commonly known as an escape character).

:3. So just write this at line ''2'' ''' et.trap_SendServerCommand(-1,"print \"Hello Client\n\"") -- printout our text to the console'''

::Last we need to end our function at line ''1'' with a simple ''end''

:4. At line ''3'' place '''end --close et_InitGame()'''

::Now if you did it right you should have something like [http://home.zonnet.nl/westhof99/lua/HelloClient.lua this]:
function et_InitGame(levelTime,randomSeed,restart) -- called at beginning of a gameround
et.trap_SendServerCommand(-1,"print \"Hello Client\n\"") -- printout our text to the console
end -- close et_InitGame()

::Now save and load your script and you will see Hello World!!! in the client's console at the begin of a round.
<hr>

===Server Command lol===
: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 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.
::To do this we will use et_ConsoleCommand()''.
::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'''

::Now the first thing we need to know is what command was entered.
::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 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
:: so in our example above we would get:
:::et.trap_Argv(0) = "cmd1"
:::et.trap_Argv(1) = "hello"
:::et.trap_Argv(2) = "all"

: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 sent the same way they were entered, so if you enter ''cMd3'' you will get ''cMd3''.
::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 lowercase so it is easier to match in our if statements''' at line ''3''

::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 "lol"'''

::If thats true then the script should print "hihi".

:6. To do this, at line ''5'' write ''' et.G_Print("hihi\n") --print out "hihi"'''

::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.

: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 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]] handle it.

: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.

:10. So at line ''9'' we will write '''end --close function et_ConsoleCommand() at line 1'''

::Now if you did it right you should have something like [http://home.zonnet.nl/westhof99/lua/ServerCmdLol.lua this]:
function et_ConsoleCommand() --called when someone types a cokmmand in conosle or uses sa todo a server command
local cmd = et.trap_Argv(0) --load out the first parameter of the test typed in console (the command itself)
cmd = string.lower(cmd) --convert it to lower case so its easyer to match in our if statements
if cmd == "lol" then --run our code if the command was 'lol'
et.G_Print("hihi\n") --print out 'hihi'
return 1 --return 1 to make etpro ignore the command so u wont get an 'invalid command' warning
end --close the if at line 7
return 0 --if the command wasnt 'lol' then we will get here and return 0 to make etpro handle it
end -- close et_ConsoleCommand()

::Now save and load your script and you will be able to use ''lol'' as a server command.
<hr>

===Server Command Dumpuserid===
:Here we will show how to make a new server command that will simply preform a the dumpuser cmd on the name of the client slot we enter.
:Just follow the steps and read the comments.

:1. First we need to create a new file for the script. Create a new file and name it ''ServerCmdDumpuserid.lua''.

::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 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'''

::Now the first thing we need to know is what command was entered.
::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 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
:: so in our example above we would get:
:::et.trap_Argv(0) = "cmd1"
:::et.trap_Argv(1) = "hello"
:::et.trap_Argv(2) = "all"

: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 sent the same way they were entered, so if you enter ''cMd3'' you will get ''cMd3''.
::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 lowercase so it is easier to match in our if statements''' at line ''3''

::Now we can use a simple ''if'' statement to check if the command is ''dumpuserid''.

:5. At line ''4'' write ''' if cmd == "dumpuserid" then --run our code if the command was "dumpuserid"'''

::If thats true then we need to know witch client id to dump the userinfo from, therefor we just load in the 2nd comand parameter whit et.trap_Argv(1).

:6. To do this, at line ''5'' write ''' local id = et.trap_Argv(1) --load out the first parameter the command (the userid to dump)'''

::now we got the 2nd parameter as string, the first thing we do now is check if it isnt an empty string ("")

:7. So at line ''6'' write ''' if id ~= "" then --check if parameter1 isnt empty'''

::if its not an empty string then we wil contiune but if it is we will print back an error. We will get to the error later at line ''17''. Now we will go on whit the next step. We will convert our string to a number this way, we not only get it as a number but, we can also get a nil if it can be coverted so, we can see if the 2nd parameter of the command is a real number and not a word.

:8. so at line ''7'' write ''' local idnumber = tonumber(id) --get a number out of the string'''

::Now we will check if its a real number and not a nil. Todo this we can simpely check if its 'true' since only 'nil' and 'false' are 'false' in lua. If its 'false' we will print back an error but we will handle that at line ''15''.

:9. Todo this we will write at line ''8'' ''' if idnumber then --check if its not a nil'''

::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"'''

::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'''

::Now we go on. We got a username so wut we can do next is make a server command whit it

:12. At line ''11'' write ''' local servercommand = "dumpuser ".. idnickname --create the command to send back to the server'''

::Oke now its ready to send to the server as a command this is done by et.trap_SendConsoleCommand()

:13. So at line ''12'' write ''' et.trap_SendConsoleCommand(et.EXEC_APPEND,servercommand) --send our command to the server tobe executed'''

::Now we are done all that left now is to close the stuff up and add the error messages for when one of our if statements return false. first we add the error message for the ifstatement of line ''10''. we make an else whit a et.G_Print()

:14. at line ''13'' write ''' else et.G_Print("Player ".. id .." is not on the server\n") --warning message if the used a wrong slot number'''

::Now Close the if at line ''10''

:15. at line ''14'' write ''' end --close the if at line 10'''

::Now the error message for the if at line ''8''

:16. at line ''15'' write ''' else et.G_Print("invalid player slot, useage: dumpuserid <player slot>\n") --print out a warning that they have to enter player slot'''

::Now Close the if at line ''8''

:17. at line ''16'' write ''' end --close the if at line 12'''

::Now the error message for the if at line ''6'''

:18. at line ''17'' write ''' else et.G_Print("invalid player slot, useage: dumpuserid <player slot>\n") --print out a warning that they have to enter player slot'''

::Close the if at line ''18''

:19. at line ''18'' write ''18'' write ''' end --close the if at line 6'''

::If u look carefulle u will see that all the thing we did so far are all whitin the first if statement that checks if the command is "dumpuserid". We are about to close that if statement but first we got to make sure this command does not get handled by the server since, we already handled and the server would just say "Uknown Command dumpuserid" anyway. in order to stop it from going to the server its command list we will return 1

:20. So at line ''19'' u write ''' return 1 --return 1 to make etpro ignore the command so u wont get an 'invalid command' warning'''

::Now we can close the if at line '4'

:21. At line ''20'' write ''' end --close the if at line 8'''

::For all other commands we want the server to decide wut todo whit it not our script there we will return 0 to just let the server handle it

:22. At line ''21'' write ''' return 0 --if the command wasnt 'dumpuserid' then we will get here and return 0 to make etpro handle it'''

::Now all that left is to close the function

:23. At the line ''22'' write '''end --close function et_ConsoleCommand() at line 5'''

::Now if you did it right you should have something like [http://home.zonnet.nl/westhof99/lua/ServerCmdDumpuserid.lua this]:
function et_ConsoleCommand()--called when someone types a command in conosle or uses sa todo a server command
local cmd = et.trap_Argv(0) --load out the first parameter of the test typed in console (the command itself)
cmd = string.lower(cmd) --convert it to lower case so its easyer to match in our if statements
if cmd == "dumpuserid" then --run our code if the command was 'dumpuserid'
local id = et.trap_Argv(1) --load out the first parameter the command (the userid to dump)
if id ~= "" then --check if parameter1 isnt empty
local idnumber = tonumber(id) --get a number out of the string
if idnumber then --check if its not a nil
local idnickname = et.gentity_get(id,"pers.netname") --get the player name for player slot "id"
if idnickname ~= "" then --check if the username isnt empty
local servercommand = "dumpuser ".. idnickname --create the command to send back to the server
et.trap_SendConsoleCommand(et.EXEC_APPEND,servercommand) --send our command to the server tobe executed
else et.G_Print("Player ".. id .." is not on the server\n") --warning message if the used a wrong slot number
end --close the if at line 14
else et.G_Print("invalid player slot, useage: dumpuserid <player slot>\n") --print out a warning that they have to enter player slot
end --close the if at line 12
else et.G_Print("invalid player slot, useage: dumpuserid <player slot>\n") --print out a warning that they have to enter player slot
end --close the if at line 10
return 1 --return 1 to make etpro ignore the command so u wont get an 'invalid command' warning
end --close the if at line 8
return 0 --if the command wasnt 'dumpuserid' then we will get here and return 0 to make etpro handle it
end --close function et_ConsoleCommand() at line 5

::Now save and load your script and you will be able to use ''dumpuserid'' as a server command.
<hr>

[[Category:Lua]]

Lua Tutorials

2006-08-29T08:35:23Z

=FF=im2good4u: command dumpuserid part 1

__NOEDITSECTION__

This page is here to help you understand [[ETPro]] [http://www.lua.org/ Lua] functions.

Before you start on this tutorial I assume you know basic [http://www.lua.org/ Lua] scripting. If not then I suggest you take a look at the online edition of the book [http://www.lua.org/pil/ Programming in Lua] or the [http://lua-users.org/wiki/ lua-users wiki].
You can also take a look at code made by someone else, a list of [[ETPro]] mods that can be found [[:Category:ETPro:Mods|here]], or our [[ETPro:Lua Sample Code|Lua Sample Code]].

==Getting started==
===Loading a Script===
:Scripts are loaded by their file name out of the /etpro sub directory of your Enemy Territory installation, so don't forget to save them in the right folder. 
:if you want to load HelloWorld.lua you would have to set the server cvar '''lua_modules''' to ''"HelloWorld.lua"''. 
:If you want to load more mods you can add them to the same variables separated by a space like ''"HelloWorld.lua lol.lua pingpong.lua"''
:'''NOTE''': if you modify this cvar all currently loaded [http://www.lua.org/ lua] modules will be unloaded.

:After editing your script you save it and then reload it in [[ETPro]] to make your chances take effect, this can simply be done by '''reset_match''' server command.

===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 scripts.
===Hello World===
:Here we will show a simple hello world example for the server console.
: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''.

::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.

:2. Inside our file at line ''1'' we will write '''function et_InitGame(levelTime,randomSeed,restart) -- called at beginning of a gameround'''

::Now we got a part of our script that is called at the beginning of a round so now we can add our code to it. We are going to print ''"hello world"'' in the server console. To do this we will use ''et.G_Print("message")''. That function will simply print the ''"message"'' in the server console.

:3. At line ''2'' we will write ''' et.G_Print("Hello World!!!\n") -- printout our text to the console'''

::Lastly we need to end out function at line ''1'' with a simple ''end''

:4. At line ''3'' place '''end --close et_InitGame()'''

::Now if you did it right you should have something like [http://home.zonnet.nl/westhof99/lua/HelloWorld.lua this]:
function et_InitGame(levelTime,randomSeed,restart) -- called at beginning of a gameround
et.G_Print("Hello World!!!\n") -- printout our text to the console
end --close et_InitGame()

::Now save and load your script and you will see Hello World!!! in the server console.

<hr>
===Hello Spam===
:Here we will show a simple Spammy hello world example for the server console.
: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''.

::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.

:2. Inside our file at line ''1'' we will write '''function et_RunFrame(levelTime) --called every serverframe'''

::Now we got a part of our script that is called at the beginning of a round so, now we can add our code to it. We are going to print ''"hello world"'' in the server console. To do this we will use ''et.G_Print("message")''; that function will simply print the ''"message"'' in the server console

:3. Now at line ''2'' we will write ''' et.G_Print("Hello Spam!!!\n") -- printout our text to the console'''

::Lastly we need to end our function at line ''1'' with a simple at line ''3'' ''end''

:4. At line ''3'' place '''end --close et_RunFrame()'''

::Now if you did it right you should have something like [http://home.zonnet.nl/westhof99/lua/HelloSpam.lua this]:
function et_RunFrame(levelTime) --called every serverframe
et.G_Print("Hello Spam!!!\n") -- printout our text to the console
end --close et_RunFrame()
::Now save and load your script and you will see Hello Spam!!! in the server console.
<hr>
===Hello Client===
:Here we will show a simple hello world example for the client console.
: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''.

::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.

:2. Inside our file at line ''1'' we will write '''function et_InitGame(levelTime,randomSeed,restart) --called at beginning of a gameround'''

::Now we need a function to print a message to the client his console. We will use et.trap_SendServerCommand(-1,"print \"message\n\"")'' to achieve this. That function will simply print the ''"message"'' in the client's console.
::The first parameter is the client slot to send to. When this is -1 ETPro will send the message to all clients. The 2nd parameter looks confusing and like the original author's spelling, it is. First you have the main command witch is "print ..". Then, at the place of the dots, comes the data to send with the print. In our case this is "message\n"".
::The \n will send a newline command to the console so the next message written to the console is on the next line. The \" are just quotes but since they are already inside a string you need to prefix them with a \ (commonly known as an escape character).

:3. So just write this at line ''2'' ''' et.trap_SendServerCommand(-1,"print \"Hello Client\n\"") -- printout our text to the console'''

::Last we need to end our function at line ''1'' with a simple ''end''

:4. At line ''3'' place '''end --close et_InitGame()'''

::Now if you did it right you should have something like [http://home.zonnet.nl/westhof99/lua/HelloClient.lua this]:
function et_InitGame(levelTime,randomSeed,restart) -- called at beginning of a gameround
et.trap_SendServerCommand(-1,"print \"Hello Client\n\"") -- printout our text to the console
end -- close et_InitGame()

::Now save and load your script and you will see Hello World!!! in the client's console at the begin of a round.
<hr>

===Server Command lol===
: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 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.
::To do this we will use et_ConsoleCommand()''.
::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'''

::Now the first thing we need to know is what command was entered.
::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 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
:: so in our example above we would get:
:::et.trap_Argv(0) = "cmd1"
:::et.trap_Argv(1) = "hello"
:::et.trap_Argv(2) = "all"

: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 sent the same way they were entered, so if you enter ''cMd3'' you will get ''cMd3''.
::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 lowercase so it is easier to match in our if statements''' at line ''3''

::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 "lol"'''

::If thats true then the script should print "hihi".

:6. To do this, at line ''5'' write ''' et.G_Print("hihi\n") --print out "hihi"'''

::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.

: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 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]] handle it.

: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.

:10. So at line ''9'' we will write '''end --close function et_ConsoleCommand() at line 1'''

::Now if you did it right you should have something like [http://home.zonnet.nl/westhof99/lua/ServerCmdLol.lua this]:
function et_ConsoleCommand() --called when someone types a cokmmand in conosle or uses sa todo a server command
local cmd = et.trap_Argv(0) --load out the first parameter of the test typed in console (the command itself)
cmd = string.lower(cmd) --convert it to lower case so its easyer to match in our if statements
if cmd == "lol" then --run our code if the command was 'lol'
et.G_Print("hihi\n") --print out 'hihi'
return 1 --return 1 to make etpro ignore the command so u wont get an 'invalid command' warning
end --close the if at line 7
return 0 --if the command wasnt 'lol' then we will get here and return 0 to make etpro handle it
end -- close et_ConsoleCommand()

::Now save and load your script and you will be able to use ''lol'' as a server command.
<hr>

===Server Command Dumpuserid===
:Here we will show how to make a new server command that will simply preform a the dumpuser cmd on the name of the client slot we enter.
:Just follow the steps and read the comments.

:1. First we need to create a new file for the script. Create a new file and name it ''ServerCmdDumpuserid.lua''.

::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 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'''

::Now the first thing we need to know is what command was entered.
::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 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
:: so in our example above we would get:
:::et.trap_Argv(0) = "cmd1"
:::et.trap_Argv(1) = "hello"
:::et.trap_Argv(2) = "all"

: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 sent the same way they were entered, so if you enter ''cMd3'' you will get ''cMd3''.
::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 lowercase so it is easier to match in our if statements''' at line ''3''

::Now we can use a simple ''if'' statement to check if the command is ''dumpuserid''.

:5. At line ''4'' write ''' if cmd == "dumpuserid" then --run our code if the command was "dumpuserid"'''

::If thats true then we need to know witch client id to dump the userinfo from, therefor we just load in the 2nd comand parameter whit et.trap_Argv(1).

:6. To do this, at line ''5'' write ''' local id = et.trap_Argv(1) --load out the first parameter the command (the userid to dump)'''

::now we got the 2nd parameter as string, the first thing we do now is check if it isnt an empty string ("")

:7. So at line ''6'' write ''' if id ~= "" then --check if parameter1 isnt empty'''

::if its not an empty string then we wil contiune but if it is we will print back an error. We will get to the error later at line ''17''. Now we will go on whit the next step. We will convert our string to a number this way, we not only get it as a number but, we can also get a nil if it can be coverted so, we can see if the 2nd parameter of the command is a real number and not a word.

:8. so at line ''7'' write ''' local idnumber = tonumber(id) --get a number out of the string'''

::Now we will check if its a real number and not a nil. Todo this we can simpely check if its 'true' since only 'nil' and 'false' are 'false' in lua. If its 'false' we will print back an error but we will handle that at line ''15''.

:9. Todo this we will write at line ''8'' ''' if idnumber then --check if its not a nil'''

::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'

::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

::oke the rest comes soon :p

::Now save and load your script and you will be able to use ''dumpuserod'' as a server command.
<hr>

[[Category:Lua]]

Lua Tutorials

2006-08-28T20:16:37Z

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

ETPro:Lua Sample Code

2006-08-28T20:03:30Z

=FF=im2good4u: Added link to toturals page

This code does nothing useful besides demonstrate and exercise the [[Lua Mod API]]

Real tutorials about ETPro Lua scripting can be found [[Lua Tutorials|here]].

-- printf wrapper
function et.G_Printf(...)
et.G_Print(string.format(unpack(arg)))
end

-- test some of the supported etpro lua functions
function test_lua_functions()
et.trap_Cvar_Set( "bla1", "bla2" )
et.G_Printf( "sv_hostname [%s]\n", et.trap_Cvar_Get( "sv_hostname" ) )
et.G_Printf( "configstring 1 [%s] \n", et.trap_GetConfigstring( 1 ) )
et.trap_SetConfigstring( 4, "yadda test" )
et.G_Printf( "configstring 4 [%s]\n", et.trap_GetConfigstring( 4 ) )
et.trap_SendConsoleCommand( et.EXEC_APPEND, "cvarlist *charge*\n" )
et.trap_SendServerCommand( -1, "print \"Yadda yadda\"" )
et.G_Printf( "gentity[1022].classname = [%s]", et.gentity_get( 1022, "classname" ) )
end

-- called when game inits
function et_InitGame( levelTime, randomSeed, restart )
et.G_Printf( "et_InitGame [%d] [%d] [%d]\n", levelTime, randomSeed, restart )
et.RegisterModname( "bani qagame " .. et.FindSelf() )
-- test_lua_functions()
end

-- called every server frame
function et_RunFrame( levelTime )
if math.mod( levelTime, 1000 ) == 0 then
-- et.G_Printf( et_RunFrame [%d]\n", levelTime )
end
end

-- called for every clientcommand
-- return 1 if intercepted, 0 if passthrough
function et_ClientCommand( clientNum, cmd )
et.G_Printf( "et_ClientCommand: [%d] [%s]\n", et.trap_Argc(), cmd )
return 0
end

-- called for every consolecommand
-- return 1 if intercepted, 0 if passthrough
function et_ConsoleCommand()
et.G_Printf( "et_ConsoleCommand: [%s] [%s]\n", et.trap_Argc(), et.trap_Argv(0) )
if et.trap_Argv(0) == "listmods" then
i = 1
repeat
modname, signature = et.FindMod( i )
if modname and signature then
et.G_Printf( "vm slot [%d] name [%s] signature [%s]\n", i, modname, signature )
et.IPCSend( i, "hello" )
end
i = i + 1
until modname == nil or signature == nil
return 1
end
return 0
end

-- called when we receive an IPC from another VM
function et_IPCReceive( vmnumber, message )
et.G_Printf( "IPCReceive [%d] from [%d] message [%s]\n", et.FindSelf(), vmnumber, message )
end

-- called for every ClientConnect
function et_ClientConnect( clientNum, firstTime, isBot )
et.G_Printf( "et_ClientConnect: [%d] [%d] [%d]\n", clientNum, firstTime, isBot )
-- return "go away"
return nil
end

-- called for every ClientDisconnect
function et_ClientDisconnect( clientNum )
et.G_Printf( "et_ClientDisconnect: [%d]\n", clientNum )
end

-- called for every ClientBegin
function et_ClientBegin( clientNum )
et.G_Printf( "et_ClientBegin: [%d]\n", clientNum )
end

-- called for every ClientUserinfoChanged
function et_ClientUserinfoChanged( clientNum )
et.G_Printf( "et_ClientUserinfoChanged: [%d] = [%s]\n", clientNum, et.trap_GetUserinfo( clientNum ) )
end

-- called for every trap_Printf
function et_Print( text )
-- et.G_Printf( "et_Print [%s]", text )
end

[[Category:ETPro]]

Lua Tutorials

2006-04-29T13:04:21Z

=FF=im2good4u: added spaces in the code exmple

Lua Tutorials

2006-04-28T16:15:47Z

=FF=im2good4u: 2goodish fixes

Lua Tutorials

2006-04-28T15:54:49Z

=FF=im2good4u: added ServerCmdLol 1e try

Lua Tutorials

2006-04-28T10:25:59Z

=FF=im2good4u: samm fixes

ETPro:Lua Sample Code

2006-04-27T20:24:12Z

=FF=im2good4u: i forgot to color 1 if

This code does nothing useful besides demonstrate and exercise the [[Lua Mod API]]

-- printf wrapper
function et.G_Printf(...)
et.G_Print(string.format(unpack(arg)))
end

-- test some of the supported etpro lua functions
function test_lua_functions()
et.trap_Cvar_Set( "bla1", "bla2" )
et.G_Printf( "sv_hostname [%s]\n", et.trap_Cvar_Get( "sv_hostname" ) )
et.G_Printf( "configstring 1 [%s] \n", et.trap_GetConfigstring( 1 ) )
et.trap_SetConfigstring( 4, "yadda test" )
et.G_Printf( "configstring 4 [%s]\n", et.trap_GetConfigstring( 4 ) )
et.trap_SendConsoleCommand( et.EXEC_APPEND, "cvarlist *charge*\n" )
et.trap_SendServerCommand( -1, "print \"Yadda yadda\"" )
et.G_Printf( "gentity[1022].classname = [%s]", et.gentity_get( 1022, "classname" ) )
end

-- called when game inits
function et_InitGame( levelTime, randomSeed, restart )
et.G_Printf( "et_InitGame [%d] [%d] [%d]\n", levelTime, randomSeed, restart )
et.RegisterModname( "bani qagame " .. et.FindSelf() )
-- test_lua_functions()
end

-- called every server frame
function et_RunFrame( levelTime )
if math.mod( levelTime, 1000 ) == 0 then
-- et.G_Printf( et_RunFrame [%d]\n", levelTime )
end
end

-- called for every clientcommand
-- return 1 if intercepted, 0 if passthrough
function et_ClientCommand( clientNum, cmd )
et.G_Printf( "et_ClientCommand: [%d] [%s]\n", et.trap_Argc(), cmd )
return 0
end

-- called for every consolecommand
-- return 1 if intercepted, 0 if passthrough
function et_ConsoleCommand()
et.G_Printf( "et_ConsoleCommand: [%s] [%s]\n", et.trap_Argc(), et.trap_Argv(0) )
if et.trap_Argv(0) == "listmods" then
i = 1
repeat
modname, signature = et.FindMod( i )
if modname and signature then
et.G_Printf( "vm slot [%d] name [%s] signature [%s]\n", i, modname, signature )
et.IPCSend( i, "hello" )
end
i = i + 1
until modname == nil or signature == nil
return 1
end
return 0
end

-- called when we receive an IPC from another VM
function et_IPCReceive( vmnumber, message )
et.G_Printf( "IPCReceive [%d] from [%d] message [%s]\n", et.FindSelf(), vmnumber, message )
end

-- called for every ClientConnect
function et_ClientConnect( clientNum, firstTime, isBot )
et.G_Printf( "et_ClientConnect: [%d] [%d] [%d]\n", clientNum, firstTime, isBot )
-- return "go away"
return nil
end

-- called for every ClientDisconnect
function et_ClientDisconnect( clientNum )
et.G_Printf( "et_ClientDisconnect: [%d]\n", clientNum )
end

-- called for every ClientBegin
function et_ClientBegin( clientNum )
et.G_Printf( "et_ClientBegin: [%d]\n", clientNum )
end

-- called for every ClientUserinfoChanged
function et_ClientUserinfoChanged( clientNum )
et.G_Printf( "et_ClientUserinfoChanged: [%d] = [%s]\n", clientNum, et.trap_GetUserinfo( clientNum ) )
end

-- called for every trap_Printf
function et_Print( text )
-- et.G_Printf( "et_Print [%s]", text )
end

[[Category:ETPro]]

Lua Tutorials

2006-04-27T14:37:07Z

=FF=im2good4u: added sample code link

__NOEDITSECTION__

This page isn't finished but it is supposed to make you understand [[ETPro]] [http://www.lua.org/ lua] functions.

Before you start on this tutorial I assume you know basic [http://www.lua.org/ lua] scripting. If not then I suggest you take a look at the online edition of the book [http://www.lua.org/pil/ Programming in Lua] or the [http://lua-users.org/wiki/ lua-users wiki].
You can also take a look at someone else his code, a list of [[ETPro]] mods can be found [[:Category:ETPro:Mods|here]] or, look at the [[ETPro:Lua Sample Code]]

==Getting started==
===Loading a Script===
:Scripts are loaded by their file name out of the /etpro sub directory of your Enemy Territory installation, so don't forget to save them in the right folder. 
:if you want to load HelloWorld.lua you would have to set the server cvar '''lua_modules''' to ''"HelloWorld.lua"''. 
:If you want to load more mods you can add them to the same variables separated by a space like ''"HelloWorld.lua lol.lua pingpong.lua"''
:'''NOTE''': if you modify this cvar all currently loaded [http://www.lua.org/ lua] modules will be unloaded.

:After editing your script you save it and then reload it in [[ETPro]] to make your chances take effect, this can simply be done by '''reset_match''' server command.

===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.

:At [http://lua-users.org/wiki/LuaAddons this page] under ''[http://lua-users.org/wiki/LuaAddons development environments]'' you will find a list of [http://lua-users.org/wiki/LuaAddons development environments].

==Tutorials==
:'''NOTE''': Lines written in '''Bold''' are the actual lines we are going to write in our script.
===Hello World===
:Here we will show a simple hello world example for the server console.
: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.

::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.

:2. Inside our file at line ''1'' we will write '''function et_InitGame(levelTime,randomSeed,restart) -- called at beginning of a gameround'''

::Now we got a part of our script that is called at the beginning of a round so now we can add our code to it. We are going to print ''"hello world"'' in the server console. To do this we will use ''et.G_Print("message")''. That function will simply print the ''"message"'' in the server console.

:3. At line ''2'' we will write ''' et.G_Print("Hello World!!!\n") -- printout our text to the console'''

::Lastly we need to end out function at line ''1'' with a simple ''end''

:4. At line ''3'' place '''end --close et_InitGame()'''

::Now if you did it right you should have something like [http://home.zonnet.nl/westhof99/lua/HelloWorld.lua this]:
function et_InitGame(levelTime,randomSeed,restart) -- called at beginning of a gameround
et.G_Print("Hello World!!!\n") -- printout our text to the console
end --close et_InitGame()

::Now save and load your script and you will see Hello World!!! in the server console.

<hr>
===Hello Spam===
:Here we will show a simple Spammy hello world example for the server console.
: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'''.

::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.

:2. Inside our file at line ''1'' we will write '''function et_RunFrame(levelTime) --called every serverframe'''

::Now we got a part of our script that is called at the beginning of a round so, now we can add our code to it. We are going to print ''"hello world"'' in the server console. To do this we will use ''et.G_Print("message")''; that function will simply print the ''"message"'' in the server console

:3. Now at line ''2'' we will write ''' et.G_Print("Hello Spam!!!\n") -- printout our text to the console'''

::Lastly we need to end our function at line ''1'' with a simple at line ''3'' ''end''

:4. At line ''3'' place '''end --close et_RunFrame()'''

::Now if you did it right you should have something like [http://home.zonnet.nl/westhof99/lua/HelloSpam.lua this]:
function et_RunFrame(levelTime) --called every serverframe
et.G_Print("Hello Spam!!!\n") -- printout our text to the console
end --close et_RunFrame()
::Now save and load your script and you will see Hello Spam!!! in the server console.
<hr>
===Hello Client===
:Here we will show a simple hello world example for the client console.
: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.

::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.

:2. Inside our file at line ''1'' we will write '''function et_InitGame(levelTime,randomSeed,restart) --called at beginning of a gameround'''

::Now we need a function to print a message to the client his console. We will use et.trap_SendServerCommand(-1,"print \"message\n\"")'' to achieve this. That function will simply print the ''"message"'' in the client's console.
::The first parameter is the client slot to send to. When this is -1 ETPro will send the message to all clients. The 2nd parameter looks confusing and like the original author's spelling, it is. First you have the main command witch is "print ..". Then, at the place of the dots, comes the data to send with the print. In our case this is "message\n"".
::The \n will send a newline command to the console so the next message written to the console is on the next line. The \" are just quotes but since they are already inside a string you need to prefix them with a \ (commonly known as an escape character).

:3. So just write this at line ''2'' ''' et.trap_SendServerCommand(-1,"print \"Hello Client\n\"") -- printout our text to the console'''

::Last we need to end our function at line ''1'' with a simple ''end''

:4. At line ''3'' place '''end --close et_InitGame()'''

::Now if you did it right you should have something like [http://home.zonnet.nl/westhof99/lua/HelloClient.lua this]:
function et_InitGame(levelTime,randomSeed,restart) -- called at beginning of a gameround
et.trap_SendServerCommand(-1,"print \"Hello Client\n\"") -- printout our text to the console
end -- close et_InitGame()

::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:ETPro]]
[[Category:ETPro:Mods]]
[[Category:ETPro:LUA]]

ETPro:Lua Sample Code

2006-04-27T14:33:14Z

=FF=im2good4u: syntax highlight part 2 + removed old et_ClientSay

This code does nothing useful besides demonstrate and exercise the [[ETPro:Lua Mod API]]

-- printf wrapper
function et.G_Printf(...)
et.G_Print(string.format(unpack(arg)))
end

-- test some of the supported etpro lua functions
function test_lua_functions()
et.trap_Cvar_Set( "bla1", "bla2" )
et.G_Printf( "sv_hostname [%s]\n", et.trap_Cvar_Get( "sv_hostname" ) )
et.G_Printf( "configstring 1 [%s] \n", et.trap_GetConfigstring( 1 ) )
et.trap_SetConfigstring( 4, "yadda test" )
et.G_Printf( "configstring 4 [%s]\n", et.trap_GetConfigstring( 4 ) )
et.trap_SendConsoleCommand( et.EXEC_APPEND, "cvarlist *charge*\n" )
et.trap_SendServerCommand( -1, "print \"Yadda yadda\"" )
et.G_Printf( "gentity[1022].classname = [%s]", et.gentity_get( 1022, "classname" ) )
end

-- called when game inits
function et_InitGame( levelTime, randomSeed, restart )
et.G_Printf( "et_InitGame [%d] [%d] [%d]\n", levelTime, randomSeed, restart )
et.RegisterModname( "bani qagame " .. et.FindSelf() )
-- test_lua_functions()
end

-- called every server frame
function et_RunFrame( levelTime )
if math.mod( levelTime, 1000 ) == 0 then
-- et.G_Printf( et_RunFrame [%d]\n", levelTime )
end
end

-- called for every clientcommand
-- return 1 if intercepted, 0 if passthrough
function et_ClientCommand( clientNum, cmd )
et.G_Printf( "et_ClientCommand: [%d] [%s]\n", et.trap_Argc(), cmd )
return 0
end

-- called for every consolecommand
-- return 1 if intercepted, 0 if passthrough
function et_ConsoleCommand()
et.G_Printf( "et_ConsoleCommand: [%s] [%s]\n", et.trap_Argc(), et.trap_Argv(0) )
if et.trap_Argv(0) == "listmods" then
i = 1
repeat
modname, signature = et.FindMod( i )
if modname and signature then
et.G_Printf( "vm slot [%d] name [%s] signature [%s]\n", i, modname, signature )
et.IPCSend( i, "hello" )
end
i = i + 1
until modname == nil or signature == nil
return 1
end
return 0
end

-- called when we receive an IPC from another VM
function et_IPCReceive( vmnumber, message )
et.G_Printf( "IPCReceive [%d] from [%d] message [%s]\n", et.FindSelf(), vmnumber, message )
end

-- called for every ClientConnect
function et_ClientConnect( clientNum, firstTime, isBot )
et.G_Printf( "et_ClientConnect: [%d] [%d] [%d]\n", clientNum, firstTime, isBot )
-- return "go away"
return nil
end

-- called for every ClientDisconnect
function et_ClientDisconnect( clientNum )
et.G_Printf( "et_ClientDisconnect: [%d]\n", clientNum )
end

-- called for every ClientBegin
function et_ClientBegin( clientNum )
et.G_Printf( "et_ClientBegin: [%d]\n", clientNum )
end

-- called for every ClientUserinfoChanged
function et_ClientUserinfoChanged( clientNum )
et.G_Printf( "et_ClientUserinfoChanged: [%d] = [%s]\n", clientNum, et.trap_GetUserinfo( clientNum ) )
end

-- called for every trap_Printf
function et_Print( text )
-- et.G_Printf( "et_Print [%s]", text )
end

[[Category:ETPro]]

ETPro:Lua Sample Code

2006-04-27T13:19:55Z

=FF=im2good4u: connected into 1 block

This code does nothing useful besides demonstrate and exercise the [[ETPro:Lua Mod API]]

-- printf wrapper
function et.G_Printf(...)
et.G_Print(string.format(unpack(arg)))
end

-- test some of the supported etpro lua functions
function test_lua_functions()
et.trap_Cvar_Set( "bla1", "bla2" )
et.G_Printf( "sv_hostname [%s]\n", et.trap_Cvar_Get( "sv_hostname" ) )
et.G_Printf( "configstring 1 [%s] \n", et.trap_GetConfigstring( 1 ) )
et.trap_SetConfigstring( 4, "yadda test" )
et.G_Printf( "configstring 4 [%s]\n", et.trap_GetConfigstring( 4 ) )
et.trap_SendConsoleCommand( et.EXEC_APPEND, "cvarlist *charge*\n" )
et.trap_SendServerCommand( -1, "print \"Yadda yadda\"" )
et.G_Printf( "gentity[1022].classname = [%s]", et.gentity_get( 1022, "classname" ) )
end

-- called when game inits
function et_InitGame( levelTime, randomSeed, restart )
et.G_Printf( "et_InitGame [%d] [%d] [%d]\n", levelTime, randomSeed, restart )
et.RegisterModname( "bani qagame " .. et.FindSelf() )
-- test_lua_functions()
end

-- called every server frame
function et_RunFrame( levelTime )
if math.mod( levelTime, 1000 ) == 0 then
-- et.G_Printf( et_RunFrame [%d]\n", levelTime )
end
end

-- called for every clientcommand
-- return 1 if intercepted, 0 if passthrough
function et_ClientCommand( clientNum, cmd )
et.G_Printf( "et_ClientCommand: [%d] [%s]\n", et.trap_Argc(), cmd )
return 0
end

<pre>
-- called for every consolecommand
-- return 1 if intercepted, 0 if passthrough
function et_ConsoleCommand()
et.G_Printf( "et_ConsoleCommand: [%s] [%s]\n", et.trap_Argc(), et.trap_Argv(0) )
if et.trap_Argv(0) == "listmods" then
i = 1
repeat
modname, signature = et.FindMod( i )
if modname and signature then
et.G_Printf( "vm slot [%d] name [%s] signature [%s]\n", i, modname, signature )
et.IPCSend( i, "hello" )
end
i = i + 1
until modname == nil or signature == nil
return 1
end
return 0
end

-- called when we receive an IPC from another VM
function et_IPCReceive( vmnumber, message )
et.G_Printf( "IPCReceive [%d] from [%d] message [%s]\n", et.FindSelf(), vmnumber, message )
end

-- called for every ClientConnect
function et_ClientConnect( clientNum, firstTime, isBot )
et.G_Printf( "et_ClientConnect: [%d] [%d] [%d]\n", clientNum, firstTime, isBot )
-- return "go away"
return nil
end

-- called for every ClientDisconnect
function et_ClientDisconnect( clientNum )
et.G_Printf( "et_ClientDisconnect: [%d]\n", clientNum )
end

-- called for every ClientBegin
function et_ClientBegin( clientNum )
et.G_Printf( "et_ClientBegin: [%d]\n", clientNum )
end

-- called for every ClientUserinfoChanged
function et_ClientUserinfoChanged( clientNum )
et.G_Printf( "et_ClientUserinfoChanged: [%d] = [%s]\n", clientNum, et.trap_GetUserinfo( clientNum ) )
end

-- called for every trap_Printf
function et_Print( text )
-- et.G_Printf( "et_Print [%s]", text )
end

function et_ClientSay( cno, mode, text )
et.G_Printf( "et_ClientSay [%d] [%d] [%s]\n", cno, mode, text )
et.G_Say( cno, mode, text )
return 1
end
</pre>
[[Category:ETPro]]

ETPro:Lua Sample Code

2006-04-27T13:11:26Z

=FF=im2good4u: syntax highlighting part 1

This code does nothing useful besides demonstrate and exercise the [[ETPro:Lua Mod API]]

-- printf wrapper
function et.G_Printf(...)
et.G_Print(string.format(unpack(arg)))
end

-- test some of the supported etpro lua functions
function test_lua_functions()
et.trap_Cvar_Set( "bla1", "bla2" )
et.G_Printf( "sv_hostname [%s]\n", et.trap_Cvar_Get( "sv_hostname" ) )
et.G_Printf( "configstring 1 [%s] \n", et.trap_GetConfigstring( 1 ) )
et.trap_SetConfigstring( 4, "yadda test" )
et.G_Printf( "configstring 4 [%s]\n", et.trap_GetConfigstring( 4 ) )
et.trap_SendConsoleCommand( et.EXEC_APPEND, "cvarlist *charge*\n" )
et.trap_SendServerCommand( -1, "print \"Yadda yadda\"" )
et.G_Printf( "gentity[1022].classname = [%s]", et.gentity_get( 1022, "classname" ) )
end

-- called when game inits
function et_InitGame( levelTime, randomSeed, restart )
et.G_Printf( "et_InitGame [%d] [%d] [%d]\n", levelTime, randomSeed, restart )
et.RegisterModname( "bani qagame " .. et.FindSelf() )
-- test_lua_functions()
end

-- called every server frame
function et_RunFrame( levelTime )
if math.mod( levelTime, 1000 ) == 0 then
-- et.G_Printf( et_RunFrame [%d]\n", levelTime )
end
end

-- called for every clientcommand
-- return 1 if intercepted, 0 if passthrough
function et_ClientCommand( clientNum, cmd )
et.G_Printf( "et_ClientCommand: [%d] [%s]\n", et.trap_Argc(), cmd )
return 0
end

<pre>
-- called for every consolecommand
-- return 1 if intercepted, 0 if passthrough
function et_ConsoleCommand()
et.G_Printf( "et_ConsoleCommand: [%s] [%s]\n", et.trap_Argc(), et.trap_Argv(0) )
if et.trap_Argv(0) == "listmods" then
i = 1
repeat
modname, signature = et.FindMod( i )
if modname and signature then
et.G_Printf( "vm slot [%d] name [%s] signature [%s]\n", i, modname, signature )
et.IPCSend( i, "hello" )
end
i = i + 1
until modname == nil or signature == nil
return 1
end
return 0
end

-- called when we receive an IPC from another VM
function et_IPCReceive( vmnumber, message )
et.G_Printf( "IPCReceive [%d] from [%d] message [%s]\n", et.FindSelf(), vmnumber, message )
end

-- called for every ClientConnect
function et_ClientConnect( clientNum, firstTime, isBot )
et.G_Printf( "et_ClientConnect: [%d] [%d] [%d]\n", clientNum, firstTime, isBot )
-- return "go away"
return nil
end

-- called for every ClientDisconnect
function et_ClientDisconnect( clientNum )
et.G_Printf( "et_ClientDisconnect: [%d]\n", clientNum )
end

-- called for every ClientBegin
function et_ClientBegin( clientNum )
et.G_Printf( "et_ClientBegin: [%d]\n", clientNum )
end

-- called for every ClientUserinfoChanged
function et_ClientUserinfoChanged( clientNum )
et.G_Printf( "et_ClientUserinfoChanged: [%d] = [%s]\n", clientNum, et.trap_GetUserinfo( clientNum ) )
end

-- called for every trap_Printf
function et_Print( text )
-- et.G_Printf( "et_Print [%s]", text )
end

function et_ClientSay( cno, mode, text )
et.G_Printf( "et_ClientSay [%d] [%d] [%s]\n", cno, mode, text )
et.G_Say( cno, mode, text )
return 1
end
</pre>
[[Category:ETPro]]

Lua Mod API

2006-04-26T09:07:37Z

=FF=im2good4u:

__NOEDITSECTION__
ETPro now supports serverside mods via the [http://www.lua.org/ lua] scripting language. For more information about lua, visit the [http://www.lua.org/manual/5.0/ Reference manual], the online edition of the book [http://www.lua.org/pil/ Programming in Lua] or the [http://lua-users.org/wiki/ lua-users wiki].

ETPro has an embedded lua 5.0.2 interpreter, and if present will load user-defined scripts from the etpro directory. ETPro also provides an "et" library of function calls for lua to access the server engine, and provides callbacks so a serverside mod may trigger on specific server events.

The following standard lua libraries are initialized by default and available to ETPro lua scripts:
[http://www.lua.org/manual/5.0/manual.html#5.1 basic], [http://www.lua.org/manual/5.0/manual.html#5.4 table], [http://www.lua.org/manual/5.0/manual.html#5.6 i/o], [http://www.lua.org/manual/5.0/manual.html#5.3 string], [http://www.lua.org/manual/5.0/manual.html#5.5 math].

A list of [[ETPro]] mods can be found [[:Category:ETPro:Mods|here]].

A Totural about [[ETPro]] [http://www.lua.org/ lua] scripting for nubs can be found [[:Category:ETPro:Lua_Noob|here]].

API Requests can be discussed [http://wolfwiki.anime.net/index.php/Talk:ETPro:Lua_Mod_API here].

==client commands==
===lua_status===
:lists all currently loaded lua modules.
:''lua mods cannot override this client command.''

==server commands==
===lua_status===
:lists all currently loaded lua modules.

==cvars==
===lua_modules===
:(default "", disabled)
:space separated list of lua modules for ETPro to load. modules will be run in the order listed.

===lua_allowedmodules===
:(default "", disabled)
:if set, only lua modules with the matching sha1 signatures listed in this cvar will be allowed to load.
 
:changing either cvar will cause all currently loaded modules to :quit and be unloaded until the next map_restart. 
 

==et library calls==

===modules===
et.RegisterModname( '''modname''' )
:Registers a descriptive string '''modname''' for this mod.
'''vmnumber''' = et.FindSelf()
:Returns a number indicating the VM slot the current mod is loaded into.
'''modname''', '''signature''' = et.FindMod( '''vmnumber''' )
:Returns the '''modname''' and sha1 '''signature''' for the mod loaded in the VM slot '''vmnumber'''. Returns nil, nil if the VM slot is invalid.
'''success''' = et.IPCSend( '''vmnumber''', '''message''' )
:Sends the string '''message''' to the mod in the VM slot indicated by '''vmnumber'''. The mod receiving '''message''' must have an ''et_IPCReceive()'' callback. If the message is successfully sent, '''success''' will be 1. On failure it will be 0.
 

===printing===
et.G_Print( '''text''' )
:Prints the string '''text''' to the server console.
et.G_LogPrint( '''text''' )
:Prints the string '''text''' to the server console and writes it to the server log.
 

===argument handling===
These functions are to be used within the [[#commands|command callback functions]]. 
'''args''' = et.ConcatArgs( '''index''' )
:Returns all arguments beginning from '''index''' concatenated into a single string '''args'''
'''argcount''' = et.trap_Argc()
:Returns a number indicating the number of command line arguments in the command buffer.
'''arg''' = et.trap_Argv( '''argnum''' )
:Returns the contents of the command line argument '''argnum'''.
 

===cvars===
'''cvarvalue''' = et.trap_Cvar_Get( '''cvarname''' )
:Returns the value of the cvar '''cvarname''' as a string. If there is no cvar named '''cvarname''', returns a zero length string.
et.trap_Cvar_Set( '''cvarname''', '''cvarvalue''' )
:Sets the cvar '''cvarname''' to '''cvarvalue'''
 

===configstrings===
'''configstringvalue''' = et.trap_GetConfigstring( '''index''' )
:Returns the string '''configstringvalue''' containing the contents of the configstring '''index'''
et.trap_SetConfigstring( '''index''', '''configstringvalue''' )
:Sets the configstring '''index''' to the string '''configstringvalue'''
 

===server===
et.trap_SendConsoleCommand( '''when''', '''command''' )
:Sends the command '''command''' to the server console, to be executed '''when''' (see et.EXEC_* constants)
 

===clients===
et.trap_DropClient( '''clientnum''', '''reason''', '''ban_time''' )
:Disconnects '''clientnum''' from the server, with descriptive string '''reason''' reported to clients. '''ban_time''' is the time in seconds to ban the client from the server. '''ban_time''' is optional and may be entirely omitted, in which case the ban time defaults to the cvar ''b_defaultbantime''
et.trap_SendServerCommand( '''clientnum''', '''[[SendServerCommand|command]]''' )
:Sends the command '''[[SendServerCommand|command]]''' to the client '''clientnum'''. If '''clientnum''' is -1, the '''[[SendServerCommand|command]]''' is broadcast to all connected clients.
et.G_Say( '''clientNum''', '''mode''', '''text''' )
:Sends a chat command on behalf of client '''clientNum''' with the mode '''mode''' (see et.SAY_* constants) and chat text '''text'''.
et.ClientUserinfoChanged( '''clientNum''' )
:Loads the new Userinfo of '''clientNum''' and stores it in the configstring and client variables
 

===userinfo===
'''userinfo''' = et.trap_GetUserinfo( '''clientnum''' )
:Returns the contents of the userinfo string for the client '''clientnum'''
et.trap_SetUserinfo( '''clientnum''', '''userinfo''' )
:Sets the userinfo string for the client '''clientnum''' to '''userinfo'''
 

===string utility functions===
'''infostring''' = et.Info_RemoveKey( '''infostring''', '''key''' )
:Removes key '''key''' from infostring '''infostring''' and returns the modified infostring.
'''infostring''' = et.Info_SetValueForKey( '''infostring''', '''key''', '''value''' )
:Sets the key '''key''' in the infostring '''infostring''' to '''value''' and returns the modified infostring. If '''value''' is an empty string, '''key''' is removed from the string.
'''keyvalue''' = et.Info_ValueForKey( '''infostring''', '''key''' )
:Returns the value of the key '''key''' in the infostring '''infostring'''. If '''key''' is not present in the string, an empty string is returned.
'''cleanstring''' = et.Q_CleanStr( '''string''' )
:Returns '''string''' stripped of all color codes
 

===ET filesystem===
'''fd''', '''len''' = et.trap_FS_FOpenFile( '''filename''', '''mode''' )
:Attempts to open the file '''filename''' with the access mode '''mode''' (see et.FS_ constants). Returns the filedescriptor '''fd''' and file length '''len'''. On error, '''len''' returns -1.
'''filedata''' = et.trap_FS_Read( fd, count )
:Reads '''count''' bytes from filedescriptor '''fd'''.
'''count''' = et.trap_FS_Write( '''filedata''', '''count''', '''fd''' )
:Attempts to write '''count''' bytes of '''filedata''' to filedescriptor '''fd'''. Returns number of bytes successfully written.
et.trap_FS_Rename( '''oldname''', '''newname''' )
:Renames file '''oldname''' to '''newname'''.
et.trap_FS_FCloseFile( '''fd''' )
:Closes filedescriptor '''fd'''
 

===indexes===
'''soundindex''' = et.G_SoundIndex( '''filename''' )
:Returns an index to the soundfile indicated by '''filename'''
'''modelindex''' = et.G_ModelIndex( '''filename''' )
:Returns an index to the model indicated by '''filename'''
 

===sound===
et.G_globalSound( '''sound''' )
:Plays the global sound indicated by the filename '''sound'''.
et.G_Sound( '''entnum''', '''soundindex''' )
:Plays the sound '''soundindex''' at the location of entity '''entnum'''
 

===miscellaneous===
'''milliseconds''' = et.trap_Milliseconds()
:Returns a number indicating the current server time in milliseconds.
et.G_Damage( '''target''', '''inflictor''', '''attacker''', '''damage''', '''[[etdamage|dflags]]''', '''[[etdamage|mod]]''' )
:Does '''damage''' amount of damage on '''target''' inflicted by '''inflictor''' and cased by '''attacker'''
:'''target''', '''inflictor''', '''attacker''' are entity numbers
:'''[[etdamage|dflags]]''' is a [[Bitmask-cvar|bitflag]] number to decide how the damage is inflickted, see '''[[etdamage|dflags]]''' [[etdamage|flaglist]]
:'''[[etdamage|mod]]''' is a number from 0 up to 64 o set the type of damage, see '''[[etdamage|mod]]''' [[etdamage|list]]
 

===entities===
'''entnum''' = et.G_Spawn()
:Spawns a new entity and returns the new entity number.
'''entnum''' = et.G_TempEntity( '''origin''', '''event''' )
:Spawns a new TempEntity of event type '''event''' and places it at '''origin''' in the world.
:'''Warning:''' up to and including ETPro 3.2.4 the signature of the method is broken and expects four instead of two parameters. To successfully call it, you need to prepend the parameter list with two dummy parameters like et.G_TempEntity( 0, 0, origin, event ). Use this method with care, because in future ETPro versions it will probably be corrected to the one stated above and might break your script.
et.G_FreeEntity( '''entnum''' )
:Frees the entity '''entnum'''
'''spawnval''' = et.G_GetSpawnVar( '''entnum''', '''key''' )
:Returns the value of spawnvar '''key''' for entity '''entnum'''
et.G_SetSpawnVar( '''entnum''', '''key''', '''value''' )
:Sets the spawnvar '''key''' to '''value''' for entity '''entnum'''
'''integer entnum''' = et.G_SpawnGEntityFromSpawnVars( string spawnvar, string spawnvalue, ... )
:This function can only be called inside the '''et_InitGame''' callback
et.trap_LinkEntity( '''entnum''' )
:Links the entity '''entnum'''
et.trap_UnlinkEntity( '''entnum''' )
:Unlinks the entity '''entnum'''
'''(variable)''' = et.gentity_get ( '''entnum''', '''[[Fieldname]]''' '',arrayindex'' )
:Gets the value of '''[[Fieldname]]''' from entity '''entnum''' out of the g_entity struct. For NULL entities or clients, ''nil'' is returned. 
:''arrayindex'' is used to specify which element of an array entity field to get. It is required when accessing array type fields. Entity field array indexes start at 0.
et.gentity_set( '''entnum''', '''[[Fieldname]]''', ''arrayindex,'' '''(value)''' )
:Sets the value of '''[[Fieldname]]''' from entity '''entnum''' in the g_entity struct to '''(value)'''
:''arrayindex'' is used to specify which element of an array entity field to set.
et.G_AddEvent( '''ent''', '''event''', '''eventparm'''' )
:Adds event '''event''' whit eventparameter '''eventparm'''' to entity '''ent'''
 

==callbacks==

===qagame execution===
et_InitGame( '''levelTime''', '''randomSeed''', '''restart''' )
:Called when qagame initializes. '''levelTime''' is the current level time in milliseconds. '''randomSeed''' is a number that can be used to seed random number generators. '''restart''' indicates if et_InitGame() is being called due to a map restart (1) or not (0).
et_ShutdownGame( '''restart''' )
:Called when qagame shuts down. '''restart''' indicates if the shutdown is being called due to a map_restart (1) or not (0).
et_RunFrame( '''levelTime''' )
:Called when qagame runs a server frame. '''levelTime''' is the current level time in milliseconds.
et_Quit()
:Called when ETPro unloads the mod. The mod should close all open filedescriptors and perform all cleanup.
 

===client management===
'''rejectreason''' = et_ClientConnect( '''clientNum''', '''firstTime''', '''isBot''' )
:Called when a client attempts to connect to the server. '''clientNum''' is the client slot id, '''firstTime''' indicates if this is a new connection (1) or a reconnection (0). '''isBot''' indicates if the client is a bot (1) or not (0). If the mod accepts the connection, it should return nil. Otherwise, the mod should return a string describing the reason the client connection was rejected.
et_ClientDisconnect( '''clientNum''' )
:Called when a client disconnects. '''clientNum''' is the client slot id.
et_ClientBegin( '''clientNum''' )
:Called when a client begins (becomes active, and enters the gameworld). '''clientNum''' is the client slot id.
et_ClientUserinfoChanged( '''clientNum''' )
:Called when a client's Userinfo string has changed. '''clientNum''' is the client slot id.
et_ClientSpawn( '''clientNum''', '''revived''' )
:Called when a client is spawned. '''clientNum''' is the client slot id. '''revived''' is 1 if the client was spawned by beeying revived.
 

===commands===
'''intercepted''' = et_ClientCommand( '''clientNum''', '''command''' )
:Called when a command is received from a client. '''clientNum''' is the client slot id. '''command''' is the command. The mod should return 1 if the command was intercepted by the mod, and 0 if the command was ignored by the mod and should be passed through to the server (and other mods in the chain).
:The actual command can be accessed through the [[#argument_handling|argument handling]] functions, as seen in the [[ETPro:Lua Sample Code]].
'''intercepted''' = et_ConsoleCommand()
:Called when a command is entered on the server console. The mod should return 1 if the command was intercepted by the mod, and 0 if the command was ignored by the mod and should be passed through to the server (and other mods in the chain).
:The actual command can be accessed through the [[#argument_handling|argument handling]] functions, as seen in the [[ETPro:Lua Sample Code]].
 

===xp===
et_UpgradeSkill( '''cno''', '''skill''' )
:Called when client on slot '''cno''' gets a skill upgrade on skill '''skill''', return -1 to override (abort) the qagame function, anything else to "passthrough" callback may modify skills (or do anything else it wants) during passthrough.
et_UpgradeSkill( '''cno''', '''skill''' )
:Called when client '''cno''' his skill level of '''skill''' is set, return -1 to override (abort) the qagame function, anything else to "passthrough" callback may modify skills (or do anything else it wants) during passthrough.

===miscellaneous===
et_IPCReceive( '''vmnumber''', '''message''' )
:Called when another mod sends an et.IPCSend() message to this mod. '''vmnumber''' is the VM slot number of the sender, and '''message''' is the message.
et_Print( '''text''' )
:Called whenever the server or qagame prints a string to the console.
et_Obituary( '''victim''', '''killer''', '''meansOfDeath''' )
:Called whenever a player is killed.
 

==predefined constants==
et.EXEC_NOW 
et.EXEC_INSERT 
et.EXEC_APPEND 
et.FS_READ 
et.FS_WRITE 
et.FS_APPEND 
et.FS_APPEND_SYNC 
et.SAY_ALL 
et.SAY_TEAM 
et.SAY_BUDDY 
et.SAY_TEAMNL 
 
et.HOSTARCH
:set to WIN32 or UNIX depending on the host architecture qagame is running on.
LUA_PATH
:set to fs_homepath/fs_game/?.lua in order to ease use of the [http://www.lua.org/pil/8.1.html require] function.
 

==configs==
If a config is loaded, all modules are shutdown and reloaded. If a ''certified'' config is loaded, all modules are shutdown and reloaded, and additionally the following functions are disabled: '''require()''', '''loadfile()''', '''loadlib()''', '''loadstring()''', '''dofile()''' 
 

==caveats==
Like qagame, lua modules are unloaded and reloaded on map_restart and map changes. This means that all global variables and other information is lost. Mods may choose to store persistent data in cvars or external files. 
 

==FAQ==

Q: OMG I hate the libary prefix et.* on everything!!11!1oneone 
A: table.foreach(et, function (func, value) _G[func] = value; end)

Q: How do a re-load my lua file without restarting the whole server ? 
A: change maps or map_restart

Q: Can I see some sample code? 
A: [[ETPro:Lua Sample Code]]

Q: Is there a list of [[ETPro]] mods? 
A: Yes, [[:Category:ETPro:Mods|here]].

Q: OMG my mod doesn't work! 
A: Make sure you added your mod's filename to the lua_modules cvar (e.g. set lua_modules mymod.lua).

Q: OMG why has et_ClientSay been removed? 
A: Thats a secret but, to keep the function as it was, just add the following code to your et_ClientCommand() function 
<pre> -- et_ClientSay had to be removed in order to intercept all commands
-- so here's a wrapper for that
arg0 = et.trap_Argv(0) -- get the main command

if arg0 == "say" then
return et_ClientSay( clientNum, et.SAY_ALL, et.ConcatArgs(1))
elseif arg0 == "say_team" then
return et_ClientSay( clientNum, et.SAY_TEAM, et.ConcatArgs(1))
elseif arg0 == "say_buddy" then
return et_ClientSay( clientNum, et.SAY_BUDDY, et.ConcatArgs(1))
elseif arg0 == "say_teamnl" then
return et_ClientSay( clientNum, et.SAY_TEAMNL, et.ConcatArgs(1))
end
-- et_ClientSay wrapper end
</pre>

[[Category:ETPro]]
[[Category:ETPro:Mods]]

Lua Mod API

2006-04-26T07:54:47Z

=FF=im2good4u: aded totural page

__NOEDITSECTION__
ETPro now supports serverside mods via the [http://www.lua.org/ lua] scripting language. For more information about lua, visit the [http://www.lua.org/manual/5.0/ Reference manual], the online edition of the book [http://www.lua.org/pil/ Programming in Lua] or the [http://lua-users.org/wiki/ lua-users wiki].

ETPro has an embedded lua 5.0.2 interpreter, and if present will load user-defined scripts from the etpro directory. ETPro also provides an "et" library of function calls for lua to access the server engine, and provides callbacks so a serverside mod may trigger on specific server events.

The following standard lua libraries are initialized by default and available to ETPro lua scripts:
[http://www.lua.org/manual/5.0/manual.html#5.1 basic], [http://www.lua.org/manual/5.0/manual.html#5.4 table], [http://www.lua.org/manual/5.0/manual.html#5.6 i/o], [http://www.lua.org/manual/5.0/manual.html#5.3 string], [http://www.lua.org/manual/5.0/manual.html#5.5 math].

A list of [[ETPro]] mods can be found [[:Category:ETPro:Mods|here]].

A Totural for [[ETPro]] [http://www.lua.org/ lua] scripting for nubs can be found [[:Category:ETPro:Lua_Noob|here]].

API Requests can be discussed [http://wolfwiki.anime.net/index.php/Talk:ETPro:Lua_Mod_API here].

==client commands==
===lua_status===
:lists all currently loaded lua modules.
:''lua mods cannot override this client command.''

==server commands==
===lua_status===
:lists all currently loaded lua modules.

==cvars==
===lua_modules===
:(default "", disabled)
:space separated list of lua modules for ETPro to load. modules will be run in the order listed.

===lua_allowedmodules===
:(default "", disabled)
:if set, only lua modules with the matching sha1 signatures listed in this cvar will be allowed to load.
 
:changing either cvar will cause all currently loaded modules to :quit and be unloaded until the next map_restart. 
 

==et library calls==

===modules===
et.RegisterModname( '''modname''' )
:Registers a descriptive string '''modname''' for this mod.
'''vmnumber''' = et.FindSelf()
:Returns a number indicating the VM slot the current mod is loaded into.
'''modname''', '''signature''' = et.FindMod( '''vmnumber''' )
:Returns the '''modname''' and sha1 '''signature''' for the mod loaded in the VM slot '''vmnumber'''. Returns nil, nil if the VM slot is invalid.
'''success''' = et.IPCSend( '''vmnumber''', '''message''' )
:Sends the string '''message''' to the mod in the VM slot indicated by '''vmnumber'''. The mod receiving '''message''' must have an ''et_IPCReceive()'' callback. If the message is successfully sent, '''success''' will be 1. On failure it will be 0.
 

===printing===
et.G_Print( '''text''' )
:Prints the string '''text''' to the server console.
et.G_LogPrint( '''text''' )
:Prints the string '''text''' to the server console and writes it to the server log.
 

===argument handling===
These functions are to be used within the [[#commands|command callback functions]]. 
'''args''' = et.ConcatArgs( '''index''' )
:Returns all arguments beginning from '''index''' concatenated into a single string '''args'''
'''argcount''' = et.trap_Argc()
:Returns a number indicating the number of command line arguments in the command buffer.
'''arg''' = et.trap_Argv( '''argnum''' )
:Returns the contents of the command line argument '''argnum'''.
 

===cvars===
'''cvarvalue''' = et.trap_Cvar_Get( '''cvarname''' )
:Returns the value of the cvar '''cvarname''' as a string. If there is no cvar named '''cvarname''', returns a zero length string.
et.trap_Cvar_Set( '''cvarname''', '''cvarvalue''' )
:Sets the cvar '''cvarname''' to '''cvarvalue'''
 

===configstrings===
'''configstringvalue''' = et.trap_GetConfigstring( '''index''' )
:Returns the string '''configstringvalue''' containing the contents of the configstring '''index'''
et.trap_SetConfigstring( '''index''', '''configstringvalue''' )
:Sets the configstring '''index''' to the string '''configstringvalue'''
 

===server===
et.trap_SendConsoleCommand( '''when''', '''command''' )
:Sends the command '''command''' to the server console, to be executed '''when''' (see et.EXEC_* constants)
 

===clients===
et.trap_DropClient( '''clientnum''', '''reason''', '''ban_time''' )
:Disconnects '''clientnum''' from the server, with descriptive string '''reason''' reported to clients. '''ban_time''' is the time in seconds to ban the client from the server. '''ban_time''' is optional and may be entirely omitted, in which case the ban time defaults to the cvar ''b_defaultbantime''
et.trap_SendServerCommand( '''clientnum''', '''[[SendServerCommand|command]]''' )
:Sends the command '''[[SendServerCommand|command]]''' to the client '''clientnum'''. If '''clientnum''' is -1, the '''[[SendServerCommand|command]]''' is broadcast to all connected clients.
et.G_Say( '''clientNum''', '''mode''', '''text''' )
:Sends a chat command on behalf of client '''clientNum''' with the mode '''mode''' (see et.SAY_* constants) and chat text '''text'''.
et.ClientUserinfoChanged( '''clientNum''' )
:Loads the new Userinfo of '''clientNum''' and stores it in the configstring and client variables
 

===userinfo===
'''userinfo''' = et.trap_GetUserinfo( '''clientnum''' )
:Returns the contents of the userinfo string for the client '''clientnum'''
et.trap_SetUserinfo( '''clientnum''', '''userinfo''' )
:Sets the userinfo string for the client '''clientnum''' to '''userinfo'''
 

===string utility functions===
'''infostring''' = et.Info_RemoveKey( '''infostring''', '''key''' )
:Removes key '''key''' from infostring '''infostring''' and returns the modified infostring.
'''infostring''' = et.Info_SetValueForKey( '''infostring''', '''key''', '''value''' )
:Sets the key '''key''' in the infostring '''infostring''' to '''value''' and returns the modified infostring. If '''value''' is an empty string, '''key''' is removed from the string.
'''keyvalue''' = et.Info_ValueForKey( '''infostring''', '''key''' )
:Returns the value of the key '''key''' in the infostring '''infostring'''. If '''key''' is not present in the string, an empty string is returned.
'''cleanstring''' = et.Q_CleanStr( '''string''' )
:Returns '''string''' stripped of all color codes
 

===ET filesystem===
'''fd''', '''len''' = et.trap_FS_FOpenFile( '''filename''', '''mode''' )
:Attempts to open the file '''filename''' with the access mode '''mode''' (see et.FS_ constants). Returns the filedescriptor '''fd''' and file length '''len'''. On error, '''len''' returns -1.
'''filedata''' = et.trap_FS_Read( fd, count )
:Reads '''count''' bytes from filedescriptor '''fd'''.
'''count''' = et.trap_FS_Write( '''filedata''', '''count''', '''fd''' )
:Attempts to write '''count''' bytes of '''filedata''' to filedescriptor '''fd'''. Returns number of bytes successfully written.
et.trap_FS_Rename( '''oldname''', '''newname''' )
:Renames file '''oldname''' to '''newname'''.
et.trap_FS_FCloseFile( '''fd''' )
:Closes filedescriptor '''fd'''
 

===indexes===
'''soundindex''' = et.G_SoundIndex( '''filename''' )
:Returns an index to the soundfile indicated by '''filename'''
'''modelindex''' = et.G_ModelIndex( '''filename''' )
:Returns an index to the model indicated by '''filename'''
 

===sound===
et.G_globalSound( '''sound''' )
:Plays the global sound indicated by the filename '''sound'''.
et.G_Sound( '''entnum''', '''soundindex''' )
:Plays the sound '''soundindex''' at the location of entity '''entnum'''
 

===miscellaneous===
'''milliseconds''' = et.trap_Milliseconds()
:Returns a number indicating the current server time in milliseconds.
et.G_Damage( '''target''', '''inflictor''', '''attacker''', '''damage''', '''[[etdamage|dflags]]''', '''[[etdamage|mod]]''' )
:Does '''damage''' amount of damage on '''target''' inflicted by '''inflictor''' and cased by '''attacker'''
:'''target''', '''inflictor''', '''attacker''' are entity numbers
:'''[[etdamage|dflags]]''' is a [[Bitmask-cvar|bitflag]] number to decide how the damage is inflickted, see '''[[etdamage|dflags]]''' [[etdamage|flaglist]]
:'''[[etdamage|mod]]''' is a number from 0 up to 64 o set the type of damage, see '''[[etdamage|mod]]''' [[etdamage|list]]
 

===entities===
'''entnum''' = et.G_Spawn()
:Spawns a new entity and returns the new entity number.
'''entnum''' = et.G_TempEntity( '''origin''', '''event''' )
:Spawns a new TempEntity of event type '''event''' and places it at '''origin''' in the world.
:'''Warning:''' up to and including ETPro 3.2.4 the signature of the method is broken and expects four instead of two parameters. To successfully call it, you need to prepend the parameter list with two dummy parameters like et.G_TempEntity( 0, 0, origin, event ). Use this method with care, because in future ETPro versions it will probably be corrected to the one stated above and might break your script.
et.G_FreeEntity( '''entnum''' )
:Frees the entity '''entnum'''
'''spawnval''' = et.G_GetSpawnVar( '''entnum''', '''key''' )
:Returns the value of spawnvar '''key''' for entity '''entnum'''
et.G_SetSpawnVar( '''entnum''', '''key''', '''value''' )
:Sets the spawnvar '''key''' to '''value''' for entity '''entnum'''
'''integer entnum''' = et.G_SpawnGEntityFromSpawnVars( string spawnvar, string spawnvalue, ... )
:This function can only be called inside the '''et_InitGame''' callback
et.trap_LinkEntity( '''entnum''' )
:Links the entity '''entnum'''
et.trap_UnlinkEntity( '''entnum''' )
:Unlinks the entity '''entnum'''
'''(variable)''' = et.gentity_get ( '''entnum''', '''[[Fieldname]]''' '',arrayindex'' )
:Gets the value of '''[[Fieldname]]''' from entity '''entnum''' out of the g_entity struct. For NULL entities or clients, ''nil'' is returned. 
:''arrayindex'' is used to specify which element of an array entity field to get. It is required when accessing array type fields. Entity field array indexes start at 0.
et.gentity_set( '''entnum''', '''[[Fieldname]]''', ''arrayindex,'' '''(value)''' )
:Sets the value of '''[[Fieldname]]''' from entity '''entnum''' in the g_entity struct to '''(value)'''
:''arrayindex'' is used to specify which element of an array entity field to set.
et.G_AddEvent( '''ent''', '''event''', '''eventparm'''' )
:Adds event '''event''' whit eventparameter '''eventparm'''' to entity '''ent'''
 

==callbacks==

===qagame execution===
et_InitGame( '''levelTime''', '''randomSeed''', '''restart''' )
:Called when qagame initializes. '''levelTime''' is the current level time in milliseconds. '''randomSeed''' is a number that can be used to seed random number generators. '''restart''' indicates if et_InitGame() is being called due to a map restart (1) or not (0).
et_ShutdownGame( '''restart''' )
:Called when qagame shuts down. '''restart''' indicates if the shutdown is being called due to a map_restart (1) or not (0).
et_RunFrame( '''levelTime''' )
:Called when qagame runs a server frame. '''levelTime''' is the current level time in milliseconds.
et_Quit()
:Called when ETPro unloads the mod. The mod should close all open filedescriptors and perform all cleanup.
 

===client management===
'''rejectreason''' = et_ClientConnect( '''clientNum''', '''firstTime''', '''isBot''' )
:Called when a client attempts to connect to the server. '''clientNum''' is the client slot id, '''firstTime''' indicates if this is a new connection (1) or a reconnection (0). '''isBot''' indicates if the client is a bot (1) or not (0). If the mod accepts the connection, it should return nil. Otherwise, the mod should return a string describing the reason the client connection was rejected.
et_ClientDisconnect( '''clientNum''' )
:Called when a client disconnects. '''clientNum''' is the client slot id.
et_ClientBegin( '''clientNum''' )
:Called when a client begins (becomes active, and enters the gameworld). '''clientNum''' is the client slot id.
et_ClientUserinfoChanged( '''clientNum''' )
:Called when a client's Userinfo string has changed. '''clientNum''' is the client slot id.
et_ClientSpawn( '''clientNum''', '''revived''' )
:Called when a client is spawned. '''clientNum''' is the client slot id. '''revived''' is 1 if the client was spawned by beeying revived.
 

===commands===
'''intercepted''' = et_ClientCommand( '''clientNum''', '''command''' )
:Called when a command is received from a client. '''clientNum''' is the client slot id. '''command''' is the command. The mod should return 1 if the command was intercepted by the mod, and 0 if the command was ignored by the mod and should be passed through to the server (and other mods in the chain).
:The actual command can be accessed through the [[#argument_handling|argument handling]] functions, as seen in the [[ETPro:Lua Sample Code]].
'''intercepted''' = et_ConsoleCommand()
:Called when a command is entered on the server console. The mod should return 1 if the command was intercepted by the mod, and 0 if the command was ignored by the mod and should be passed through to the server (and other mods in the chain).
:The actual command can be accessed through the [[#argument_handling|argument handling]] functions, as seen in the [[ETPro:Lua Sample Code]].
 

===xp===
et_UpgradeSkill( '''cno''', '''skill''' )
:Called when client on slot '''cno''' gets a skill upgrade on skill '''skill''', return -1 to override (abort) the qagame function, anything else to "passthrough" callback may modify skills (or do anything else it wants) during passthrough.
et_UpgradeSkill( '''cno''', '''skill''' )
:Called when client '''cno''' his skill level of '''skill''' is set, return -1 to override (abort) the qagame function, anything else to "passthrough" callback may modify skills (or do anything else it wants) during passthrough.

===miscellaneous===
et_IPCReceive( '''vmnumber''', '''message''' )
:Called when another mod sends an et.IPCSend() message to this mod. '''vmnumber''' is the VM slot number of the sender, and '''message''' is the message.
et_Print( '''text''' )
:Called whenever the server or qagame prints a string to the console.
et_Obituary( '''victim''', '''killer''', '''meansOfDeath''' )
:Called whenever a player is killed.
 

==predefined constants==
et.EXEC_NOW 
et.EXEC_INSERT 
et.EXEC_APPEND 
et.FS_READ 
et.FS_WRITE 
et.FS_APPEND 
et.FS_APPEND_SYNC 
et.SAY_ALL 
et.SAY_TEAM 
et.SAY_BUDDY 
et.SAY_TEAMNL 
 
et.HOSTARCH
:set to WIN32 or UNIX depending on the host architecture qagame is running on.
LUA_PATH
:set to fs_homepath/fs_game/?.lua in order to ease use of the [http://www.lua.org/pil/8.1.html require] function.
 

==configs==
If a config is loaded, all modules are shutdown and reloaded. If a ''certified'' config is loaded, all modules are shutdown and reloaded, and additionally the following functions are disabled: '''require()''', '''loadfile()''', '''loadlib()''', '''loadstring()''', '''dofile()''' 
 

==caveats==
Like qagame, lua modules are unloaded and reloaded on map_restart and map changes. This means that all global variables and other information is lost. Mods may choose to store persistent data in cvars or external files. 
 

==FAQ==

Q: OMG I hate the libary prefix et.* on everything!!11!1oneone 
A: table.foreach(et, function (func, value) _G[func] = value; end)

Q: How do a re-load my lua file without restarting the whole server ? 
A: change maps or map_restart

Q: Can I see some sample code? 
A: [[ETPro:Lua Sample Code]]

Q: Is there a list of [[ETPro]] mods? 
A: Yes, [[:Category:ETPro:Mods|here]].

Q: OMG my mod doesn't work! 
A: Make sure you added your mod's filename to the lua_modules cvar (e.g. set lua_modules mymod.lua).

Q: OMG why has et_ClientSay been removed? 
A: Thats a secret but, to keep the function as it was, just add the following code to your et_ClientCommand() function 
<pre> -- et_ClientSay had to be removed in order to intercept all commands
-- so here's a wrapper for that
arg0 = et.trap_Argv(0) -- get the main command

if arg0 == "say" then
return et_ClientSay( clientNum, et.SAY_ALL, et.ConcatArgs(1))
elseif arg0 == "say_team" then
return et_ClientSay( clientNum, et.SAY_TEAM, et.ConcatArgs(1))
elseif arg0 == "say_buddy" then
return et_ClientSay( clientNum, et.SAY_BUDDY, et.ConcatArgs(1))
elseif arg0 == "say_teamnl" then
return et_ClientSay( clientNum, et.SAY_TEAMNL, et.ConcatArgs(1))
end
-- et_ClientSay wrapper end
</pre>

[[Category:ETPro]]
[[Category:ETPro:Mods]]

Fieldname

2006-03-08T17:51:34Z

=FF=im2good4u: fixors

__NOEDITSECTION__
==Entity Fieldnames==
List of fields supported by [[ETPro:Lua Mod API#entities|et.gentity_get() and et.gentity_set()]] functions 
<pitatable columns=3 headlines="field;type;access" widths="180;120;60" headerfontcolor="#FFFFFF">
activator;entity;RO;
chain;entity;RW;
classname;string;RW;
client.inactivityTime;integer;RW;
client.inactivityWarning;qboolean;RW;
clipmask;integer;?;
closespeed;float;RW;
count;integer;RW;
count2;integer;RW;
damage;integer;RW;
deathType;meansOfDeath_t;RW;
delay;float;RW;
dl_atten;integer;RW;
dl_color;vec3;RW;
dl_shader;string;RO;
dl_stylestring;string;RO;
duration;float;RW;
end_size;integer;RW;
enemy;entity;RW;
flags;bitflag;RO;
harc;float;RW;
health;integer;RW;
inuse;qboolean;RO;
isProp;qboolean;RO;
item;string;RW;
key;integer;RW;
message;string;RW;
methodOfDeath;integer;RW;
mg42BaseEnt;integer;RW;
missionLevel;integer;RW;
model;string;RO;
model2;string;RO;
nextTrain;entity;RW;
noise_index;integer;RW;
origin;vec3;RW;
pers.connected;connected_t;?;
pers.netname;string;?;
pers.localClient;qboolean;?;
pers.initialSpawn;qboolean;?;
pers.enterTime;integer;?;
pers.connectTime;integer;?;
pers.teamState.state;teamstatestate_t;?;
pers.voteCount;integer;?;
pers.teamVoteCount;integer;?;
pers.complaints;integer;?;
pers.complaintClient;integer;?;
pers.complaintEndTime;integer;?;
pers.lastReinforceTime;integer;?;
pers.applicationClient;integer;?;
pers.applicationEndTime;integer;?;
pers.invitationClient;integer;?;
pers.invitationEndTime;integer;?;
pers.propositionClient;integer;?;
pers.propositionClient2;integer;?;
pers.propositionEndTime;integer;?;
pers.autofireteamEndTime;integer;?;
pers.autofireteamCreateEndTime;integer;?;
pers.autofireteamJoinEndTime;integer;?;
pers.lastSpawnTime;integer;?;
pers.ready;qboolean;?;
prevTrain;entity;RW;
props_frame_state;integer;RO;
ps.stats;integer array;RW;
ps.persistant;integer array;RW;
ps.ping;integer;?;
ps.powerups;integer array;RW;
ps.ammo;integer array;RW;
ps.ammoclip;integer array;RW;
r.absmax;vec3;RO;
r.absmin;vec3;RO;
r.bmodel;qboolean;RO;
r.contents;integer;RW;
r.currentAngles;vec3;RW;
r.currentOrigin;vec3;RW;
r.eventTime;integer;RW;
r.linkcount;integer;RO;
r.linked;qboolean;RO;
r.maxs;vec3;RW;
r.mins;vec3;RW;
r.ownerNum;integer;RW;
r.singleClient;integer;RW;
r.svFlags;integer;RW;
r.worldflags;integer;RO;
radius;integer;RW;
random;float;RW;
rotate;vec3;RW;
s.angles;vec3;RW;
s.angles2;vec3;RW;
s.apos;trajectory;RW;
s.clientNum;integer;RW;
s.constantLight;integer;RW;
s.density;integer;RW;
s.dl_intensity;integer;RW;
s.dmgFlags;integer;RW;
s.eFlags;integer;RW;
s.eType;integer;?;
s.effect1Time;integer;RW;
s.effect2Time;integer;RW;
s.effect3Time;integer;RW;
s.frame;integer;RW;
s.groundEntityNum;integer;RO;
s.loopSound;integer;RW;
s.modelindex;integer;RW;
s.modelindex2;integer;RW;
s.number;integer;RO;
s.onFireEnd;integer;RW;
s.onFireStart;integer;RW;
s.origin;vec3;?;
s.origin2;vec3;?;
s.pos;trajectory;RW;
s.powerups;integer;RO;
s.solid;integer;RW;
s.teamNum;integer;RW;
s.time;integer;RW;
s.time2;integer;RW;
s.weapon;integer;RO;
scriptName;string;RO;
sess.sessionTeam;team_t;RW;
sess.spectatorTime;integer;RW;
sess.spectatorState;spectatorState_t;RW;
sess.spectatorClient;integer;RW;
sess.latchSpectatorClient;integer;RW;
sess.playerType;integer;RW;
sess.playerWeapon;integer;RW;
sess.playerWeapon2;integer;RW;
sess.spawnObjectiveIndex;integer;RW;
sess.latchPlayerType;integer;RW;
sess.latchPlayerWeapon;integer;RW;
sess.latchPlayerWeapon2;integer;RW;
sess.damage_given;integer;RW;
sess.damage_received;integer;RW;
sess.deaths;integer;RW;
sess.game_points;integer;RW;
sess.gibs;integer;RW;
sess.kills;integer;RW;
sess.medals;integer array;RW;
sess.muted;qboolean;RW;
sess.rank;integer;RW;
sess.referee;integer;RW;
sess.rounds;integer;RW;
sess.semiadmin;integer;RW;
sess.skill;integer array;RW;
sess.spec_invite;integer;RW;
sess.spec_team;integer;RW;
sess.suicides;integer;RW;
sess.team_damage;integer;RW;
sess.team_kills;integer;RW;
sess.team_received;integer;RW;
sess.aWeaponStats;weapon_stat_t;RW;
spawnflags;integer;RO;
spawnitem;string;RO;
speed;float;RW;
splashDamage;integer;RW;
splashMethodOfDeath;integer;RW;
splashRadius;integer;RW;
start_size;integer;RW;
tagName;string;RO;
tagParent;entity;RW;
takedamage;boolean;RW;
tankLink;entity;RW;
target;string;RW;
TargetAngles;vec3;RW;
TargetFlag;integer;RO;
targetname;string;RO;
teamchain;entity;RW;
teammaster;entity;RW;
track;string;RO;
varc;float;RW;
wait;float;RW;
waterlevel;integer;RO;
watertype;integer;RO;
</pitatable>
:''note'': all the sess.* fields will return nil unless the entity is associated with client slot < sv_maxclients.
:''note'': all array variables need tobe called or get whit an additional parameter

----

==ET variable types==

===qboolean===
:a '''qboolean''' is a bool made of a number, it has 2 valeus 1 or 0
:0 is considered as false
:1 is considered as true

----

===vec3===
:a '''vec3_t''' is a 3-element array of numbers (C definition: typedef float vec3_t[3];). It is usually used to store and process coordinates in 3D space. 
:In etpro-lua a vector is an array (table indexed by integers) containing 3 numbers. It can be accessed by
:doing:
<pre>
origin = et.gentity_get(entNum,"r.currentOrigin") --a vec3 value
x,y,z = origin[1],origin[2],origin[3]</pre>

----

===trajectory===
:a '''trajectory''' is returned as a lua table described below
<pre>{
trDuration = <number>, --- int
trTime = <number>, -- int
trType = <number>, -- see below for allowed values
trBase = <vec3_t>, -- vec3, as described above
trDelta = <vec3_t> -- also a vec3
}</pre>
: the allowed values for trType (along with the enum names and original comments from the ET source), are as follows. Note
: that not all values make sense for all entity types
<pitatable columns=3 headlines="number;type;discription" widths="40;160;450" headerfontcolor="#FFFFFF">
1;TR_STATIONARY;
2;TR_INTERPOLATE;non-parametric, but interpolate between snapshots;
3;TR_LINEAR;
4;TR_LINEAR_STOP;
5;TR_LINEAR_STOP_BACK;reverse movement can be different than forward;
6;TR_SINE;value = base + sin( time / duration ) * delta;
7;TR_GRAVITY;
8;TR_GRAVITY_LOW;
9;TR_GRAVITY_FLOAT;super low grav with no gravity acceleration;
10;TR_GRAVITY_PAUSED;has stopped, but trace to see if it should be switched back to TR_GRAVITY;
11;TR_ACCELERATE;
12;TR_DECCELERATE;
13;TR_SPLINE;
14;TR_LINEAR_PATH;
</pitatable>

----

===entity===
:The fields listed as having type '''enitity''' return an entity number or nil. Entity numbers are integers from 0 through 1023. Some of the entity numbers have special meanings:
:0 - (sv_privateclients - 1) are reserved for clients who connect with the private slot password
:0 - 63 are reserved for clients. A client's entity number is also its client number (as shown by /players for example)
:1022 is the '''worldspawn''' entity
:1023 is '''ENTITYNUM_NONE''' which is used instead of null in C under some circumstances to indicate no entity. This is needed where an entity number will be passed over the network.
:''Note'': Some other fields not listed as type 'entity' may take an entity number value. '''mg42BaseEnt''' and '''s.number''' are examples. 

----

===meansOfDeath===
:a '''meansOfDeath_t''' is a number indicating the [[etdamage|Method of Death]] Click [[etdamage|here]] for a list whit posable value's

[[Category:ETPro]]
[[Category:ETPro:Mods]]

Fieldname

2006-03-08T17:51:01Z

=FF=im2good4u: added qboolean,meansOfDeath_t

__NOEDITSECTION__
==Entity Fieldnames==
List of fields supported by [[ETPro:Lua Mod API#entities|et.gentity_get() and et.gentity_set()]] functions 
<pitatable columns=3 headlines="field;type;access" widths="180;120;60" headerfontcolor="#FFFFFF">
activator;entity;RO;
chain;entity;RW;
classname;string;RW;
client.inactivityTime;integer;RW;
client.inactivityWarning;qboolean;RW;
clipmask;integer;?;
closespeed;float;RW;
count;integer;RW;
count2;integer;RW;
damage;integer;RW;
deathType;meansOfDeath_t;RW;
delay;float;RW;
dl_atten;integer;RW;
dl_color;vec3;RW;
dl_shader;string;RO;
dl_stylestring;string;RO;
duration;float;RW;
end_size;integer;RW;
enemy;entity;RW;
flags;bitflag;RO;
harc;float;RW;
health;integer;RW;
inuse;qboolean;RO;
isProp;qboolean;RO;
item;string;RW;
key;integer;RW;
message;string;RW;
methodOfDeath;integer;RW;
mg42BaseEnt;integer;RW;
missionLevel;integer;RW;
model;string;RO;
model2;string;RO;
nextTrain;entity;RW;
noise_index;integer;RW;
origin;vec3;RW;
pers.connected;connected_t;?;
pers.netname;string;?;
pers.localClient;qboolean;?;
pers.initialSpawn;qboolean;?;
pers.enterTime;integer;?;
pers.connectTime;integer;?;
pers.teamState.state;teamstatestate_t;?;
pers.voteCount;integer;?;
pers.teamVoteCount;integer;?;
pers.complaints;integer;?;
pers.complaintClient;integer;?;
pers.complaintEndTime;integer;?;
pers.lastReinforceTime;integer;?;
pers.applicationClient;integer;?;
pers.applicationEndTime;integer;?;
pers.invitationClient;integer;?;
pers.invitationEndTime;integer;?;
pers.propositionClient;integer;?;
pers.propositionClient2;integer;?;
pers.propositionEndTime;integer;?;
pers.autofireteamEndTime;integer;?;
pers.autofireteamCreateEndTime;integer;?;
pers.autofireteamJoinEndTime;integer;?;
pers.lastSpawnTime;integer;?;
pers.ready;qboolean;?;
prevTrain;entity;RW;
props_frame_state;integer;RO;
ps.stats;integer array;RW;
ps.persistant;integer array;RW;
ps.ping;integer;?;
ps.powerups;integer array;RW;
ps.ammo;integer array;RW;
ps.ammoclip;integer array;RW;
r.absmax;vec3;RO;
r.absmin;vec3;RO;
r.bmodel;qboolean;RO;
r.contents;integer;RW;
r.currentAngles;vec3;RW;
r.currentOrigin;vec3;RW;
r.eventTime;integer;RW;
r.linkcount;integer;RO;
r.linked;qboolean;RO;
r.maxs;vec3;RW;
r.mins;vec3;RW;
r.ownerNum;integer;RW;
r.singleClient;integer;RW;
r.svFlags;integer;RW;
r.worldflags;integer;RO;
radius;integer;RW;
random;float;RW;
rotate;vec3;RW;
s.angles;vec3;RW;
s.angles2;vec3;RW;
s.apos;trajectory;RW;
s.clientNum;integer;RW;
s.constantLight;integer;RW;
s.density;integer;RW;
s.dl_intensity;integer;RW;
s.dmgFlags;integer;RW;
s.eFlags;integer;RW;
s.eType;integer;?;
s.effect1Time;integer;RW;
s.effect2Time;integer;RW;
s.effect3Time;integer;RW;
s.frame;integer;RW;
s.groundEntityNum;integer;RO;
s.loopSound;integer;RW;
s.modelindex;integer;RW;
s.modelindex2;integer;RW;
s.number;integer;RO;
s.onFireEnd;integer;RW;
s.onFireStart;integer;RW;
s.origin;vec3;?;
s.origin2;vec3;?;
s.pos;trajectory;RW;
s.powerups;integer;RO;
s.solid;integer;RW;
s.teamNum;integer;RW;
s.time;integer;RW;
s.time2;integer;RW;
s.weapon;integer;RO;
scriptName;string;RO;
sess.sessionTeam;team_t;RW;
sess.spectatorTime;integer;RW;
sess.spectatorState;spectatorState_t;RW;
sess.spectatorClient;integer;RW;
sess.latchSpectatorClient;integer;RW;
sess.playerType;integer;RW;
sess.playerWeapon;integer;RW;
sess.playerWeapon2;integer;RW;
sess.spawnObjectiveIndex;integer;RW;
sess.latchPlayerType;integer;RW;
sess.latchPlayerWeapon;integer;RW;
sess.latchPlayerWeapon2;integer;RW;
sess.damage_given;integer;RW;
sess.damage_received;integer;RW;
sess.deaths;integer;RW;
sess.game_points;integer;RW;
sess.gibs;integer;RW;
sess.kills;integer;RW;
sess.medals;integer array;RW;
sess.muted;qboolean;RW;
sess.rank;integer;RW;
sess.referee;integer;RW;
sess.rounds;integer;RW;
sess.semiadmin;integer;RW;
sess.skill;integer array;RW;
sess.spec_invite;integer;RW;
sess.spec_team;integer;RW;
sess.suicides;integer;RW;
sess.team_damage;integer;RW;
sess.team_kills;integer;RW;
sess.team_received;integer;RW;
sess.aWeaponStats;weapon_stat_t;RW;
spawnflags;integer;RO;
spawnitem;string;RO;
speed;float;RW;
splashDamage;integer;RW;
splashMethodOfDeath;integer;RW;
splashRadius;integer;RW;
start_size;integer;RW;
tagName;string;RO;
tagParent;entity;RW;
takedamage;boolean;RW;
tankLink;entity;RW;
target;string;RW;
TargetAngles;vec3;RW;
TargetFlag;integer;RO;
targetname;string;RO;
teamchain;entity;RW;
teammaster;entity;RW;
track;string;RO;
varc;float;RW;
wait;float;RW;
waterlevel;integer;RO;
watertype;integer;RO;
</pitatable>
:''note'': all the sess.* fields will return nil unless the entity is associated with client slot < sv_maxclients.
:''note'': all array variables need tobe called or get whit an additional parameter

----

==ET variable types==

===qboolean===
:a '''qboolean''' is a bool made of a number, it has 2 valeus 1 or 0
:0 is considered as false
:1 is considered as true

===vec3===
:a '''vec3_t''' is a 3-element array of numbers (C definition: typedef float vec3_t[3];). It is usually used to store and process coordinates in 3D space. 
:In etpro-lua a vector is an array (table indexed by integers) containing 3 numbers. It can be accessed by
:doing:
<pre>
origin = et.gentity_get(entNum,"r.currentOrigin") --a vec3 value
x,y,z = origin[1],origin[2],origin[3]</pre>

----

===trajectory===
:a '''trajectory''' is returned as a lua table described below
<pre>{
trDuration = <number>, --- int
trTime = <number>, -- int
trType = <number>, -- see below for allowed values
trBase = <vec3_t>, -- vec3, as described above
trDelta = <vec3_t> -- also a vec3
}</pre>
: the allowed values for trType (along with the enum names and original comments from the ET source), are as follows. Note
: that not all values make sense for all entity types
<pitatable columns=3 headlines="number;type;discription" widths="40;160;450" headerfontcolor="#FFFFFF">
1;TR_STATIONARY;
2;TR_INTERPOLATE;non-parametric, but interpolate between snapshots;
3;TR_LINEAR;
4;TR_LINEAR_STOP;
5;TR_LINEAR_STOP_BACK;reverse movement can be different than forward;
6;TR_SINE;value = base + sin( time / duration ) * delta;
7;TR_GRAVITY;
8;TR_GRAVITY_LOW;
9;TR_GRAVITY_FLOAT;super low grav with no gravity acceleration;
10;TR_GRAVITY_PAUSED;has stopped, but trace to see if it should be switched back to TR_GRAVITY;
11;TR_ACCELERATE;
12;TR_DECCELERATE;
13;TR_SPLINE;
14;TR_LINEAR_PATH;
</pitatable>

----

===entity===
:The fields listed as having type '''enitity''' return an entity number or nil. Entity numbers are integers from 0 through 1023. Some of the entity numbers have special meanings:
:0 - (sv_privateclients - 1) are reserved for clients who connect with the private slot password
:0 - 63 are reserved for clients. A client's entity number is also its client number (as shown by /players for example)
:1022 is the '''worldspawn''' entity
:1023 is '''ENTITYNUM_NONE''' which is used instead of null in C under some circumstances to indicate no entity. This is needed where an entity number will be passed over the network.
:''Note'': Some other fields not listed as type 'entity' may take an entity number value. '''mg42BaseEnt''' and '''s.number''' are examples. 

===meansOfDeath===
:a '''meansOfDeath_t''' is a number indicating the [[etdamage|Method of Death]] Click [[etdamage|here]] for a list whit posable value's

[[Category:ETPro]]
[[Category:ETPro:Mods]]

Fieldname

2006-03-08T17:37:46Z

=FF=im2good4u: small fixors

==Entity Fieldnames==
List of fields supported by [[ETPro:Lua Mod API#entities|et.gentity_get() and et.gentity_set()]] functions 
<pitatable columns=3 headlines="field;type;access" widths="180;120;60" headerfontcolor="#FFFFFF">
activator;entity;RO;
chain;entity;RW;
classname;string;RW;
client.inactivityTime;integer;RW;
client.inactivityWarning;qboolean;RW;
clipmask;integer;?;
closespeed;float;RW;
count;integer;RW;
count2;integer;RW;
damage;integer;RW;
deathType;meansOfDeath_t;RW;
delay;float;RW;
dl_atten;integer;RW;
dl_color;vec3;RW;
dl_shader;string;RO;
dl_stylestring;string;RO;
duration;float;RW;
end_size;integer;RW;
enemy;entity;RW;
flags;bitflag;RO;
harc;float;RW;
health;integer;RW;
inuse;qboolean;RO;
isProp;qboolean;RO;
item;string;RW;
key;integer;RW;
message;string;RW;
methodOfDeath;integer;RW;
mg42BaseEnt;integer;RW;
missionLevel;integer;RW;
model;string;RO;
model2;string;RO;
nextTrain;entity;RW;
noise_index;integer;RW;
origin;vec3;RW;
pers.connected;connected_t;?;
pers.netname;string;?;
pers.localClient;qboolean;?;
pers.initialSpawn;qboolean;?;
pers.enterTime;integer;?;
pers.connectTime;integer;?;
pers.teamState.state;teamstatestate_t;?;
pers.voteCount;integer;?;
pers.teamVoteCount;integer;?;
pers.complaints;integer;?;
pers.complaintClient;integer;?;
pers.complaintEndTime;integer;?;
pers.lastReinforceTime;integer;?;
pers.applicationClient;integer;?;
pers.applicationEndTime;integer;?;
pers.invitationClient;integer;?;
pers.invitationEndTime;integer;?;
pers.propositionClient;integer;?;
pers.propositionClient2;integer;?;
pers.propositionEndTime;integer;?;
pers.autofireteamEndTime;integer;?;
pers.autofireteamCreateEndTime;integer;?;
pers.autofireteamJoinEndTime;integer;?;
pers.lastSpawnTime;integer;?;
pers.ready;qboolean;?;
prevTrain;entity;RW;
props_frame_state;integer;RO;
ps.stats;integer array;RW;
ps.persistant;integer array;RW;
ps.ping;integer;?;
ps.powerups;integer array;RW;
ps.ammo;integer array;RW;
ps.ammoclip;integer array;RW;
r.absmax;vec3;RO;
r.absmin;vec3;RO;
r.bmodel;qboolean;RO;
r.contents;integer;RW;
r.currentAngles;vec3;RW;
r.currentOrigin;vec3;RW;
r.eventTime;integer;RW;
r.linkcount;integer;RO;
r.linked;qboolean;RO;
r.maxs;vec3;RW;
r.mins;vec3;RW;
r.ownerNum;integer;RW;
r.singleClient;integer;RW;
r.svFlags;integer;RW;
r.worldflags;integer;RO;
radius;integer;RW;
random;float;RW;
rotate;vec3;RW;
s.angles;vec3;RW;
s.angles2;vec3;RW;
s.apos;trajectory;RW;
s.clientNum;integer;RW;
s.constantLight;integer;RW;
s.density;integer;RW;
s.dl_intensity;integer;RW;
s.dmgFlags;integer;RW;
s.eFlags;integer;RW;
s.eType;integer;?;
s.effect1Time;integer;RW;
s.effect2Time;integer;RW;
s.effect3Time;integer;RW;
s.frame;integer;RW;
s.groundEntityNum;integer;RO;
s.loopSound;integer;RW;
s.modelindex;integer;RW;
s.modelindex2;integer;RW;
s.number;integer;RO;
s.onFireEnd;integer;RW;
s.onFireStart;integer;RW;
s.origin;vec3;?;
s.origin2;vec3;?;
s.pos;trajectory;RW;
s.powerups;integer;RO;
s.solid;integer;RW;
s.teamNum;integer;RW;
s.time;integer;RW;
s.time2;integer;RW;
s.weapon;integer;RO;
scriptName;string;RO;
sess.sessionTeam;team_t;RW;
sess.spectatorTime;integer;RW;
sess.spectatorState;spectatorState_t;RW;
sess.spectatorClient;integer;RW;
sess.latchSpectatorClient;integer;RW;
sess.playerType;integer;RW;
sess.playerWeapon;integer;RW;
sess.playerWeapon2;integer;RW;
sess.spawnObjectiveIndex;integer;RW;
sess.latchPlayerType;integer;RW;
sess.latchPlayerWeapon;integer;RW;
sess.latchPlayerWeapon2;integer;RW;
sess.damage_given;integer;RW;
sess.damage_received;integer;RW;
sess.deaths;integer;RW;
sess.game_points;integer;RW;
sess.gibs;integer;RW;
sess.kills;integer;RW;
sess.medals;integer array;RW;
sess.muted;qboolean;RW;
sess.rank;integer;RW;
sess.referee;integer;RW;
sess.rounds;integer;RW;
sess.semiadmin;integer;RW;
sess.skill;integer array;RW;
sess.spec_invite;integer;RW;
sess.spec_team;integer;RW;
sess.suicides;integer;RW;
sess.team_damage;integer;RW;
sess.team_kills;integer;RW;
sess.team_received;integer;RW;
sess.aWeaponStats;weapon_stat_t;RW;
spawnflags;integer;RO;
spawnitem;string;RO;
speed;float;RW;
splashDamage;integer;RW;
splashMethodOfDeath;integer;RW;
splashRadius;integer;RW;
start_size;integer;RW;
tagName;string;RO;
tagParent;entity;RW;
takedamage;boolean;RW;
tankLink;entity;RW;
target;string;RW;
TargetAngles;vec3;RW;
TargetFlag;integer;RO;
targetname;string;RO;
teamchain;entity;RW;
teammaster;entity;RW;
track;string;RO;
varc;float;RW;
wait;float;RW;
waterlevel;integer;RO;
watertype;integer;RO;
</pitatable>
:''note'': all the sess.* fields will return nil unless the entity is associated with client slot < sv_maxclients.
:''note'': all array variables need tobe called or get whit an additional parameter

----

==ET variable types==

===vec3===
:a '''vec3''' is a 3-element array of numbers (C definition: typedef float vec3_t[3];). It is usually used to store and process coordinates in 3D space. 
:In etpro-lua a vector is an array (table indexed by integers) containing 3 numbers. It can be accessed by
:doing:
<pre>
origin = et.gentity_get(entNum,"r.currentOrigin") --a vec3 value
x,y,z = origin[1],origin[2],origin[3]</pre>

----

===trajectory===
:a '''trajectory''' is returned as a lua table described below
<pre>{
trDuration = <number>, --- int
trTime = <number>, -- int
trType = <number>, -- see below for allowed values
trBase = <vec3_t>, -- vec3, as described above
trDelta = <vec3_t> -- also a vec3
}</pre>
: the allowed values for trType (along with the enum names and original comments from the ET source), are as follows. Note
: that not all values make sense for all entity types
<pitatable columns=3 headlines="number;type;discription" widths="40;160;450" headerfontcolor="#FFFFFF">
1;TR_STATIONARY;
2;TR_INTERPOLATE;non-parametric, but interpolate between snapshots;
3;TR_LINEAR;
4;TR_LINEAR_STOP;
5;TR_LINEAR_STOP_BACK;reverse movement can be different than forward;
6;TR_SINE;value = base + sin( time / duration ) * delta;
7;TR_GRAVITY;
8;TR_GRAVITY_LOW;
9;TR_GRAVITY_FLOAT;super low grav with no gravity acceleration;
10;TR_GRAVITY_PAUSED;has stopped, but trace to see if it should be switched back to TR_GRAVITY;
11;TR_ACCELERATE;
12;TR_DECCELERATE;
13;TR_SPLINE;
14;TR_LINEAR_PATH;
</pitatable>

----

===entity===
:The fields listed as having type '''enitity''' return an entity number or nil. Entity numbers are integers from 0 through 1023. Some of the entity numbers have special meanings:
:0 - (sv_privateclients - 1) are reserved for clients who connect with the private slot password
:0 - 63 are reserved for clients. A client's entity number is also its client number (as shown by /players for example)
:1022 is the '''worldspawn''' entity
:1023 is '''ENTITYNUM_NONE''' which is used instead of null in C under some circumstances to indicate no entity. This is needed where an entity number will be passed over the network.
:''Note'': Some other fields not listed as type 'entity' may take an entity number value. '''mg42BaseEnt''' and '''s.number''' are examples. 

[[Category:ETPro]]
[[Category:ETPro:Mods]]

Fieldname

2006-03-08T17:34:47Z

=FF=im2good4u: restyled to make room for other entity types

==Entity Fieldnames==
List of fields supported by [[ETPro:Lua Mod API#entities|et.gentity_get() and et.gentity_set()]] functions 
<pitatable columns=3 headlines="field;type;access" widths="180;120;60" headerfontcolor="#FFFFFF">
activator;entity;RO;
chain;entity;RW;
classname;string;RW;
client.inactivityTime;integer;RW;
client.inactivityWarning;qboolean;RW;
clipmask;integer;?;
closespeed;float;RW;
count;integer;RW;
count2;integer;RW;
damage;integer;RW;
deathType;meansOfDeath_t;RW;
delay;float;RW;
dl_atten;integer;RW;
dl_color;vec3;RW;
dl_shader;string;RO;
dl_stylestring;string;RO;
duration;float;RW;
end_size;integer;RW;
enemy;entity;RW;
flags;bitflag;RO;
harc;float;RW;
health;integer;RW;
inuse;qboolean;RO;
isProp;qboolean;RO;
item;string;RW;
key;integer;RW;
message;string;RW;
methodOfDeath;integer;RW;
mg42BaseEnt;integer;RW;
missionLevel;integer;RW;
model;string;RO;
model2;string;RO;
nextTrain;entity;RW;
noise_index;integer;RW;
origin;vec3;RW;
pers.connected;connected_t;?;
pers.netname;string;?;
pers.localClient;qboolean;?;
pers.initialSpawn;qboolean;?;
pers.enterTime;integer;?;
pers.connectTime;integer;?;
pers.teamState.state;teamstatestate_t;?;
pers.voteCount;integer;?;
pers.teamVoteCount;integer;?;
pers.complaints;integer;?;
pers.complaintClient;integer;?;
pers.complaintEndTime;integer;?;
pers.lastReinforceTime;integer;?;
pers.applicationClient;integer;?;
pers.applicationEndTime;integer;?;
pers.invitationClient;integer;?;
pers.invitationEndTime;integer;?;
pers.propositionClient;integer;?;
pers.propositionClient2;integer;?;
pers.propositionEndTime;integer;?;
pers.autofireteamEndTime;integer;?;
pers.autofireteamCreateEndTime;integer;?;
pers.autofireteamJoinEndTime;integer;?;
pers.lastSpawnTime;integer;?;
pers.ready;qboolean;?;
prevTrain;entity;RW;
props_frame_state;integer;RO;
ps.stats;integer array;RW;
ps.persistant;integer array;RW;
ps.ping;integer;?;
ps.powerups;integer array;RW;
ps.ammo;integer array;RW;
ps.ammoclip;integer array;RW;
r.absmax;vec3;RO;
r.absmin;vec3;RO;
r.bmodel;qboolean;RO;
r.contents;integer;RW;
r.currentAngles;vec3;RW;
r.currentOrigin;vec3;RW;
r.eventTime;integer;RW;
r.linkcount;integer;RO;
r.linked;qboolean;RO;
r.maxs;vec3;RW;
r.mins;vec3;RW;
r.ownerNum;integer;RW;
r.singleClient;integer;RW;
r.svFlags;integer;RW;
r.worldflags;integer;RO;
radius;integer;RW;
random;float;RW;
rotate;vec3;RW;
s.angles;vec3;RW;
s.angles2;vec3;RW;
s.apos;trajectory;RW;
s.clientNum;integer;RW;
s.constantLight;integer;RW;
s.density;integer;RW;
s.dl_intensity;integer;RW;
s.dmgFlags;integer;RW;
s.eFlags;integer;RW;
s.eType;integer;?;
s.effect1Time;integer;RW;
s.effect2Time;integer;RW;
s.effect3Time;integer;RW;
s.frame;integer;RW;
s.groundEntityNum;integer;RO;
s.loopSound;integer;RW;
s.modelindex;integer;RW;
s.modelindex2;integer;RW;
s.number;integer;RO;
s.onFireEnd;integer;RW;
s.onFireStart;integer;RW;
s.origin;vec3;?;
s.origin2;vec3;?;
s.pos;trajectory;RW;
s.powerups;integer;RO;
s.solid;integer;RW;
s.teamNum;integer;RW;
s.time;integer;RW;
s.time2;integer;RW;
s.weapon;integer;RO;
scriptName;string;RO;
sess.sessionTeam;team_t;RW;
sess.spectatorTime;integer;RW;
sess.spectatorState;spectatorState_t;RW;
sess.spectatorClient;integer;RW;
sess.latchSpectatorClient;integer;RW;
sess.playerType;integer;RW;
sess.playerWeapon;integer;RW;
sess.playerWeapon2;integer;RW;
sess.spawnObjectiveIndex;integer;RW;
sess.latchPlayerType;integer;RW;
sess.latchPlayerWeapon;integer;RW;
sess.latchPlayerWeapon2;integer;RW;
sess.damage_given;integer;RW;
sess.damage_received;integer;RW;
sess.deaths;integer;RW;
sess.game_points;integer;RW;
sess.gibs;integer;RW;
sess.kills;integer;RW;
sess.medals;integer array;RW;
sess.muted;qboolean;RW;
sess.rank;integer;RW;
sess.referee;integer;RW;
sess.rounds;integer;RW;
sess.semiadmin;integer;RW;
sess.skill;integer array;RW;
sess.spec_invite;integer;RW;
sess.spec_team;integer;RW;
sess.suicides;integer;RW;
sess.team_damage;integer;RW;
sess.team_kills;integer;RW;
sess.team_received;integer;RW;
sess.aWeaponStats;weapon_stat_t;RW;
spawnflags;integer;RO;
spawnitem;string;RO;
speed;float;RW;
splashDamage;integer;RW;
splashMethodOfDeath;integer;RW;
splashRadius;integer;RW;
start_size;integer;RW;
tagName;string;RO;
tagParent;entity;RW;
takedamage;boolean;RW;
tankLink;entity;RW;
target;string;RW;
TargetAngles;vec3;RW;
TargetFlag;integer;RO;
targetname;string;RO;
teamchain;entity;RW;
teammaster;entity;RW;
track;string;RO;
varc;float;RW;
wait;float;RW;
waterlevel;integer;RO;
watertype;integer;RO;
</pitatable>
:''note'': all the sess.* fields will return nil unless the entity is associated with client slot < sv_maxclients.
:''note'': all array variables need tobe called or get whit an additional parameter

----

==ET variable types==

===vec3===
:a '''vec3''' is a 3-element array of numbers (C definition: <tt>typedef float vec3_t[3];
</tt>). It is usually used to store and process coordinates in 3D space. 
In etpro-lua a vector is an array (table indexed by integers) containing 3 numbers. It can be accessed by
doing:
<pre>
origin = et.gentity_get(entNum,"r.currentOrigin") --a vec3 value
x,y,z = origin[1],origin[2],origin[3]</pre>

----

===trajectory===
:a '''trajectory''' is returned as a lua table described below
<pre>{
trDuration = <number>, --- int
trTime = <number>, -- int
trType = <number>, -- see below for allowed values
trBase = <vec3_t>, -- vec3, as described above
trDelta = <vec3_t> -- also a vec3
}</pre>
: the allowed values for trType (along with the enum names and original comments from the ET source), are as follows. Note
: that not all values make sense for all entity types
<pitatable columns=3 headlines="number;type;discription" widths="40;160;450" headerfontcolor="#FFFFFF">
1;TR_STATIONARY;
2;TR_INTERPOLATE;non-parametric, but interpolate between snapshots;
3;TR_LINEAR;
4;TR_LINEAR_STOP;
5;TR_LINEAR_STOP_BACK;reverse movement can be different than forward;
6;TR_SINE;value = base + sin( time / duration ) * delta;
7;TR_GRAVITY;
8;TR_GRAVITY_LOW;
9;TR_GRAVITY_FLOAT;super low grav with no gravity acceleration;
10;TR_GRAVITY_PAUSED;has stopped, but trace to see if it should be switched back to TR_GRAVITY;
11;TR_ACCELERATE;
12;TR_DECCELERATE;
13;TR_SPLINE;
14;TR_LINEAR_PATH;
</pitatable>

----

===entity===
:The fields listed as having type '''enitity''' return an entity number or nil. Entity numbers are integers from 0 through 1023. Some of the entity numbers have special meanings:
:0 - (sv_privateclients - 1) are reserved for clients who connect with the private slot password
:0 - 63 are reserved for clients. A client's entity number is also its client number (as shown by /players for example)
:1022 is the '''worldspawn''' entity
:1023 is '''ENTITYNUM_NONE''' which is used instead of null in C under some circumstances to indicate no entity. This is needed where an entity number will be passed over the network.
:''Note'': Some other fields not listed as type 'entity' may take an entity number value. '''mg42BaseEnt''' and '''s.number''' are examples. 

[[Category:ETPro]]
[[Category:ETPro:Mods]]

Etdamage

2006-03-08T17:04:02Z

=FF=im2good4u: style fixor

__NOEDITSECTION__
*'''Damage Flags List'''
:damage flags are [[Bitmask-cvar|bitflags]]
:the following bits are available:
<pre>DAMAGE_RADIUS 1 // damage was indirect
DAMAGE_HALF_KNOCKBACK 2 // Gordon: do less knockback
DAMAGE_NO_KNOCKBACK 4 // do not affect velocity, just view angles
DAMAGE_NO_PROTECTION 8 // armor, shields, invulnerability, and godmode have no effect
DAMAGE_NO_TEAM_PROTECTION 16 // armor, shields, invulnerability, and godmode have no effect
DAMAGE_DISTANCEFALLOFF 32 // distance falloff</pre>

----

*'''Method of Death List'''
:Method's of Death are numbers indicatig of how the damage was inflickted
:The following Method's of Death are avialable:
<pitatable columns=2 headlines="number;type" widths="40;330" headerfontcolor="#FFFFFF">
0;MOD_UNKNOWN;
1;MOD_MACHINEGUN;
2;MOD_BROWNING;
3;MOD_MG42;
4;MOD_GRENADE;
5;MOD_ROCKET;
6;MOD_KNIFE;
7;MOD_LUGER;
8;MOD_COLT;
9;MOD_MP40;
10;MOD_THOMPSON;
11;MOD_STEN;
12;MOD_GARAND;
13;MOD_SNOOPERSCOPE;
14;MOD_SILENCER;
15;MOD_FG42;
16;MOD_FG42SCOPE;
17;MOD_PANZERFAUST;
18;MOD_GRENADE_LAUNCHER;
19;MOD_FLAMETHROWER;
20;MOD_GRENADE_PINEAPPLE;
21;MOD_CROSS;
22;MOD_MAPMORTAR;
23;MOD_MAPMORTAR_SPLASH;
24;MOD_KICKED;
25;MOD_GRABBER;
26;MOD_DYNAMITE;
27;MOD_AIRSTRIKE;
28;MOD_SYRINGE;
29;MOD_AMMO;
30;MOD_ARTY;
31;MOD_WATER;
32;MOD_SLIME;
33;MOD_LAVA;
34;MOD_CRUSH;
35;MOD_TELEFRAG;
36;MOD_FALLING;
37;MOD_SUICIDE;
38;MOD_TARGET_LASER;
39;MOD_TRIGGER_HURT;
40;MOD_EXPLOSIVE;
41;MOD_CARBINE;
42;MOD_KAR98;
43;MOD_GPG40;
44;MOD_M7;
45;MOD_LANDMINE;
46;MOD_SATCHEL;
47;MOD_TRIPMINE;
48;MOD_SMOKEBOMB;
49;MOD_MOBILE_MG42;
50;MOD_SILENCED_COLT;
51;MOD_GARAND_SCOPE;
52;MOD_CRUSH_CONSTRUCTION;
53;MOD_CRUSH_CONSTRUCTIONDEATH;
54;MOD_CRUSH_CONSTRUCTIONDEATH_NOATTACKER;
55;MOD_K43;
56;MOD_K43_SCOPE;
57;MOD_MORTAR;
58;MOD_AKIMBO_COLT;
59;MOD_AKIMBO_LUGER;
60;MOD_AKIMBO_SILENCEDCOLT;
61;MOD_AKIMBO_SILENCEDLUGER;
62;MOD_SMOKEGRENADE;
63;MOD_SWAP_PLACES;
64;MOD_SWITCHTEAM;
</pitatable>
[[Category:ETPro]]
[[Category:ETPro:Mods]]

Etdamage

2006-03-08T17:03:18Z

=FF=im2good4u: fixed table with

__NOEDITSECTION__
*'''Damage Flags List'''
:damage flags are [[Bitmask-cvar|bitflags]]
:the following bits are available:
<pre>DAMAGE_RADIUS 1 // damage was indirect
DAMAGE_HALF_KNOCKBACK 2 // Gordon: do less knockback
DAMAGE_NO_KNOCKBACK 4 // do not affect velocity, just view angles
DAMAGE_NO_PROTECTION 8 // armor, shields, invulnerability, and godmode have no effect
DAMAGE_NO_TEAM_PROTECTION 16 // armor, shields, invulnerability, and godmode have no effect
DAMAGE_DISTANCEFALLOFF 32 // distance falloff</pre>

----

*'''Method of Death List'''
:Method's of Death are numbers indicatig of how the damage was inflickted
The following Method's of Death are avialable:
<pitatable columns=2 headlines="number;type" widths="40;330" headerfontcolor="#FFFFFF">
0;MOD_UNKNOWN;
1;MOD_MACHINEGUN;
2;MOD_BROWNING;
3;MOD_MG42;
4;MOD_GRENADE;
5;MOD_ROCKET;
6;MOD_KNIFE;
7;MOD_LUGER;
8;MOD_COLT;
9;MOD_MP40;
10;MOD_THOMPSON;
11;MOD_STEN;
12;MOD_GARAND;
13;MOD_SNOOPERSCOPE;
14;MOD_SILENCER;
15;MOD_FG42;
16;MOD_FG42SCOPE;
17;MOD_PANZERFAUST;
18;MOD_GRENADE_LAUNCHER;
19;MOD_FLAMETHROWER;
20;MOD_GRENADE_PINEAPPLE;
21;MOD_CROSS;
22;MOD_MAPMORTAR;
23;MOD_MAPMORTAR_SPLASH;
24;MOD_KICKED;
25;MOD_GRABBER;
26;MOD_DYNAMITE;
27;MOD_AIRSTRIKE;
28;MOD_SYRINGE;
29;MOD_AMMO;
30;MOD_ARTY;
31;MOD_WATER;
32;MOD_SLIME;
33;MOD_LAVA;
34;MOD_CRUSH;
35;MOD_TELEFRAG;
36;MOD_FALLING;
37;MOD_SUICIDE;
38;MOD_TARGET_LASER;
39;MOD_TRIGGER_HURT;
40;MOD_EXPLOSIVE;
41;MOD_CARBINE;
42;MOD_KAR98;
43;MOD_GPG40;
44;MOD_M7;
45;MOD_LANDMINE;
46;MOD_SATCHEL;
47;MOD_TRIPMINE;
48;MOD_SMOKEBOMB;
49;MOD_MOBILE_MG42;
50;MOD_SILENCED_COLT;
51;MOD_GARAND_SCOPE;
52;MOD_CRUSH_CONSTRUCTION;
53;MOD_CRUSH_CONSTRUCTIONDEATH;
54;MOD_CRUSH_CONSTRUCTIONDEATH_NOATTACKER;
55;MOD_K43;
56;MOD_K43_SCOPE;
57;MOD_MORTAR;
58;MOD_AKIMBO_COLT;
59;MOD_AKIMBO_LUGER;
60;MOD_AKIMBO_SILENCEDCOLT;
61;MOD_AKIMBO_SILENCEDLUGER;
62;MOD_SMOKEGRENADE;
63;MOD_SWAP_PLACES;
64;MOD_SWITCHTEAM;
</pitatable>
[[Category:ETPro]]
[[Category:ETPro:Mods]]

Etdamage

2006-03-08T16:59:32Z

=FF=im2good4u: added MOD_

__NOEDITSECTION__
*'''Damage Flags List'''
:damage flags are [[Bitmask-cvar|bitflags]]
:the following bits are available:
<pre>DAMAGE_RADIUS 1 // damage was indirect
DAMAGE_HALF_KNOCKBACK 2 // Gordon: do less knockback
DAMAGE_NO_KNOCKBACK 4 // do not affect velocity, just view angles
DAMAGE_NO_PROTECTION 8 // armor, shields, invulnerability, and godmode have no effect
DAMAGE_NO_TEAM_PROTECTION 16 // armor, shields, invulnerability, and godmode have no effect
DAMAGE_DISTANCEFALLOFF 32 // distance falloff</pre>

----

*'''Method of Death List'''
:Method's of Death are numbers indicatig of how the damage was inflickted
The following Method's of Death are avialable:
<pitatable columns=2 headlines="number;type" widths="40;120" headerfontcolor="#FFFFFF">
0;MOD_UNKNOWN;
1;MOD_MACHINEGUN;
2;MOD_BROWNING;
3;MOD_MG42;
4;MOD_GRENADE;
5;MOD_ROCKET;
6;MOD_KNIFE;
7;MOD_LUGER;
8;MOD_COLT;
9;MOD_MP40;
10;MOD_THOMPSON;
11;MOD_STEN;
12;MOD_GARAND;
13;MOD_SNOOPERSCOPE;
14;MOD_SILENCER;
15;MOD_FG42;
16;MOD_FG42SCOPE;
17;MOD_PANZERFAUST;
18;MOD_GRENADE_LAUNCHER;
19;MOD_FLAMETHROWER;
20;MOD_GRENADE_PINEAPPLE;
21;MOD_CROSS;
22;MOD_MAPMORTAR;
23;MOD_MAPMORTAR_SPLASH;
24;MOD_KICKED;
25;MOD_GRABBER;
26;MOD_DYNAMITE;
27;MOD_AIRSTRIKE;
28;MOD_SYRINGE;
29;MOD_AMMO;
30;MOD_ARTY;
31;MOD_WATER;
32;MOD_SLIME;
33;MOD_LAVA;
34;MOD_CRUSH;
35;MOD_TELEFRAG;
36;MOD_FALLING;
37;MOD_SUICIDE;
38;MOD_TARGET_LASER;
39;MOD_TRIGGER_HURT;
40;MOD_EXPLOSIVE;
41;MOD_CARBINE;
42;MOD_KAR98;
43;MOD_GPG40;
44;MOD_M7;
45;MOD_LANDMINE;
46;MOD_SATCHEL;
47;MOD_TRIPMINE;
48;MOD_SMOKEBOMB;
49;MOD_MOBILE_MG42;
50;MOD_SILENCED_COLT;
51;MOD_GARAND_SCOPE;
52;MOD_CRUSH_CONSTRUCTION;
53;MOD_CRUSH_CONSTRUCTIONDEATH;
54;MOD_CRUSH_CONSTRUCTIONDEATH_NOATTACKER;
55;MOD_K43;
56;MOD_K43_SCOPE;
57;MOD_MORTAR;
58;MOD_AKIMBO_COLT;
59;MOD_AKIMBO_LUGER;
60;MOD_AKIMBO_SILENCEDCOLT;
61;MOD_AKIMBO_SILENCEDLUGER;
62;MOD_SMOKEGRENADE;
63;MOD_SWAP_PLACES;
64;MOD_SWITCHTEAM;
</pitatable>
[[Category:ETPro]]
[[Category:ETPro:Mods]]

Etdamage

2006-03-08T16:22:31Z

=FF=im2good4u: added MOD_ beta 1

__NOEDITSECTION__
*'''Damage Flags List'''
:damage flags are [[Bitmask-cvar|bitflags]]
:the following bits are available:
<pre>DAMAGE_RADIUS 1 // damage was indirect
DAMAGE_HALF_KNOCKBACK 2 // Gordon: do less knockback
DAMAGE_NO_KNOCKBACK 4 // do not affect velocity, just view angles
DAMAGE_NO_PROTECTION 8 // armor, shields, invulnerability, and godmode have no effect
DAMAGE_NO_TEAM_PROTECTION 16 // armor, shields, invulnerability, and godmode have no effect
DAMAGE_DISTANCEFALLOFF 32 // distance falloff</pre>

----

*'''Method of Death List'''
:Method's of Death are numbers indicatig of how the damage was inflickted
The following Method's of Death are avialable:
<pitatable columns=3 headlines="number;type" widths="40;80" headerfontcolor="#FFFFFF">
0;MOD_UNKNOWN;
MOD_MACHINEGUN;
MOD_BROWNING;
MOD_MG42;
MOD_GRENADE
MOD_ROCKET5
MOD_KNIFE
MOD_LUGER
MOD_COLT
MOD_MP40
MOD_THOMPSON10
MOD_STEN,
MOD_GARAND,
MOD_SNOOPERSCOPE,
MOD_SILENCER,
MOD_FG42,15
MOD_FG42SCOPE,
MOD_PANZERFAUST,
MOD_GRENADE_LAUNCHER,
MOD_FLAMETHROWER,
MOD_GRENADE_PINEAPPLE,20
MOD_CROSS,
MOD_MAPMORTAR,
MOD_MAPMORTAR_SPLASH,
MOD_KICKED,
MOD_GRABBER,25
MOD_DYNAMITE,
MOD_AIRSTRIKE,
MOD_SYRINGE,
MOD_AMMO,
MOD_ARTY,30
MOD_WATER,
MOD_SLIME,
MOD_LAVA,
MOD_CRUSH,
MOD_TELEFRAG,35
MOD_FALLING,
MOD_SUICIDE,
MOD_TARGET_LASER,
MOD_TRIGGER_HURT,
MOD_EXPLOSIVE,40
MOD_CARBINE,
MOD_KAR98,
MOD_GPG40,
MOD_M7,
MOD_LANDMINE,45
MOD_SATCHEL,
MOD_TRIPMINE,
MOD_SMOKEBOMB,
MOD_MOBILE_MG42,
MOD_SILENCED_COLT,50
MOD_GARAND_SCOPE,
MOD_CRUSH_CONSTRUCTION,
MOD_CRUSH_CONSTRUCTIONDEATH,
MOD_CRUSH_CONSTRUCTIONDEATH_NOATTACKER,
MOD_K43,55
MOD_K43_SCOPE,
MOD_MORTAR,
MOD_AKIMBO_COLT,
MOD_AKIMBO_LUGER,
MOD_AKIMBO_SILENCEDCOLT,60
MOD_AKIMBO_SILENCEDLUGER,
MOD_SMOKEGRENADE,
MOD_SWAP_PLACES,
MOD_SWITCHTEAM,
[[Category:ETPro]]
[[Category:ETPro:Mods]]</pitatable>

Etdamage

2006-03-08T16:12:07Z

=FF=im2good4u: added dflags

__NOEDITSECTION__
*'''Damage Flags'''
:damage flags are bitflags
:the following bits are available
<pre>DAMAGE_RADIUS 1 // damage was indirect
DAMAGE_HALF_KNOCKBACK 2 // Gordon: do less knockback
DAMAGE_NO_KNOCKBACK 4 // do not affect velocity, just view angles
DAMAGE_NO_PROTECTION 8 // armor, shields, invulnerability, and godmode have no effect
DAMAGE_NO_TEAM_PROTECTION 16 // armor, shields, invulnerability, and godmode have no effect
DAMAGE_DISTANCEFALLOFF 32 // distance falloff</pre>

----

[[Category:ETPro]]
[[Category:ETPro:Mods]]

Talk:Lua Mod API

2006-03-08T15:45:26Z

=FF=im2good4u: added my name

- et.G_SlotSound( slotnum, soundindex ) -> Plays the sound soundindex at for the player @ slotnum only. --[[User:RoadKillPuppy|RoadKillPuppy]] 14:17, 16 December 2005 (PST)
:you can do this with tempentities and SVF_SINGLECLIENT ...
:--[[User:Bani|Bani]] 17:32, 16 December 2005 (PST)

----
some of this can be done via function et_Print(text).. but this would greatly simplify life, 
my wish list for christmas: 
- getUserEguid(cno) - get a client's etpro guid? 
- repair gentity_set for vec3 - scotty fix the transporter please 
:[http://bani.anime.net/banimod/forums/viewtopic.php?t=6279 fixed.]--[[User:Bani|Bani]] 17:56, 22 December 2005 (PST)
- et.trap_SendServerCommand(cno, "kill") - punish client as alternative to setting health 
--[[User:Hadr0|Hadr0]] 02:10, 20 December 2005 (PST) 
:You can use et.G_Damage() in the new test version to do that.--[[User:Bani|Bani]] 01:38, 23 December 2005 (PST)

trap sen server cmd is a ET engine trap the comand u send it send to the client and recived as a server command no a client command

to add ill well that would be al ot of coding for not much [[User:=FF=im2good4u|=FF=Im2good4u]] 12:12, 20 December 2005 (PST)

aight thnx. 
heres another api request, i'd like to be able to get a clients xp directly. et.gentity_get(cno, "sess.game_points") seems to return 0 always (?) 
--[[User:Hadr0|Hadr0]] 15:38, 21 December 2005 (PST)
:oh nevermind, i see this can be done now with xp = et.gentity_get(cno, "ps.stats", 8)
:nice... --[[User:Hadr0|Hadr0]] 16:58, 23 December 2005 (PST)
--------
add a way to determine if a client is 999, and if possible why he's 999 (loading, connecting, loosing packets, etc) 
--Gotenks

999 means: server has not been sent data from client for > 1000 ms. So there is no way to certainly tell why.
The timeoutflag is stored in the pmflags IIRC. Don't know if lua can read them right now. --[[User:Deus|Deus]] 23:12, 22 December 2005 (PST) 
Still would like access to the ping, or a dummy variable if they are 999, but also the ammount of time they are inactive. 
--[[User:Gotenks|Gotenks]] (Sorry for double post) 1:53, 31 December 2005 (CST)
:[http://bani.anime.net/banimod/forums/viewtopic.php?t=6291 fixed].--[[User:Bani|Bani]] 02:40, 7 February 2006 (PST)
----
Access to weapon stats during game similar to end of round stats that are displayed. 
--[[User:LethalInjection|LethalInjection]] 23:52, 22 December 2005 (PST)
:[http://bani.anime.net/banimod/forums/viewtopic.php?t=6291 fixed].--[[User:Bani|Bani]] 02:40, 7 February 2006 (PST)

----

== IPC stuff ==

<hr>
i would like a et_IPCReceive whit an return value so u can send info back on a request

i would like a et_IPCSend that can send to all lua mods then them mods can decide if the wana use that message or not
[[User:=FF=im2good4u|=FF=Im2good4u]] 12:35, 8 January 2006 (PST)
<hr>
et_IPCReceive wouldn't send it to the other mod... afaik... so just use another send
just et_IPCSend to all modules (afaik, you can even send to ones not there), simple loop function
[[User:gotenks|gotenks]] 20:04, 8 January 2006 (CST)

yeh probely but its not verry handy its better to get the good vmnumber or to e able to send on mod filenames

apart from that returning a value will be more handy since tnhe u cna contine in 1 funtion else u got to reacise it in the recieve funtion [[User:=FF=im2good4u|=FF=Im2good4u]] 10:45, 9 January 2006 (PST)

<hr>
bani i need a console print function on the client that does sepport ascii plz [[User:=FF=im2good4u|=FF=Im2good4u]] 12:49, 12 January 2006 (PST)
:et.trap_SendServerCommand( clientnum, "print \"hello ascii console on the client\n\" ) ) --[[User:Bani|Bani]] 22:33, 15 January 2006 (PST)
<hr>
bani: how about a et_sound(id, sound) event? [[User:gotenks|gotenks]] 20:45, 17 January 2006 (CST)
:[http://wolfwiki.anime.net/index.php/ETPro:Lua_Mod_API#sound et.G_Sound( entnum, soundindex )] --[[User:Bani|Bani]] 22:07, 18 January 2006 (PST)
:bani, i was referring to an on event call, so when a sound is played et_sound(id,sound) would be called.[[User:gotenks|gotenks]] 21:45, 20 January 2006 (CST)
::most sounds are clientside... this would not be of much use. --[[User:Bani|Bani]] 04:42, 22 January 2006 (PST)
:::except for checking when something like a killing spree sound is activated--[[User:gotenks|gotenks]] 07:54, 23 January 2006 (CST)
:::::There would be no way for you to know what sound was activated. You can't get a filename from the soundindex.--[[User:Bani|Bani]] 10:19, 24 January 2006 (PST)
:::::This is a case where IPCSend/IPCReceive would be useful, so mods can notify each other of specific events.--[[User:Bani|Bani]] 02:40, 7 February 2006 (PST)

----

Is it possible to get a player's live angles? Fieldname "s.angles" only gives the spawn angles. Tried "rotate", "s.angles2", "TargetAngles", "r.currentAngles" as well but they just give 0.000000 for each element. thanks for any help --[[User:Hadr0|Hadr0]] 01:35, 25 January 2006 (PST)
:This will be fixed in the next release, where you will get access to ps.viewangles--[[User:Bani|Bani]] 02:33, 7 February 2006 (PST)

== LoadLib ==

Add loadlib ppl it says u have lua basic included but not loadlib !!

(on windows it gives an error attept to call global load lin a nil valua)[[User:=FF=im2good4u|=FF=Im2good4u]] 05:16, 15 February 2006 (PST)

== XP controll not just skill ==

i would like to requesst RW acces to "sess.skillpoints" array

at atleast a callback on et.G_AddSkillPoints ( '''cno''', '''skill''', '''points''' ) [[User:=FF=im2good4u|=FF=Im2good4u]] 07:45, 8 March 2006 (PST)

Talk:Lua Mod API

2006-03-08T15:44:16Z

=FF=im2good4u: XP controll not just skill

Lua Mod API

2006-03-08T15:41:34Z

=FF=im2good4u: snapshot 3 callbacks

__NOEDITSECTION__
ETPro now supports serverside mods via the [http://www.lua.org/ lua] scripting language. For more information about lua, visit the [http://www.lua.org/manual/5.0/ Reference manual], the online edition of the book [http://www.lua.org/pil/ Programming in Lua] or the [http://lua-users.org/wiki/ lua-users wiki].

ETPro has an embedded lua 5.0.2 interpreter, and if present will load user-defined scripts from the etpro directory. ETPro also provides an "et" library of function calls for lua to access the server engine, and provides callbacks so a serverside mod may trigger on specific server events.

The following standard lua libraries are initialized by default and available to ETPro lua scripts:
[http://www.lua.org/manual/5.0/manual.html#5.1 basic], [http://www.lua.org/manual/5.0/manual.html#5.4 table], [http://www.lua.org/manual/5.0/manual.html#5.6 i/o], [http://www.lua.org/manual/5.0/manual.html#5.3 string], [http://www.lua.org/manual/5.0/manual.html#5.5 math].

A list of [[ETPro]] mods can be found [[:Category:ETPro:Mods|here]].

API Requests can be discussed [http://wolfwiki.anime.net/index.php/Talk:ETPro:Lua_Mod_API here].

==client commands==
===lua_status===
:lists all currently loaded lua modules.
:''lua mods cannot override this client command.''

==server commands==
===lua_status===
:lists all currently loaded lua modules.

==cvars==
===lua_modules===
:(default "", disabled)
:space separated list of lua modules for ETPro to load. modules will be run in the order listed.

===lua_allowedmodules===
:(default "", disabled)
:if set, only lua modules with the matching sha1 signatures listed in this cvar will be allowed to load.
 
:changing either cvar will cause all currently loaded modules to :quit and be unloaded until the next map_restart. 
 

==et library calls==

===modules===
et.RegisterModname( '''modname''' )
:Registers a descriptive string '''modname''' for this mod.
'''vmnumber''' = et.FindSelf()
:Returns a number indicating the VM slot the current mod is loaded into.
'''modname''', '''signature''' = et.FindMod( '''vmnumber''' )
:Returns the '''modname''' and sha1 '''signature''' for the mod loaded in the VM slot '''vmnumber'''. Returns nil, nil if the VM slot is invalid.
'''success''' = et.IPCSend( '''vmnumber''', '''message''' )
:Sends the string '''message''' to the mod in the VM slot indicated by '''vmnumber'''. The mod receiving '''message''' must have an ''et_IPCReceive()'' callback. If the message is successfully sent, '''success''' will be 1. On failure it will be 0.
 

===printing===
et.G_Print( '''text''' )
:Prints the string '''text''' to the server console.
et.G_LogPrint( '''text''' )
:Prints the string '''text''' to the server console and writes it to the server log.
 

===argument handling===
These functions are to be used within the [[#commands|command callback functions]]. 
'''args''' = et.ConcatArgs( '''index''' )
:Returns all arguments beginning from '''index''' concatenated into a single string '''args'''
'''argcount''' = et.trap_Argc()
:Returns a number indicating the number of command line arguments in the command buffer.
'''arg''' = et.trap_Argv( '''argnum''' )
:Returns the contents of the command line argument '''argnum'''.
 

===cvars===
'''cvarvalue''' = et.trap_Cvar_Get( '''cvarname''' )
:Returns the value of the cvar '''cvarname''' as a string. If there is no cvar named '''cvarname''', returns a zero length string.
et.trap_Cvar_Set( '''cvarname''', '''cvarvalue''' )
:Sets the cvar '''cvarname''' to '''cvarvalue'''
 

===configstrings===
'''configstringvalue''' = et.trap_GetConfigstring( '''index''' )
:Returns the string '''configstringvalue''' containing the contents of the configstring '''index'''
et.trap_SetConfigstring( '''index''', '''configstringvalue''' )
:Sets the configstring '''index''' to the string '''configstringvalue'''
 

===server===
et.trap_SendConsoleCommand( '''when''', '''command''' )
:Sends the command '''command''' to the server console, to be executed '''when''' (see et.EXEC_* constants)
 

===clients===
et.trap_DropClient( '''clientnum''', '''reason''', '''ban_time''' )
:Disconnects '''clientnum''' from the server, with descriptive string '''reason''' reported to clients. '''ban_time''' is the time in seconds to ban the client from the server. '''ban_time''' is optional and may be entirely omitted, in which case the ban time defaults to the cvar ''b_defaultbantime''
et.trap_SendServerCommand( '''clientnum''', '''[[SendServerCommand|command]]''' )
:Sends the command '''[[SendServerCommand|command]]''' to the client '''clientnum'''. If '''clientnum''' is -1, the '''[[SendServerCommand|command]]''' is broadcast to all connected clients.
et.G_Say( '''clientNum''', '''mode''', '''text''' )
:Sends a chat command on behalf of client '''clientNum''' with the mode '''mode''' (see et.SAY_* constants) and chat text '''text'''.
et.ClientUserinfoChanged( '''clientNum''' )
:Loads the new Userinfo of '''clientNum''' and stores it in the configstring and client variables
 

===userinfo===
'''userinfo''' = et.trap_GetUserinfo( '''clientnum''' )
:Returns the contents of the userinfo string for the client '''clientnum'''
et.trap_SetUserinfo( '''clientnum''', '''userinfo''' )
:Sets the userinfo string for the client '''clientnum''' to '''userinfo'''
 

===string utility functions===
'''infostring''' = et.Info_RemoveKey( '''infostring''', '''key''' )
:Removes key '''key''' from infostring '''infostring''' and returns the modified infostring.
'''infostring''' = et.Info_SetValueForKey( '''infostring''', '''key''', '''value''' )
:Sets the key '''key''' in the infostring '''infostring''' to '''value''' and returns the modified infostring. If '''value''' is an empty string, '''key''' is removed from the string.
'''keyvalue''' = et.Info_ValueForKey( '''infostring''', '''key''' )
:Returns the value of the key '''key''' in the infostring '''infostring'''. If '''key''' is not present in the string, an empty string is returned.
'''cleanstring''' = et.Q_CleanStr( '''string''' )
:Returns '''string''' stripped of all color codes
 

===ET filesystem===
'''fd''', '''len''' = et.trap_FS_FOpenFile( '''filename''', '''mode''' )
:Attempts to open the file '''filename''' with the access mode '''mode''' (see et.FS_ constants). Returns the filedescriptor '''fd''' and file length '''len'''. On error, '''len''' returns -1.
'''filedata''' = et.trap_FS_Read( fd, count )
:Reads '''count''' bytes from filedescriptor '''fd'''.
'''count''' = et.trap_FS_Write( '''filedata''', '''count''', '''fd''' )
:Attempts to write '''count''' bytes of '''filedata''' to filedescriptor '''fd'''. Returns number of bytes successfully written.
et.trap_FS_Rename( '''oldname''', '''newname''' )
:Renames file '''oldname''' to '''newname'''.
et.trap_FS_FCloseFile( '''fd''' )
:Closes filedescriptor '''fd'''
 

===indexes===
'''soundindex''' = et.G_SoundIndex( '''filename''' )
:Returns an index to the soundfile indicated by '''filename'''
'''modelindex''' = et.G_ModelIndex( '''filename''' )
:Returns an index to the model indicated by '''filename'''
 

===sound===
et.G_globalSound( '''sound''' )
:Plays the global sound indicated by the filename '''sound'''.
et.G_Sound( '''entnum''', '''soundindex''' )
:Plays the sound '''soundindex''' at the location of entity '''entnum'''
 

===miscellaneous===
'''milliseconds''' = et.trap_Milliseconds()
:Returns a number indicating the current server time in milliseconds.
et.G_Damage( '''target''', '''inflictor''', '''attacker''', '''damage''', '''[[etdamage|dflags]]''', '''[[etdamage|mod]]''' )
:Does '''damage''' amount of damage on '''target''' inflicted by '''inflictor''' and cased by '''attacker'''
:'''target''', '''inflictor''', '''attacker''' are entity numbers
:'''[[etdamage|dflags]]''' is a [[Bitmask-cvar|bitflag]] number to decide how the damage is inflickted, see '''[[etdamage|dflags]]''' [[etdamage|flaglist]]
:'''[[etdamage|mod]]''' is a number from 0 up to 64 o set the type of damage, see '''[[etdamage|mod]]''' [[etdamage|list]]
 

===entities===
'''entnum''' = et.G_Spawn()
:Spawns a new entity and returns the new entity number.
'''entnum''' = et.G_TempEntity( '''origin''', '''event''' )
:Spawns a new TempEntity of event type '''event''' and places it at '''origin''' in the world.
:'''Warning:''' up to and including ETPro 3.2.4 the signature of the method is broken and expects four instead of two parameters. To successfully call it, you need to prepend the parameter list with two dummy parameters like et.G_TempEntity( 0, 0, origin, event ). Use this method with care, because in future ETPro versions it will probably be corrected to the one stated above and might break your script.
et.G_FreeEntity( '''entnum''' )
:Frees the entity '''entnum'''
'''spawnval''' = et.G_GetSpawnVar( '''entnum''', '''key''' )
:Returns the value of spawnvar '''key''' for entity '''entnum'''
et.G_SetSpawnVar( '''entnum''', '''key''', '''value''' )
:Sets the spawnvar '''key''' to '''value''' for entity '''entnum'''
'''integer entnum''' = et.G_SpawnGEntityFromSpawnVars( string spawnvar, string spawnvalue, ... )
:This function can only be called inside the '''et_InitGame''' callback
et.trap_LinkEntity( '''entnum''' )
:Links the entity '''entnum'''
et.trap_UnlinkEntity( '''entnum''' )
:Unlinks the entity '''entnum'''
'''(variable)''' = et.gentity_get ( '''entnum''', '''[[Fieldname]]''' '',arraynumber'' )
:Gets the value of '''[[Fieldname]]''' from entity '''entnum''' out of the g_entity struct. For NULL entities or clients, ''nil'' is returned. 
:''arraynumber'' is an optional parameter to use when working whit array fields. In that case it represents the position in the array
et.gentity_set( '''entnum''', '''[[Fieldname]]''', ''arraynumber,'' '''(variable)''' )
:Sets the value of '''[[Fieldname]]''' from entity '''entnum''' in the g_entity struct to '''(variable)'''
:''arraynumber'' is an optional parameter to use when working whit array fields. In that case it represents the position in the array 
et.G_AddEvent( '''ent''', '''event''', '''eventparm'''' )
:Adds event '''event''' whit eventparameter '''eventparm'''' to entity '''ent'''
 

==callbacks==

===qagame execution===
et_InitGame( '''levelTime''', '''randomSeed''', '''restart''' )
:Called when qagame initializes. '''levelTime''' is the current level time in milliseconds. '''randomSeed''' is a number that can be used to seed random number generators. '''restart''' indicates if et_InitGame() is being called due to a map restart (1) or not (0).
et_ShutdownGame( '''restart''' )
:Called when qagame shuts down. '''restart''' indicates if the shutdown is being called due to a map_restart (1) or not (0).
et_RunFrame( '''levelTime''' )
:Called when qagame runs a server frame. '''levelTime''' is the current level time in milliseconds.
et_Quit()
:Called when ETPro unloads the mod. The mod should close all open filedescriptors and perform all cleanup.
 

===client management===
'''rejectreason''' = et_ClientConnect( '''clientNum''', '''firstTime''', '''isBot''' )
:Called when a client attempts to connect to the server. '''clientNum''' is the client slot id, '''firstTime''' indicates if this is a new connection (1) or a reconnection (0). '''isBot''' indicates if the client is a bot (1) or not (0). If the mod accepts the connection, it should return nil. Otherwise, the mod should return a string describing the reason the client connection was rejected.
et_ClientDisconnect( '''clientNum''' )
:Called when a client disconnects. '''clientNum''' is the client slot id.
et_ClientBegin( '''clientNum''' )
:Called when a client begins (becomes active, and enters the gameworld). '''clientNum''' is the client slot id.
et_ClientUserinfoChanged( '''clientNum''' )
:Called when a client's Userinfo string has changed. '''clientNum''' is the client slot id.
et_ClientSpawn( '''clientNum''', '''revived''' )
:Called when a client is spawned. '''clientNum''' is the client slot id. '''revived''' is 1 if the client was spawned by beeying revived.
 

===commands===
'''intercepted''' = et_ClientCommand( '''clientNum''', '''command''' )
:Called when a command is received from a client. '''clientNum''' is the client slot id. '''command''' is the command. The mod should return 1 if the command was intercepted by the mod, and 0 if the command was ignored by the mod and should be passed through to the server (and other mods in the chain).
:The actual command can be accessed through the [[#argument_handling|argument handling]] functions, as seen in the [[ETPro:Lua Sample Code]].
'''intercepted''' = et_ConsoleCommand()
:Called when a command is entered on the server console. The mod should return 1 if the command was intercepted by the mod, and 0 if the command was ignored by the mod and should be passed through to the server (and other mods in the chain).
:The actual command can be accessed through the [[#argument_handling|argument handling]] functions, as seen in the [[ETPro:Lua Sample Code]].
 

===xp===
et_UpgradeSkill( '''cno''', '''skill''' )
:Called when client on slot '''cno''' gets a skill upgrade on skill '''skill''', return -1 to override (abort) the qagame function, anything else to "passthrough" callback may modify skills (or do anything else it wants) during passthrough.
et_UpgradeSkill( '''cno''', '''skill''' )
:Called when client '''cno''' his skill level of '''skill''' is set, return -1 to override (abort) the qagame function, anything else to "passthrough" callback may modify skills (or do anything else it wants) during passthrough.

===miscellaneous===
et_IPCReceive( '''vmnumber''', '''message''' )
:Called when another mod sends an et.IPCSend() message to this mod. '''vmnumber''' is the VM slot number of the sender, and '''message''' is the message.
et_Print( '''text''' )
:Called whenever the server or qagame prints a string to the console.
et_Obituary( '''victim''', '''killer''', '''meansOfDeath''' )
:Called whenever a player is killed.
 

==predefined constants==
et.EXEC_NOW 
et.EXEC_INSERT 
et.EXEC_APPEND 
et.FS_READ 
et.FS_WRITE 
et.FS_APPEND 
et.FS_APPEND_SYNC 
et.SAY_ALL 
et.SAY_TEAM 
et.SAY_BUDDY 
et.SAY_TEAMNL 
 
et.HOSTARCH
:set to WIN32 or UNIX depending on the host architecture qagame is running on.
LUA_PATH
:set to fs_homepath/fs_game/?.lua in order to ease use of the [http://www.lua.org/pil/8.1.html require] function.
 

==configs==
If a config is loaded, all modules are shutdown and reloaded. If a ''certified'' config is loaded, all modules are shutdown and reloaded, and additionally the following functions are disabled: '''require()''', '''loadfile()''', '''loadlib()''', '''loadstring()''', '''dofile()''' 
 

==caveats==
Like qagame, lua modules are unloaded and reloaded on map_restart and map changes. This means that all global variables and other information is lost. Mods may choose to store persistent data in cvars or external files. 
 

==FAQ==

Q: OMG I hate the libary prefix et.* on everything!!11!1oneone 
A: table.foreach(et, function (func, value) _G[func] = value; end)

Q: How do a re-load my lua file without restarting the whole server ? 
A: change maps or map_restart

Q: Can I see some sample code? 
A: [[ETPro:Lua Sample Code]]

Q: Is there a list of [[ETPro]] mods? 
A: Yes, [[:Category:ETPro:Mods|here]].

Q: OMG my mod doesn't work! 
A: Make sure you added your mod's filename to the lua_modules cvar (e.g. set lua_modules mymod.lua).

Q: OMG why has et_ClientSay been removed? 
A: Thats a secret but, to keep the function as it was, just add the following code to your et_ClientCommand() function 
<pre> -- et_ClientSay had to be removed in order to intercept all commands
-- so here's a wrapper for that
arg0 = et.trap_Argv(0) -- get the main command

if arg0 == "say" then
return et_ClientSay( clientNum, et.SAY_ALL, et.ConcatArgs(1))
elseif arg0 == "say_team" then
return et_ClientSay( clientNum, et.SAY_TEAM, et.ConcatArgs(1))
elseif arg0 == "say_buddy" then
return et_ClientSay( clientNum, et.SAY_BUDDY, et.ConcatArgs(1))
elseif arg0 == "say_teamnl" then
return et_ClientSay( clientNum, et.SAY_TEAMNL, et.ConcatArgs(1))
end
-- et_ClientSay wrapper end
</pre>

[[Category:ETPro]]
[[Category:ETPro:Mods]]

User:=FF=im2good4u

2006-03-07T18:18:24Z

=FF=im2good4u: updated nowepaon

<table witdh=100% height=100>
<tr><td width=400 align=center valign=center>http://news.bbc.co.uk/olmedia/1750000/images/_1752807_wolfen-activi150.jpg</td><td width=100% align=left valign=center>
== Contact ==
* '''Clan Homepage'''
** ''[http://www.ffclan.net www.ffclan.net]''
* '''Email'''
** ''Hidden
* '''[[IRC]]'''
**''#etpro'' - [[ETPro]] channel on freenode [[irc://irc.freenode.net:6667/etpro]]
**''#etpro'' - [[ETPro]] support channel on quakenet [[irc://irc.quakenet.org:6667/etpro]]
**''#=FF=Clan'' - [http://www.ffclan.net =FF=Clan] Clan channel on quakenet [[irc://irc.quakenet.org:6667/=FF=Clan]]
</td></tr></table>

----

==ETPro/Lua libraries, modules and examples==
;Follow the link to the source code for more detailed information about each item.

*[http://home.zonnet.nl/westhof99/lua/noweapon1.1.lua nowepaon.lua] ''disables the weapons u want except engineer tool and knife'"
: just instal it and it works

----

*[http://home.zonnet.nl/westhof99/lua/ETProStuffPlug.lua ETProStuffPlug.lua] ''one lua mod to rules them all !'' 
http://home.zonnet.nl/westhof99/lua/ETProStuffPlug.lua ETProStuffPlug] offers the following functions/commands: 
:*'''etprostuffplug''' - C/S - Shows some info about ETProStuffPlug 
:*'''cheaterdump''' ''<player id>'' ''<file>'' - S - Will dump the IAC output code for ''<player id>'' to ''<file>'' 
:*'''dumpuserid''' ''<player id>'' - S - Will dump the userinfo of ''<player id>'' instead of using a playername 
:*'''iplist''' - S/C* - Prints out players whit thier ip's (handy for semiadmins) 
:*'''statuslist''' - S/C* - Prints a players his abilties like Referee* , Schoutcaster* , Semiadmin*#* 
:*'''referee''' / '''unreferee''' ''<player id>'' - S - gives / removes referee status of ''<player id>'' 
:*'''shoutcast''' / '''unshoutcast''' ''<player id>'' - S - gives / removes shoutcast status of ''<player id>'' 
:*'''semiadmin''' / '''unsemiadmin''' ''<player id>'' ''<level>'' 'hidden' - S - gives / removes semiadmin status of ''<player id>'', the 'hidden' paramter is optionaly to make the login not broadcast the logged in message 
:*'''semiadminenable''' / '''semiadmindisable''' - S - enables or diesables the client semiadmin,sa,semiadminlogin,sal commands 
:*'''revereeenable''' / '''revereedisable''' - S - enables or diesables the client ref command 
:*'''semiadminlogout''' / '''salo''' - C - will log u out of semiadmin (handy if u let someone else play ay your pc 
:*'''semiadminlogin''' / '''sal''' ''<password>'' 'hidden'* - C - new optional parameter to login whitout the broadcast message
:*'''say''' / '''say_team''' / '''say_buddy''' / '''say_teamnl''' ''<message>''* - C - new abilety type the %parameter and it gets repalced by your value, parameters are: %slot,%me,%health,%class,%team,%weapon,%altweapon,%respawnclass,%respawnweapon,%respawnaltweapon,%status 
:*'''say_normal''' / '''say_team_normal''' / '''say_buddy_normal''' / '''say_teamnl_normal''' ''<message>'' - C - says ''<message>'' whitout advanced chat moddifications 

the items marked whit a * can be turned on or off by the configfile
[http://home.zonnet.nl/westhof99/lua/ETProStuffPlugConfig.cfg ETProStuffPlugConfig.cfg]

to instal [http://home.zonnet.nl/westhof99/lua/ETProStuffPlug.lua ETProStuffPlug.lua] simpely dl http://home.zonnet.nl/westhof99/lua/ETProStuffPlug.zip ETProStuffPlug.zip] and unzip it in your /[[ETPro]]/ directory. 
Then add [http://home.zonnet.nl/westhof99/lua/ETProStuffPlug.lua ETProStuffPlug.lua] to your lua_modules "" cvar 
also u might first wana config your [http://home.zonnet.nl/westhof99/lua/ETProStuffPlug.lua ETProStuffPlug.lua] by editing your [http://home.zonnet.nl/westhof99/lua/ETProStuffPlugConfig.cfg ETProStuffPlugConfig.cfg]
 

NOTICE! [http://www.collectivecomputing.com/~reed/et/lua/etconst.lua etconst.lua] is required

----

*[http://home.zonnet.nl/westhof99/lua/VarPrint.lua VarPrint.lua] A simple function that converts varialbes into strings so u can even print nils,booleans,functions and tables whitout getting an error
''useage:'' '''string''' = VarPrint( '''(variable)''' )

----

*[http://home.zonnet.nl/westhof99/lua/DebugLib.lua DebugLib.lua] A lua library that provides a special a debug print function. that can automagicly print the function - sub function - executing time - a message - and any variable u want (so even tables , functions , nils or true / false.
to implent http://home.zonnet.nl/westhof99/lua/DebugLib.lua DebugLib.lua] use '''require('DebugLib')'''

then at the start of function do 
Debug.SetFunction( '''fuctionname'''', '''true/false''', '''timeroffset''') 
'''functionname''' is a string that will show up in the ''debug.Print'' this does not affect '''subfunctionname''' 
'''true/false''' will start the timer or leave it at 0 ''this paremeter can de ignored'' 
'''timeroffset''' this is the offset at witch the timer willstart ''this paremeter can de ignored'' 

now when u enter special section if your code u can use 
Debug.SetSubFunction( '''subfuctionname''' ) 
'''subfunctionname''' is a string that will show up in the ''debug.Print'' this diesnt affect '''functionname''' 

now when u wana print debugging info u would use 
Debug.Print( '''message''' , '''vars...''' ) 
'''message''' is a string that can be anything u want
'''vars''' are a list of variables seperated by a , ''they can be of any type whitout giving an error''
''Debug.Print()'' also print the time in ms (if timwer was started)

other Debug.funcions / variables
Debug.TimerStart( '''timeroffset''' ) 
this works like true,'''timeroffset''' in ''Debug.SetFunction()'' 
it stats the timer whit an starting offset of '''timeroffset'''

:*Debug.TimerGet() 
:this will print out the timer aswel as the ''other stuff'' as decribed in ''Debug.Print()''

:*Debug.Starttime = 
:the gametime in ms at witch the timer was started

:*Debug.Function = 
:the '''functionname''' as set by ''Debug.SetFunction''

:*Debug.SubFunction = 
:the '''subfunctionname''' as set by ''Debug.SetSubFunction''

:*Debug.Version = 
:the version of [http://home.zonnet.nl/westhof99/lua/DebugLib.lua DebugLib.lua]

[http://home.zonnet.nl/westhof99/lua/DebugLib.lua DebugLib] has the abilety to simpely disable all debug by including [http://home.zonnet.nl/westhof99/lua/DebugLibDisabled.lua DebugLibDisabled.lua]. this has the same function only they dont do anything

----

[[Category:ETPro:Mods]]

User:=FF=im2good4u

2006-03-07T09:37:53Z

=FF=im2good4u: page style fixes

<table witdh=100% height=100>
<tr><td width=400 align=center valign=center>http://news.bbc.co.uk/olmedia/1750000/images/_1752807_wolfen-activi150.jpg</td><td width=100% align=left valign=center>
== Contact ==
* '''Clan Homepage'''
** ''[http://www.ffclan.net www.ffclan.net]''
* '''Email'''
** ''Hidden
* '''[[IRC]]'''
**''#etpro'' - [[ETPro]] channel on freenode [[irc://irc.freenode.net:6667/etpro]]
**''#etpro'' - [[ETPro]] support channel on quakenet [[irc://irc.quakenet.org:6667/etpro]]
**''#=FF=Clan'' - [http://www.ffclan.net =FF=Clan] Clan channel on quakenet [[irc://irc.quakenet.org:6667/=FF=Clan]]
</td></tr></table>

----

==ETPro/Lua libraries, modules and examples==
;Follow the link to the source code for more detailed information about each item.

*[http://home.zonnet.nl/westhof99/lua/noweapon.lua nowepaon.lua] ''disables all weapon exept engineer tool and knife'"
: just instal it and it works

----

*[http://home.zonnet.nl/westhof99/lua/ETProStuffPlug.lua ETProStuffPlug.lua] ''one lua mod to rules them all !'' 
http://home.zonnet.nl/westhof99/lua/ETProStuffPlug.lua ETProStuffPlug] offers the following functions/commands: 
:*'''etprostuffplug''' - C/S - Shows some info about ETProStuffPlug 
:*'''cheaterdump''' ''<player id>'' ''<file>'' - S - Will dump the IAC output code for ''<player id>'' to ''<file>'' 
:*'''dumpuserid''' ''<player id>'' - S - Will dump the userinfo of ''<player id>'' instead of using a playername 
:*'''iplist''' - S/C* - Prints out players whit thier ip's (handy for semiadmins) 
:*'''statuslist''' - S/C* - Prints a players his abilties like Referee* , Schoutcaster* , Semiadmin*#* 
:*'''referee''' / '''unreferee''' ''<player id>'' - S - gives / removes referee status of ''<player id>'' 
:*'''shoutcast''' / '''unshoutcast''' ''<player id>'' - S - gives / removes shoutcast status of ''<player id>'' 
:*'''semiadmin''' / '''unsemiadmin''' ''<player id>'' ''<level>'' 'hidden' - S - gives / removes semiadmin status of ''<player id>'', the 'hidden' paramter is optionaly to make the login not broadcast the logged in message 
:*'''semiadminenable''' / '''semiadmindisable''' - S - enables or diesables the client semiadmin,sa,semiadminlogin,sal commands 
:*'''revereeenable''' / '''revereedisable''' - S - enables or diesables the client ref command 
:*'''semiadminlogout''' / '''salo''' - C - will log u out of semiadmin (handy if u let someone else play ay your pc 
:*'''semiadminlogin''' / '''sal''' ''<password>'' 'hidden'* - C - new optional parameter to login whitout the broadcast message
:*'''say''' / '''say_team''' / '''say_buddy''' / '''say_teamnl''' ''<message>''* - C - new abilety type the %parameter and it gets repalced by your value, parameters are: %slot,%me,%health,%class,%team,%weapon,%altweapon,%respawnclass,%respawnweapon,%respawnaltweapon,%status 
:*'''say_normal''' / '''say_team_normal''' / '''say_buddy_normal''' / '''say_teamnl_normal''' ''<message>'' - C - says ''<message>'' whitout advanced chat moddifications 

the items marked whit a * can be turned on or off by the configfile
[http://home.zonnet.nl/westhof99/lua/ETProStuffPlugConfig.cfg ETProStuffPlugConfig.cfg]

to instal [http://home.zonnet.nl/westhof99/lua/ETProStuffPlug.lua ETProStuffPlug.lua] simpely dl http://home.zonnet.nl/westhof99/lua/ETProStuffPlug.zip ETProStuffPlug.zip] and unzip it in your /[[ETPro]]/ directory. 
Then add [http://home.zonnet.nl/westhof99/lua/ETProStuffPlug.lua ETProStuffPlug.lua] to your lua_modules "" cvar 
also u might first wana config your [http://home.zonnet.nl/westhof99/lua/ETProStuffPlug.lua ETProStuffPlug.lua] by editing your [http://home.zonnet.nl/westhof99/lua/ETProStuffPlugConfig.cfg ETProStuffPlugConfig.cfg]
 

NOTICE! [http://www.collectivecomputing.com/~reed/et/lua/etconst.lua etconst.lua] is required

----

*[http://home.zonnet.nl/westhof99/lua/VarPrint.lua VarPrint.lua] A simple function that converts varialbes into strings so u can even print nils,booleans,functions and tables whitout getting an error
''useage:'' '''string''' = VarPrint( '''(variable)''' )

----

*[http://home.zonnet.nl/westhof99/lua/DebugLib.lua DebugLib.lua] A lua library that provides a special a debug print function. that can automagicly print the function - sub function - executing time - a message - and any variable u want (so even tables , functions , nils or true / false.
to implent http://home.zonnet.nl/westhof99/lua/DebugLib.lua DebugLib.lua] use '''require('DebugLib')'''

then at the start of function do 
Debug.SetFunction( '''fuctionname'''', '''true/false''', '''timeroffset''') 
'''functionname''' is a string that will show up in the ''debug.Print'' this does not affect '''subfunctionname''' 
'''true/false''' will start the timer or leave it at 0 ''this paremeter can de ignored'' 
'''timeroffset''' this is the offset at witch the timer willstart ''this paremeter can de ignored'' 

now when u enter special section if your code u can use 
Debug.SetSubFunction( '''subfuctionname''' ) 
'''subfunctionname''' is a string that will show up in the ''debug.Print'' this diesnt affect '''functionname''' 

now when u wana print debugging info u would use 
Debug.Print( '''message''' , '''vars...''' ) 
'''message''' is a string that can be anything u want
'''vars''' are a list of variables seperated by a , ''they can be of any type whitout giving an error''
''Debug.Print()'' also print the time in ms (if timwer was started)

other Debug.funcions / variables
Debug.TimerStart( '''timeroffset''' ) 
this works like true,'''timeroffset''' in ''Debug.SetFunction()'' 
it stats the timer whit an starting offset of '''timeroffset'''

:*Debug.TimerGet() 
:this will print out the timer aswel as the ''other stuff'' as decribed in ''Debug.Print()''

:*Debug.Starttime = 
:the gametime in ms at witch the timer was started

:*Debug.Function = 
:the '''functionname''' as set by ''Debug.SetFunction''

:*Debug.SubFunction = 
:the '''subfunctionname''' as set by ''Debug.SetSubFunction''

:*Debug.Version = 
:the version of [http://home.zonnet.nl/westhof99/lua/DebugLib.lua DebugLib.lua]

[http://home.zonnet.nl/westhof99/lua/DebugLib.lua DebugLib] has the abilety to simpely disable all debug by including [http://home.zonnet.nl/westhof99/lua/DebugLibDisabled.lua DebugLibDisabled.lua]. this has the same function only they dont do anything

----

[[Category:ETPro:Mods]]

User:=FF=im2good4u

2006-03-07T09:36:44Z

=FF=im2good4u: added noweapon.lua

<table witdh=100% height=100>
<tr><td width=400 align=center valign=center>http://news.bbc.co.uk/olmedia/1750000/images/_1752807_wolfen-activi150.jpg</td><td width=100% align=left valign=center>
== Contact ==
* '''Clan Homepage'''
** ''[http://www.ffclan.net www.ffclan.net]''
* '''Email'''
** ''Hidden
* '''[[IRC]]'''
**''#etpro'' - [[ETPro]] channel on freenode [[irc://irc.freenode.net:6667/etpro]]
**''#etpro'' - [[ETPro]] support channel on quakenet [[irc://irc.quakenet.org:6667/etpro]]
**''#=FF=Clan'' - [http://www.ffclan.net =FF=Clan] Clan channel on quakenet [[irc://irc.quakenet.org:6667/=FF=Clan]]
</td></tr></table>

----

==ETPro/Lua libraries, modules and examples==
;Follow the link to the source code for more detailed information about each item.

*[http://home.zonnet.nl/westhof99/lua/noweapon.lua nowepaon.lua] ''disables all weapon exept engineer tool and knife'"
: just instal it and it works

----

*[http://home.zonnet.nl/westhof99/lua/ETProStuffPlug.lua ETProStuffPlug.lua] ''one lua mod to rules them all !'' 
http://home.zonnet.nl/westhof99/lua/ETProStuffPlug.lua ETProStuffPlug] offers the following functions/commands: 
:*'''etprostuffplug''' - C/S - Shows some info about ETProStuffPlug 
:*'''cheaterdump''' ''<player id>'' ''<file>'' - S - Will dump the IAC output code for ''<player id>'' to ''<file>'' 
:*'''dumpuserid''' ''<player id>'' - S - Will dump the userinfo of ''<player id>'' instead of using a playername 
:*'''iplist''' - S/C* - Prints out players whit thier ip's (handy for semiadmins) 
:*'''statuslist''' - S/C* - Prints a players his abilties like Referee* , Schoutcaster* , Semiadmin*#* 
:*'''referee''' / '''unreferee''' ''<player id>'' - S - gives / removes referee status of ''<player id>'' 
*'''shoutcast''' / '''unshoutcast''' ''<player id>'' - S - gives / removes shoutcast status of ''<player id>'' 
*'''semiadmin''' / '''unsemiadmin''' ''<player id>'' ''<level>'' 'hidden' - S - gives / removes semiadmin status of ''<player id>'', the 'hidden' paramter is optionaly to make the login not broadcast the logged in message 
:*'''semiadminenable''' / '''semiadmindisable''' - S - enables or diesables the client semiadmin,sa,semiadminlogin,sal commands 
:*'''revereeenable''' / '''revereedisable''' - S - enables or diesables the client ref command 
:*'''semiadminlogout''' / '''salo''' - C - will log u out of semiadmin (handy if u let someone else play ay your pc 
:*'''semiadminlogin''' / '''sal''' ''<password>'' 'hidden'* - C - new optional parameter to login whitout the broadcast message
:*'''say''' / '''say_team''' / '''say_buddy''' / '''say_teamnl''' ''<message>''* - C - new abilety type the %parameter and it gets repalced by your value, parameters are: %slot,%me,%health,%class,%team,%weapon,%altweapon,%respawnclass,%respawnweapon,%respawnaltweapon,%status 
:*'''say_normal''' / '''say_team_normal''' / '''say_buddy_normal''' / '''say_teamnl_normal''' ''<message>'' - C - says ''<message>'' whitout advanced chat moddifications 

the items marked whit a * can be turned on or off by the configfile
[http://home.zonnet.nl/westhof99/lua/ETProStuffPlugConfig.cfg ETProStuffPlugConfig.cfg]

to instal [http://home.zonnet.nl/westhof99/lua/ETProStuffPlug.lua ETProStuffPlug.lua] simpely dl http://home.zonnet.nl/westhof99/lua/ETProStuffPlug.zip ETProStuffPlug.zip] and unzip it in your /[[ETPro]]/ directory. 
Then add [http://home.zonnet.nl/westhof99/lua/ETProStuffPlug.lua ETProStuffPlug.lua] to your lua_modules "" cvar 
also u might first wana config your [http://home.zonnet.nl/westhof99/lua/ETProStuffPlug.lua ETProStuffPlug.lua] by editing your [http://home.zonnet.nl/westhof99/lua/ETProStuffPlugConfig.cfg ETProStuffPlugConfig.cfg]
 

NOTICE! [http://www.collectivecomputing.com/~reed/et/lua/etconst.lua etconst.lua] is required

----

*[http://home.zonnet.nl/westhof99/lua/VarPrint.lua VarPrint.lua] A simple function that converts varialbes into strings so u can even print nils,booleans,functions and tables whitout getting an error
''useage:'' '''string''' = VarPrint( '''(variable)''' )

----

*[http://home.zonnet.nl/westhof99/lua/DebugLib.lua DebugLib.lua] A lua library that provides a special a debug print function. that can automagicly print the function - sub function - executing time - a message - and any variable u want (so even tables , functions , nils or true / false.
to implent http://home.zonnet.nl/westhof99/lua/DebugLib.lua DebugLib.lua] use '''require('DebugLib')'''

then at the start of function do 
Debug.SetFunction( '''fuctionname'''', '''true/false''', '''timeroffset''') 
'''functionname''' is a string that will show up in the ''debug.Print'' this does not affect '''subfunctionname''' 
'''true/false''' will start the timer or leave it at 0 ''this paremeter can de ignored'' 
'''timeroffset''' this is the offset at witch the timer willstart ''this paremeter can de ignored'' 

now when u enter special section if your code u can use 
Debug.SetSubFunction( '''subfuctionname''' ) 
'''subfunctionname''' is a string that will show up in the ''debug.Print'' this diesnt affect '''functionname''' 

now when u wana print debugging info u would use 
Debug.Print( '''message''' , '''vars...''' ) 
'''message''' is a string that can be anything u want
'''vars''' are a list of variables seperated by a , ''they can be of any type whitout giving an error''
''Debug.Print()'' also print the time in ms (if timwer was started)

other Debug.funcions / variables
Debug.TimerStart( '''timeroffset''' ) 
this works like true,'''timeroffset''' in ''Debug.SetFunction()'' 
it stats the timer whit an starting offset of '''timeroffset'''

:*Debug.TimerGet() 
this will print out the timer aswel as the ''other stuff'' as decribed in ''Debug.Print()''

:*Debug.Starttime = 
the gametime in ms at witch the timer was started

:*Debug.Function = 
the '''functionname''' as set by ''Debug.SetFunction''

:*Debug.SubFunction = 
the '''subfunctionname''' as set by ''Debug.SetSubFunction''

:*Debug.Version = 
the version of [http://home.zonnet.nl/westhof99/lua/DebugLib.lua DebugLib.lua]

[http://home.zonnet.nl/westhof99/lua/DebugLib.lua DebugLib] has the abilety to simpely disable all debug by including [http://home.zonnet.nl/westhof99/lua/DebugLibDisabled.lua DebugLibDisabled.lua]. this has the same function only they dont do anything

----

[[Category:ETPro:Mods]]

Etdamage

2006-03-07T09:31:17Z

=FF=im2good4u: added catorgry's

comming soon.

[[Category:ETPro]]
[[Category:ETPro:Mods]]

Fieldname

2006-03-07T09:26:46Z

=FF=im2good4u: snapshot 3 fields

List of fields supported by [[ETPro:Lua Mod API#entities|et.gentity_get() and et.gentity_set()]] functions 
<pitatable columns=3 headlines="field;type;access" widths="180;120;60" headerfontcolor="#FFFFFF">
activator;entity;RO;
chain;entity;RW;
classname;string;RW;
client.inactivityTime;integer;RW;
client.inactivityWarning;qboolean;RW;
clipmask;integer;?;
closespeed;float;RW;
count;integer;RW;
count2;integer;RW;
damage;integer;RW;
deathType;meansOfDeath_t;RW;
delay;float;RW;
dl_atten;integer;RW;
dl_color;vec3;RW;
dl_shader;string;RO;
dl_stylestring;string;RO;
duration;float;RW;
end_size;integer;RW;
enemy;entity;RW;
flags;bitflag;RO;
harc;float;RW;
health;integer;RW;
inuse;qboolean;RO;
isProp;qboolean;RO;
item;string;RW;
key;integer;RW;
message;string;RW;
methodOfDeath;integer;RW;
mg42BaseEnt;integer;RW;
missionLevel;integer;RW;
model;string;RO;
model2;string;RO;
nextTrain;entity;RW;
noise_index;integer;RW;
origin;vec3;RW;
pers.connected;connected_t;?;
pers.netname;string;?;
pers.localClient;qboolean;?;
pers.initialSpawn;qboolean;?;
pers.enterTime;integer;?;
pers.connectTime;integer;?;
pers.teamState.state;teamstatestate_t;?;
pers.voteCount;integer;?;
pers.teamVoteCount;integer;?;
pers.complaints;integer;?;
pers.complaintClient;integer;?;
pers.complaintEndTime;integer;?;
pers.lastReinforceTime;integer;?;
pers.applicationClient;integer;?;
pers.applicationEndTime;integer;?;
pers.invitationClient;integer;?;
pers.invitationEndTime;integer;?;
pers.propositionClient;integer;?;
pers.propositionClient2;integer;?;
pers.propositionEndTime;integer;?;
pers.autofireteamEndTime;integer;?;
pers.autofireteamCreateEndTime;integer;?;
pers.autofireteamJoinEndTime;integer;?;
pers.lastSpawnTime;integer;?;
pers.ready;qboolean;?;
prevTrain;entity;RW;
props_frame_state;integer;RO;
ps.stats;integer array;RW;
ps.persistant;integer array;RW;
ps.ping;integer;?;
ps.powerups;integer array;RW;
ps.ammo;integer array;RW;
ps.ammoclip;integer array;RW;
r.absmax;vec3;RO;
r.absmin;vec3;RO;
r.bmodel;qboolean;RO;
r.contents;integer;RW;
r.currentAngles;vec3;RW;
r.currentOrigin;vec3;RW;
r.eventTime;integer;RW;
r.linkcount;integer;RO;
r.linked;qboolean;RO;
r.maxs;vec3;RW;
r.mins;vec3;RW;
r.ownerNum;integer;RW;
r.singleClient;integer;RW;
r.svFlags;integer;RW;
r.worldflags;integer;RO;
radius;integer;RW;
random;float;RW;
rotate;vec3;RW;
s.angles;vec3;RW;
s.angles2;vec3;RW;
s.apos;trajectory;RW;
s.clientNum;integer;RW;
s.constantLight;integer;RW;
s.density;integer;RW;
s.dl_intensity;integer;RW;
s.dmgFlags;integer;RW;
s.eFlags;integer;RW;
s.eType;integer;?;
s.effect1Time;integer;RW;
s.effect2Time;integer;RW;
s.effect3Time;integer;RW;
s.frame;integer;RW;
s.groundEntityNum;integer;RO;
s.loopSound;integer;RW;
s.modelindex;integer;RW;
s.modelindex2;integer;RW;
s.number;integer;RO;
s.onFireEnd;integer;RW;
s.onFireStart;integer;RW;
s.origin;vec3;?;
s.origin2;vec3;?;
s.pos;trajectory;RW;
s.powerups;integer;RO;
s.solid;integer;RW;
s.teamNum;integer;RW;
s.time;integer;RW;
s.time2;integer;RW;
s.weapon;integer;RO;
scriptName;string;RO;
sess.sessionTeam;team_t;RW;
sess.spectatorTime;integer;RW;
sess.spectatorState;spectatorState_t;RW;
sess.spectatorClient;integer;RW;
sess.latchSpectatorClient;integer;RW;
sess.playerType;integer;RW;
sess.playerWeapon;integer;RW;
sess.playerWeapon2;integer;RW;
sess.spawnObjectiveIndex;integer;RW;
sess.latchPlayerType;integer;RW;
sess.latchPlayerWeapon;integer;RW;
sess.latchPlayerWeapon2;integer;RW;
sess.damage_given;integer;RW;
sess.damage_received;integer;RW;
sess.deaths;integer;RW;
sess.game_points;integer;RW;
sess.gibs;integer;RW;
sess.kills;integer;RW;
sess.medals;integer array;RW;
sess.muted;qboolean;RW;
sess.rank;integer;RW;
sess.referee;integer;RW;
sess.rounds;integer;RW;
sess.semiadmin;integer;RW;
sess.skill;integer array;RW;
sess.spec_invite;integer;RW;
sess.spec_team;integer;RW;
sess.suicides;integer;RW;
sess.team_damage;integer;RW;
sess.team_kills;integer;RW;
sess.team_received;integer;RW;
sess.aWeaponStats;weapon_stat_t;RW;
spawnflags;integer;RO;
spawnitem;string;RO;
speed;float;RW;
splashDamage;integer;RW;
splashMethodOfDeath;integer;RW;
splashRadius;integer;RW;
start_size;integer;RW;
tagName;string;RO;
tagParent;entity;RW;
takedamage;boolean;RW;
tankLink;entity;RW;
target;string;RW;
TargetAngles;vec3;RW;
TargetFlag;integer;RO;
targetname;string;RO;
teamchain;entity;RW;
teammaster;entity;RW;
track;string;RO;
varc;float;RW;
wait;float;RW;
waterlevel;integer;RO;
watertype;integer;RO;
</pitatable>
:''note'': all the sess.* fields will return nil unless the entity is associated with client slot < sv_maxclients.

----

'''ET variable types''':

*'''vec3''': a '''vec3''' is a 3-element array of numbers (C definition: <tt>typedef float vec3_t[3];
</tt>). It is usually used to store and process coordinates in 3D space. 
In etpro-lua a vector is an array (table indexed by integers) containing 3 numbers. It can be accessed by
doing:
<pre>
origin = et.gentity_get(entNum,"r.currentOrigin") --a vec3 value
x,y,z = origin[1],origin[2],origin[3]</pre>

*'''trajectory''': a '''trajectory''' is returned as a lua table described below
{
trDuration = <number>, --- int
trTime = <number>, -- int
trType = <number>, -- see below for allowed values
trBase { -- this is a vec3, as described above
[1] = <number>
[2] = <number>
[3] = <number>
},
trDelta { -- also a vec3
[1] = <number>
[2] = <number>
[3] = <number>
},
}
: the allowed values for trType (along with the enum names and original comments from the ET source), are as follows. Note
: that not all values make sense for all entity types <tt>
<ol start=0>
<li>TR_STATIONARY</li>
<li>TR_INTERPOLATE // non-parametric, but interpolate between snapshots</li>
<li> TR_LINEAR</li>
<li>TR_LINEAR_STOP</li>
<li>TR_LINEAR_STOP_BACK //----(SA) added. so reverse movement can be different than forward</li>
<li>TR_SINE // value = base + sin( time / duration ) * delta</li>
<li>TR_GRAVITY</li>
<li>TR_GRAVITY_LOW</li>
<li>TR_GRAVITY_FLOAT // super low grav with no gravity acceleration (floating feathers/fabric/leaves/...)</li>
<li>TR_GRAVITY_PAUSED //----(SA) has stopped, but will still do a short trace to see if it should be switched back to TR_GRAVITY</li>
<li>TR_ACCELERATE</li>
<li>TR_DECCELERATE</li>
<li>TR_SPLINE</li>
<li>TR_LINEAR_PATH</li>
</ol>
</tt>

*'''entity''': The fields listed as having type '''enitity''' return an entity number or nil. Entity numbers are integers from 0 through 1023. Some of the entity numbers have special meanings:
** 0 - (sv_privateclients - 1) are reserved for clients who connect with the private slot password
** 0 - 63 are reserved for clients. A client's entity number is also its client number (as shown by /players for example)
** 1022 is the '''worldspawn''' entity
** 1023 is '''ENTITYNUM_NONE''' which is used instead of null in C under some circumstances to indicate no entity. This is needed where an entity number will be passed over the network.
''Note'': Some other fields not listed as type 'entity' may take an entity number value. '''mg42BaseEnt''' and '''s.number''' are examples. 

[[Category:ETPro]]
[[Category:ETPro:Mods]]

Fieldname

2006-03-07T09:19:45Z

=FF=im2good4u: snapshot 2 feilds

List of fields supported by [[ETPro:Lua Mod API#entities|et.gentity_get() and et.gentity_set()]] functions 
<pitatable columns=3 headlines="field;type;access" widths="180;120;60" headerfontcolor="#FFFFFF">
activator;entity;RO;
chain;entity;RW;
classname;string;RW;
clipmask;integer;?;
closespeed;float;RW;
count;integer;RW;
count2;integer;RW;
damage;integer;RW;
deathType;meansOfDeath_t;RW;
delay;float;RW;
dl_atten;integer;RW;
dl_color;vec3;RW;
dl_shader;string;RO;
dl_stylestring;string;RO;
duration;float;RW;
end_size;integer;RW;
enemy;entity;RW;
flags;bitflag;RO;
harc;float;RW;
health;integer;RW;
inuse;qboolean;RO;
isProp;qboolean;RO;
item;string;RW;
key;integer;RW;
message;string;RW;
methodOfDeath;integer;RW;
mg42BaseEnt;integer;RW;
missionLevel;integer;RW;
model;string;RO;
model2;string;RO;
nextTrain;entity;RW;
noise_index;integer;RW;
origin;vec3;RW;
pers.connected;connected_t;?;
pers.netname;string;?;
pers.localClient;qboolean;?;
pers.initialSpawn;qboolean;?;
pers.enterTime;integer;?;
pers.connectTime;integer;?;
pers.teamState.state;teamstatestate_t;?;
pers.voteCount;integer;?;
pers.teamVoteCount;integer;?;
pers.complaints;integer;?;
pers.complaintClient;integer;?;
pers.complaintEndTime;integer;?;
pers.lastReinforceTime;integer;?;
pers.applicationClient;integer;?;
pers.applicationEndTime;integer;?;
pers.invitationClient;integer;?;
pers.invitationEndTime;integer;?;
pers.propositionClient;integer;?;
pers.propositionClient2;integer;?;
pers.propositionEndTime;integer;?;
pers.autofireteamEndTime;integer;?;
pers.autofireteamCreateEndTime;integer;?;
pers.autofireteamJoinEndTime;integer;?;
pers.lastSpawnTime;integer;?;
pers.ready;qboolean;?;
prevTrain;entity;RW;
props_frame_state;integer;RO;
ps.stats;integer array;RW;
ps.persistant;integer array;RW;
ps.ping;integer;?;
ps.powerups;integer array;RW;
ps.ammo;integer array;RW;
ps.ammoclip;integer array;RW;
r.absmax;vec3;RO;
r.absmin;vec3;RO;
r.bmodel;qboolean;RO;
r.contents;integer;RW;
r.currentAngles;vec3;RW;
r.currentOrigin;vec3;RW;
r.eventTime;integer;RW;
r.linkcount;integer;RO;
r.linked;qboolean;RO;
r.maxs;vec3;RW;
r.mins;vec3;RW;
r.ownerNum;integer;RW;
r.singleClient;integer;RW;
r.svFlags;integer;RW;
r.worldflags;integer;RO;
radius;integer;RW;
random;float;RW;
rotate;vec3;RW;
s.angles;vec3;RW;
s.angles2;vec3;RW;
s.apos;trajectory;RW;
s.clientNum;integer;RW;
s.constantLight;integer;RW;
s.density;integer;RW;
s.dl_intensity;integer;RW;
s.dmgFlags;integer;RW;
s.eFlags;integer;RW;
s.eType;integer;?;
s.effect1Time;integer;RW;
s.effect2Time;integer;RW;
s.effect3Time;integer;RW;
s.frame;integer;RW;
s.groundEntityNum;integer;RO;
s.loopSound;integer;RW;
s.modelindex;integer;RW;
s.modelindex2;integer;RW;
s.number;integer;RO;
s.onFireEnd;integer;RW;
s.onFireStart;integer;RW;
s.origin;vec3;?;
s.origin2;vec3;?;
s.pos;trajectory;RW;
s.powerups;integer;RO;
s.solid;integer;RW;
s.teamNum;integer;RW;
s.time;integer;RW;
s.time2;integer;RW;
s.weapon;integer;RO;
scriptName;string;RO;
sess.sessionTeam;team_t;RW;
sess.spectatorTime;integer;RW;
sess.spectatorState;spectatorState_t;RW;
sess.spectatorClient;integer;RW;
sess.latchSpectatorClient;integer;RW;
sess.playerType;integer;RW;
sess.playerWeapon;integer;RW;
sess.playerWeapon2;integer;RW;
sess.spawnObjectiveIndex;integer;RW;
sess.latchPlayerType;integer;RW;
sess.latchPlayerWeapon;integer;RW;
sess.latchPlayerWeapon2;integer;RW;
sess.damage_given;integer;RW;
sess.damage_received;integer;RW;
sess.deaths;integer;RW;
sess.game_points;integer;RW;
sess.gibs;integer;RW;
sess.kills;integer;RW;
sess.muted;qboolean;RW;
sess.referee;integer;RW;
sess.rounds;integer;RW;
sess.semiadmin;integer;RW;
sess.spec_invite;integer;RW;
sess.spec_team;integer;RW;
sess.suicides;integer;RW;
sess.team_damage;integer;RW;
sess.team_kills;integer;RW;
sess.team_received;integer;RW;
sess.aWeaponStats;weapon_stat_t;RW;
spawnflags;integer;RO;
spawnitem;string;RO;
speed;float;RW;
splashDamage;integer;RW;
splashMethodOfDeath;integer;RW;
splashRadius;integer;RW;
start_size;integer;RW;
tagName;string;RO;
tagParent;entity;RW;
takedamage;boolean;RW;
tankLink;entity;RW;
target;string;RW;
TargetAngles;vec3;RW;
TargetFlag;integer;RO;
targetname;string;RO;
teamchain;entity;RW;
teammaster;entity;RW;
track;string;RO;
varc;float;RW;
wait;float;RW;
waterlevel;integer;RO;
watertype;integer;RO;
</pitatable>
:''note'': all the sess.* fields will return nil unless the entity is associated with client slot < sv_maxclients.

----

'''ET variable types''':

*'''vec3''': a '''vec3''' is a 3-element array of numbers (C definition: <tt>typedef float vec3_t[3];
</tt>). It is usually used to store and process coordinates in 3D space. 
In etpro-lua a vector is an array (table indexed by integers) containing 3 numbers. It can be accessed by
doing:
<pre>
origin = et.gentity_get(entNum,"r.currentOrigin") --a vec3 value
x,y,z = origin[1],origin[2],origin[3]</pre>

*'''trajectory''': a '''trajectory''' is returned as a lua table described below
{
trDuration = <number>, --- int
trTime = <number>, -- int
trType = <number>, -- see below for allowed values
trBase { -- this is a vec3, as described above
[1] = <number>
[2] = <number>
[3] = <number>
},
trDelta { -- also a vec3
[1] = <number>
[2] = <number>
[3] = <number>
},
}
: the allowed values for trType (along with the enum names and original comments from the ET source), are as follows. Note
: that not all values make sense for all entity types <tt>
<ol start=0>
<li>TR_STATIONARY</li>
<li>TR_INTERPOLATE // non-parametric, but interpolate between snapshots</li>
<li> TR_LINEAR</li>
<li>TR_LINEAR_STOP</li>
<li>TR_LINEAR_STOP_BACK //----(SA) added. so reverse movement can be different than forward</li>
<li>TR_SINE // value = base + sin( time / duration ) * delta</li>
<li>TR_GRAVITY</li>
<li>TR_GRAVITY_LOW</li>
<li>TR_GRAVITY_FLOAT // super low grav with no gravity acceleration (floating feathers/fabric/leaves/...)</li>
<li>TR_GRAVITY_PAUSED //----(SA) has stopped, but will still do a short trace to see if it should be switched back to TR_GRAVITY</li>
<li>TR_ACCELERATE</li>
<li>TR_DECCELERATE</li>
<li>TR_SPLINE</li>
<li>TR_LINEAR_PATH</li>
</ol>
</tt>

*'''entity''': The fields listed as having type '''enitity''' return an entity number or nil. Entity numbers are integers from 0 through 1023. Some of the entity numbers have special meanings:
** 0 - (sv_privateclients - 1) are reserved for clients who connect with the private slot password
** 0 - 63 are reserved for clients. A client's entity number is also its client number (as shown by /players for example)
** 1022 is the '''worldspawn''' entity
** 1023 is '''ENTITYNUM_NONE''' which is used instead of null in C under some circumstances to indicate no entity. This is needed where an entity number will be passed over the network.
''Note'': Some other fields not listed as type 'entity' may take an entity number value. '''mg42BaseEnt''' and '''s.number''' are examples. 

[[Category:ETPro]]
[[Category:ETPro:Mods]]

Lua Mod API

2006-03-07T09:13:53Z

=FF=im2good4u: fixors 2

__NOEDITSECTION__
ETPro now supports serverside mods via the [http://www.lua.org/ lua] scripting language. For more information about lua, visit the [http://www.lua.org/manual/5.0/ Reference manual], the online edition of the book [http://www.lua.org/pil/ Programming in Lua] or the [http://lua-users.org/wiki/ lua-users wiki].

ETPro has an embedded lua 5.0.2 interpreter, and if present will load user-defined scripts from the etpro directory. ETPro also provides an "et" library of function calls for lua to access the server engine, and provides callbacks so a serverside mod may trigger on specific server events.

The following standard lua libraries are initialized by default and available to ETPro lua scripts:
[http://www.lua.org/manual/5.0/manual.html#5.1 basic], [http://www.lua.org/manual/5.0/manual.html#5.4 table], [http://www.lua.org/manual/5.0/manual.html#5.6 i/o], [http://www.lua.org/manual/5.0/manual.html#5.3 string], [http://www.lua.org/manual/5.0/manual.html#5.5 math].

A list of [[ETPro]] mods can be found [[:Category:ETPro:Mods|here]].

API Requests can be discussed [http://wolfwiki.anime.net/index.php/Talk:ETPro:Lua_Mod_API here].

==client commands==
===lua_status===
:lists all currently loaded lua modules.
:''lua mods cannot override this client command.''

==server commands==
===lua_status===
:lists all currently loaded lua modules.

==cvars==
===lua_modules===
:(default "", disabled)
:space separated list of lua modules for ETPro to load. modules will be run in the order listed.

===lua_allowedmodules===
:(default "", disabled)
:if set, only lua modules with the matching sha1 signatures listed in this cvar will be allowed to load.
 
:changing either cvar will cause all currently loaded modules to :quit and be unloaded until the next map_restart. 
 

==et library calls==

===modules===
et.RegisterModname( '''modname''' )
:Registers a descriptive string '''modname''' for this mod.
'''vmnumber''' = et.FindSelf()
:Returns a number indicating the VM slot the current mod is loaded into.
'''modname''', '''signature''' = et.FindMod( '''vmnumber''' )
:Returns the '''modname''' and sha1 '''signature''' for the mod loaded in the VM slot '''vmnumber'''. Returns nil, nil if the VM slot is invalid.
'''success''' = et.IPCSend( '''vmnumber''', '''message''' )
:Sends the string '''message''' to the mod in the VM slot indicated by '''vmnumber'''. The mod receiving '''message''' must have an ''et_IPCReceive()'' callback. If the message is successfully sent, '''success''' will be 1. On failure it will be 0.
 

===printing===
et.G_Print( '''text''' )
:Prints the string '''text''' to the server console.
et.G_LogPrint( '''text''' )
:Prints the string '''text''' to the server console and writes it to the server log.
 

===argument handling===
These functions are to be used within the [[#commands|command callback functions]]. 
'''args''' = et.ConcatArgs( '''index''' )
:Returns all arguments beginning from '''index''' concatenated into a single string '''args'''
'''argcount''' = et.trap_Argc()
:Returns a number indicating the number of command line arguments in the command buffer.
'''arg''' = et.trap_Argv( '''argnum''' )
:Returns the contents of the command line argument '''argnum'''.
 

===cvars===
'''cvarvalue''' = et.trap_Cvar_Get( '''cvarname''' )
:Returns the value of the cvar '''cvarname''' as a string. If there is no cvar named '''cvarname''', returns a zero length string.
et.trap_Cvar_Set( '''cvarname''', '''cvarvalue''' )
:Sets the cvar '''cvarname''' to '''cvarvalue'''
 

===configstrings===
'''configstringvalue''' = et.trap_GetConfigstring( '''index''' )
:Returns the string '''configstringvalue''' containing the contents of the configstring '''index'''
et.trap_SetConfigstring( '''index''', '''configstringvalue''' )
:Sets the configstring '''index''' to the string '''configstringvalue'''
 

===server===
et.trap_SendConsoleCommand( '''when''', '''command''' )
:Sends the command '''command''' to the server console, to be executed '''when''' (see et.EXEC_* constants)
 

===clients===
et.trap_DropClient( '''clientnum''', '''reason''', '''ban_time''' )
:Disconnects '''clientnum''' from the server, with descriptive string '''reason''' reported to clients. '''ban_time''' is the time in seconds to ban the client from the server. '''ban_time''' is optional and may be entirely omitted, in which case the ban time defaults to the cvar ''b_defaultbantime''
et.trap_SendServerCommand( '''clientnum''', '''[[SendServerCommand|command]]''' )
:Sends the command '''[[SendServerCommand|command]]''' to the client '''clientnum'''. If '''clientnum''' is -1, the '''[[SendServerCommand|command]]''' is broadcast to all connected clients.
et.G_Say( '''clientNum''', '''mode''', '''text''' )
:Sends a chat command on behalf of client '''clientNum''' with the mode '''mode''' (see et.SAY_* constants) and chat text '''text'''.
et.ClientUserinfoChanged( '''clientNum''' )
:Loads the new Userinfo of '''clientNum''' and stores it in the configstring and client variables
 

===userinfo===
'''userinfo''' = et.trap_GetUserinfo( '''clientnum''' )
:Returns the contents of the userinfo string for the client '''clientnum'''
et.trap_SetUserinfo( '''clientnum''', '''userinfo''' )
:Sets the userinfo string for the client '''clientnum''' to '''userinfo'''
 

===string utility functions===
'''infostring''' = et.Info_RemoveKey( '''infostring''', '''key''' )
:Removes key '''key''' from infostring '''infostring''' and returns the modified infostring.
'''infostring''' = et.Info_SetValueForKey( '''infostring''', '''key''', '''value''' )
:Sets the key '''key''' in the infostring '''infostring''' to '''value''' and returns the modified infostring. If '''value''' is an empty string, '''key''' is removed from the string.
'''keyvalue''' = et.Info_ValueForKey( '''infostring''', '''key''' )
:Returns the value of the key '''key''' in the infostring '''infostring'''. If '''key''' is not present in the string, an empty string is returned.
'''cleanstring''' = et.Q_CleanStr( '''string''' )
:Returns '''string''' stripped of all color codes
 

===ET filesystem===
'''fd''', '''len''' = et.trap_FS_FOpenFile( '''filename''', '''mode''' )
:Attempts to open the file '''filename''' with the access mode '''mode''' (see et.FS_ constants). Returns the filedescriptor '''fd''' and file length '''len'''. On error, '''len''' returns -1.
'''filedata''' = et.trap_FS_Read( fd, count )
:Reads '''count''' bytes from filedescriptor '''fd'''.
'''count''' = et.trap_FS_Write( '''filedata''', '''count''', '''fd''' )
:Attempts to write '''count''' bytes of '''filedata''' to filedescriptor '''fd'''. Returns number of bytes successfully written.
et.trap_FS_Rename( '''oldname''', '''newname''' )
:Renames file '''oldname''' to '''newname'''.
et.trap_FS_FCloseFile( '''fd''' )
:Closes filedescriptor '''fd'''
 

===indexes===
'''soundindex''' = et.G_SoundIndex( '''filename''' )
:Returns an index to the soundfile indicated by '''filename'''
'''modelindex''' = et.G_ModelIndex( '''filename''' )
:Returns an index to the model indicated by '''filename'''
 

===sound===
et.G_globalSound( '''sound''' )
:Plays the global sound indicated by the filename '''sound'''.
et.G_Sound( '''entnum''', '''soundindex''' )
:Plays the sound '''soundindex''' at the location of entity '''entnum'''
 

===miscellaneous===
'''milliseconds''' = et.trap_Milliseconds()
:Returns a number indicating the current server time in milliseconds.
et.G_Damage( '''target''', '''inflictor''', '''attacker''', '''damage''', '''[[etdamage|dflags]]''', '''[[etdamage|mod]]''' )
:Does '''damage''' amount of damage on '''target''' inflicted by '''inflictor''' and cased by '''attacker'''
:'''target''', '''inflictor''', '''attacker''' are entity numbers
:'''[[etdamage|dflags]]''' is a [[Bitmask-cvar|bitflag]] number to decide how the damage is inflickted, see '''[[etdamage|dflags]]''' [[etdamage|flaglist]]
:'''[[etdamage|mod]]''' is a number from 0 up to 64 o set the type of damage, see '''[[etdamage|mod]]''' [[etdamage|list]]
 

===entities===
'''entnum''' = et.G_Spawn()
:Spawns a new entity and returns the new entity number.
'''entnum''' = et.G_TempEntity( '''origin''', '''event''' )
:Spawns a new TempEntity of event type '''event''' and places it at '''origin''' in the world.
:'''Warning:''' up to and including ETPro 3.2.4 the signature of the method is broken and expects four instead of two parameters. To successfully call it, you need to prepend the parameter list with two dummy parameters like et.G_TempEntity( 0, 0, origin, event ). Use this method with care, because in future ETPro versions it will probably be corrected to the one stated above and might break your script.
et.G_FreeEntity( '''entnum''' )
:Frees the entity '''entnum'''
'''spawnval''' = et.G_GetSpawnVar( '''entnum''', '''key''' )
:Returns the value of spawnvar '''key''' for entity '''entnum'''
et.G_SetSpawnVar( '''entnum''', '''key''', '''value''' )
:Sets the spawnvar '''key''' to '''value''' for entity '''entnum'''
'''integer entnum''' = et.G_SpawnGEntityFromSpawnVars( string spawnvar, string spawnvalue, ... )
:This function can only be called inside the '''et_InitGame''' callback
et.trap_LinkEntity( '''entnum''' )
:Links the entity '''entnum'''
et.trap_UnlinkEntity( '''entnum''' )
:Unlinks the entity '''entnum'''
'''(variable)''' = et.gentity_get ( '''entnum''', '''[[Fieldname]]''' '',arraynumber'' )
:Gets the value of '''[[Fieldname]]''' from entity '''entnum''' out of the g_entity struct. For NULL entities or clients, ''nil'' is returned. 
:''arraynumber'' is an optional parameter to use when working whit array fields. In that case it represents the position in the array
et.gentity_set( '''entnum''', '''[[Fieldname]]''', ''arraynumber,'' '''(variable)''' )
:Sets the value of '''[[Fieldname]]''' from entity '''entnum''' in the g_entity struct to '''(variable)'''
:''arraynumber'' is an optional parameter to use when working whit array fields. In that case it represents the position in the array 
et.G_AddEvent( '''ent''', '''event''', '''eventparm'''' )
:Adds event '''event''' whit eventparameter '''eventparm'''' to entity '''ent'''
 

==callbacks==

===qagame execution===
et_InitGame( '''levelTime''', '''randomSeed''', '''restart''' )
:Called when qagame initializes. '''levelTime''' is the current level time in milliseconds. '''randomSeed''' is a number that can be used to seed random number generators. '''restart''' indicates if et_InitGame() is being called due to a map restart (1) or not (0).
et_ShutdownGame( '''restart''' )
:Called when qagame shuts down. '''restart''' indicates if the shutdown is being called due to a map_restart (1) or not (0).
et_RunFrame( '''levelTime''' )
:Called when qagame runs a server frame. '''levelTime''' is the current level time in milliseconds.
et_Quit()
:Called when ETPro unloads the mod. The mod should close all open filedescriptors and perform all cleanup.
 

===client management===
'''rejectreason''' = et_ClientConnect( '''clientNum''', '''firstTime''', '''isBot''' )
:Called when a client attempts to connect to the server. '''clientNum''' is the client slot id, '''firstTime''' indicates if this is a new connection (1) or a reconnection (0). '''isBot''' indicates if the client is a bot (1) or not (0). If the mod accepts the connection, it should return nil. Otherwise, the mod should return a string describing the reason the client connection was rejected.
et_ClientDisconnect( '''clientNum''' )
:Called when a client disconnects. '''clientNum''' is the client slot id.
et_ClientBegin( '''clientNum''' )
:Called when a client begins (becomes active, and enters the gameworld). '''clientNum''' is the client slot id.
et_ClientUserinfoChanged( '''clientNum''' )
:Called when a client's Userinfo string has changed. '''clientNum''' is the client slot id.
et_ClientSpawn( '''clientNum''', '''revived''' )
:Called when a client is spawned. '''clientNum''' is the client slot id. '''revived''' is 1 if the client was spawned by beeying revived.
 

===commands===
'''intercepted''' = et_ClientCommand( '''clientNum''', '''command''' )
:Called when a command is received from a client. '''clientNum''' is the client slot id. '''command''' is the command. The mod should return 1 if the command was intercepted by the mod, and 0 if the command was ignored by the mod and should be passed through to the server (and other mods in the chain).
:The actual command can be accessed through the [[#argument_handling|argument handling]] functions, as seen in the [[ETPro:Lua Sample Code]].
'''intercepted''' = et_ConsoleCommand()
:Called when a command is entered on the server console. The mod should return 1 if the command was intercepted by the mod, and 0 if the command was ignored by the mod and should be passed through to the server (and other mods in the chain).
:The actual command can be accessed through the [[#argument_handling|argument handling]] functions, as seen in the [[ETPro:Lua Sample Code]].
 

===miscellaneous===
et_IPCReceive( '''vmnumber''', '''message''' )
:Called when another mod sends an et.IPCSend() message to this mod. '''vmnumber''' is the VM slot number of the sender, and '''message''' is the message.
et_Print( '''text''' )
:Called whenever the server or qagame prints a string to the console.
et_Obituary( '''victim''', '''killer''', '''meansOfDeath''' )
:Called whenever a player is killed.
 

==predefined constants==
et.EXEC_NOW 
et.EXEC_INSERT 
et.EXEC_APPEND 
et.FS_READ 
et.FS_WRITE 
et.FS_APPEND 
et.FS_APPEND_SYNC 
et.SAY_ALL 
et.SAY_TEAM 
et.SAY_BUDDY 
et.SAY_TEAMNL 
 
et.HOSTARCH
:set to WIN32 or UNIX depending on the host architecture qagame is running on.
LUA_PATH
:set to fs_homepath/fs_game/?.lua in order to ease use of the [http://www.lua.org/pil/8.1.html require] function.
 

==configs==
If a config is loaded, all modules are shutdown and reloaded. If a ''certified'' config is loaded, all modules are shutdown and reloaded, and additionally the following functions are disabled: '''require()''', '''loadfile()''', '''loadlib()''', '''loadstring()''', '''dofile()''' 
 

==caveats==
Like qagame, lua modules are unloaded and reloaded on map_restart and map changes. This means that all global variables and other information is lost. Mods may choose to store persistent data in cvars or external files. 
 

==FAQ==

Q: OMG I hate the libary prefix et.* on everything!!11!1oneone 
A: table.foreach(et, function (func, value) _G[func] = value; end)

Q: How do a re-load my lua file without restarting the whole server ? 
A: change maps or map_restart

Q: Can I see some sample code? 
A: [[ETPro:Lua Sample Code]]

Q: Is there a list of [[ETPro]] mods? 
A: Yes, [[:Category:ETPro:Mods|here]].

Q: OMG my mod doesn't work! 
A: Make sure you added your mod's filename to the lua_modules cvar (e.g. set lua_modules mymod.lua).

Q: OMG why has et_ClientSay been removed? 
A: Thats a secret but, to keep the function as it was, just add the following code to your et_ClientCommand() function 
<pre> -- et_ClientSay had to be removed in order to intercept all commands
-- so here's a wrapper for that
arg0 = et.trap_Argv(0) -- get the main command

if arg0 == "say" then
return et_ClientSay( clientNum, et.SAY_ALL, et.ConcatArgs(1))
elseif arg0 == "say_team" then
return et_ClientSay( clientNum, et.SAY_TEAM, et.ConcatArgs(1))
elseif arg0 == "say_buddy" then
return et_ClientSay( clientNum, et.SAY_BUDDY, et.ConcatArgs(1))
elseif arg0 == "say_teamnl" then
return et_ClientSay( clientNum, et.SAY_TEAMNL, et.ConcatArgs(1))
end
-- et_ClientSay wrapper end
</pre>

[[Category:ETPro]]
[[Category:ETPro:Mods]]

Lua Mod API

2006-03-07T09:13:11Z

=FF=im2good4u: fixors

__NOEDITSECTION__
ETPro now supports serverside mods via the [http://www.lua.org/ lua] scripting language. For more information about lua, visit the [http://www.lua.org/manual/5.0/ Reference manual], the online edition of the book [http://www.lua.org/pil/ Programming in Lua] or the [http://lua-users.org/wiki/ lua-users wiki].

ETPro has an embedded lua 5.0.2 interpreter, and if present will load user-defined scripts from the etpro directory. ETPro also provides an "et" library of function calls for lua to access the server engine, and provides callbacks so a serverside mod may trigger on specific server events.

The following standard lua libraries are initialized by default and available to ETPro lua scripts:
[http://www.lua.org/manual/5.0/manual.html#5.1 basic], [http://www.lua.org/manual/5.0/manual.html#5.4 table], [http://www.lua.org/manual/5.0/manual.html#5.6 i/o], [http://www.lua.org/manual/5.0/manual.html#5.3 string], [http://www.lua.org/manual/5.0/manual.html#5.5 math].

A list of [[ETPro]] mods can be found [[:Category:ETPro:Mods|here]].

API Requests can be discussed [http://wolfwiki.anime.net/index.php/Talk:ETPro:Lua_Mod_API here].

==client commands==
===lua_status===
:lists all currently loaded lua modules.
:''lua mods cannot override this client command.''

==server commands==
===lua_status===
:lists all currently loaded lua modules.

==cvars==
===lua_modules===
:(default "", disabled)
:space separated list of lua modules for ETPro to load. modules will be run in the order listed.

===lua_allowedmodules===
:(default "", disabled)
:if set, only lua modules with the matching sha1 signatures listed in this cvar will be allowed to load.
 
:changing either cvar will cause all currently loaded modules to :quit and be unloaded until the next map_restart. 
 

==et library calls==

===modules===
et.RegisterModname( '''modname''' )
:Registers a descriptive string '''modname''' for this mod.
'''vmnumber''' = et.FindSelf()
:Returns a number indicating the VM slot the current mod is loaded into.
'''modname''', '''signature''' = et.FindMod( '''vmnumber''' )
:Returns the '''modname''' and sha1 '''signature''' for the mod loaded in the VM slot '''vmnumber'''. Returns nil, nil if the VM slot is invalid.
'''success''' = et.IPCSend( '''vmnumber''', '''message''' )
:Sends the string '''message''' to the mod in the VM slot indicated by '''vmnumber'''. The mod receiving '''message''' must have an ''et_IPCReceive()'' callback. If the message is successfully sent, '''success''' will be 1. On failure it will be 0.
 

===printing===
et.G_Print( '''text''' )
:Prints the string '''text''' to the server console.
et.G_LogPrint( '''text''' )
:Prints the string '''text''' to the server console and writes it to the server log.
 

===argument handling===
These functions are to be used within the [[#commands|command callback functions]]. 
'''args''' = et.ConcatArgs( '''index''' )
:Returns all arguments beginning from '''index''' concatenated into a single string '''args'''
'''argcount''' = et.trap_Argc()
:Returns a number indicating the number of command line arguments in the command buffer.
'''arg''' = et.trap_Argv( '''argnum''' )
:Returns the contents of the command line argument '''argnum'''.
 

===cvars===
'''cvarvalue''' = et.trap_Cvar_Get( '''cvarname''' )
:Returns the value of the cvar '''cvarname''' as a string. If there is no cvar named '''cvarname''', returns a zero length string.
et.trap_Cvar_Set( '''cvarname''', '''cvarvalue''' )
:Sets the cvar '''cvarname''' to '''cvarvalue'''
 

===configstrings===
'''configstringvalue''' = et.trap_GetConfigstring( '''index''' )
:Returns the string '''configstringvalue''' containing the contents of the configstring '''index'''
et.trap_SetConfigstring( '''index''', '''configstringvalue''' )
:Sets the configstring '''index''' to the string '''configstringvalue'''
 

===server===
et.trap_SendConsoleCommand( '''when''', '''command''' )
:Sends the command '''command''' to the server console, to be executed '''when''' (see et.EXEC_* constants)
 

===clients===
et.trap_DropClient( '''clientnum''', '''reason''', '''ban_time''' )
:Disconnects '''clientnum''' from the server, with descriptive string '''reason''' reported to clients. '''ban_time''' is the time in seconds to ban the client from the server. '''ban_time''' is optional and may be entirely omitted, in which case the ban time defaults to the cvar ''b_defaultbantime''
et.trap_SendServerCommand( '''clientnum''', '''[[SendServerCommand|command]]''' )
:Sends the command '''[[SendServerCommand|command]]''' to the client '''clientnum'''. If '''clientnum''' is -1, the '''[[SendServerCommand|command]]''' is broadcast to all connected clients.
et.G_Say( '''clientNum''', '''mode''', '''text''' )
:Sends a chat command on behalf of client '''clientNum''' with the mode '''mode''' (see et.SAY_* constants) and chat text '''text'''.
et.ClientUserinfoChanged( '''clientNum''' )
:Loads the new Userinfo of '''clientNum''' and stores it in the configstring and client variables
 

===userinfo===
'''userinfo''' = et.trap_GetUserinfo( '''clientnum''' )
:Returns the contents of the userinfo string for the client '''clientnum'''
et.trap_SetUserinfo( '''clientnum''', '''userinfo''' )
:Sets the userinfo string for the client '''clientnum''' to '''userinfo'''
 

===string utility functions===
'''infostring''' = et.Info_RemoveKey( '''infostring''', '''key''' )
:Removes key '''key''' from infostring '''infostring''' and returns the modified infostring.
'''infostring''' = et.Info_SetValueForKey( '''infostring''', '''key''', '''value''' )
:Sets the key '''key''' in the infostring '''infostring''' to '''value''' and returns the modified infostring. If '''value''' is an empty string, '''key''' is removed from the string.
'''keyvalue''' = et.Info_ValueForKey( '''infostring''', '''key''' )
:Returns the value of the key '''key''' in the infostring '''infostring'''. If '''key''' is not present in the string, an empty string is returned.
'''cleanstring''' = et.Q_CleanStr( '''string''' )
:Returns '''string''' stripped of all color codes
 

===ET filesystem===
'''fd''', '''len''' = et.trap_FS_FOpenFile( '''filename''', '''mode''' )
:Attempts to open the file '''filename''' with the access mode '''mode''' (see et.FS_ constants). Returns the filedescriptor '''fd''' and file length '''len'''. On error, '''len''' returns -1.
'''filedata''' = et.trap_FS_Read( fd, count )
:Reads '''count''' bytes from filedescriptor '''fd'''.
'''count''' = et.trap_FS_Write( '''filedata''', '''count''', '''fd''' )
:Attempts to write '''count''' bytes of '''filedata''' to filedescriptor '''fd'''. Returns number of bytes successfully written.
et.trap_FS_Rename( '''oldname''', '''newname''' )
:Renames file '''oldname''' to '''newname'''.
et.trap_FS_FCloseFile( '''fd''' )
:Closes filedescriptor '''fd'''
 

===indexes===
'''soundindex''' = et.G_SoundIndex( '''filename''' )
:Returns an index to the soundfile indicated by '''filename'''
'''modelindex''' = et.G_ModelIndex( '''filename''' )
:Returns an index to the model indicated by '''filename'''
 

===sound===
et.G_globalSound( '''sound''' )
:Plays the global sound indicated by the filename '''sound'''.
et.G_Sound( '''entnum''', '''soundindex''' )
:Plays the sound '''soundindex''' at the location of entity '''entnum'''
 

===miscellaneous===
'''milliseconds''' = et.trap_Milliseconds()
:Returns a number indicating the current server time in milliseconds.
et.G_Damage( '''target''', '''inflictor''', '''attacker''', '''damage''', '''[[etdamage|dflags]]''', '''[[etdamage|mod]]''' )
:Does '''damage''' amount of damage on '''target''' inflicted by '''inflictor''' and cased by '''attacker'''
:'''target''', '''inflictor''', '''attacker''' are entity numbers
:'''[[etdamage|dflags]]''' is a [[Bitmask-cvar|bitflag]] number to decide how the damage is inflickted, see '''[[etdamage|dflags]]''' [[etdamage|flaglist]]
:'''[[etdamage|mod]]''' is a number from 0 up to 64 o set the type of damage, see '''[[etdamage|mod]]''' [[etdamage|list]]
 

===entities===
'''entnum''' = et.G_Spawn()
:Spawns a new entity and returns the new entity number.
'''entnum''' = et.G_TempEntity( '''origin''', '''event''' )
:Spawns a new TempEntity of event type '''event''' and places it at '''origin''' in the world.
:'''Warning:''' up to and including ETPro 3.2.4 the signature of the method is broken and expects four instead of two parameters. To successfully call it, you need to prepend the parameter list with two dummy parameters like et.G_TempEntity( 0, 0, origin, event ). Use this method with care, because in future ETPro versions it will probably be corrected to the one stated above and might break your script.
et.G_FreeEntity( '''entnum''' )
:Frees the entity '''entnum'''
'''spawnval''' = et.G_GetSpawnVar( '''entnum''', '''key''' )
:Returns the value of spawnvar '''key''' for entity '''entnum'''
et.G_SetSpawnVar( '''entnum''', '''key''', '''value''' )
:Sets the spawnvar '''key''' to '''value''' for entity '''entnum'''
'''integer entnum''' = et.G_SpawnGEntityFromSpawnVars( string spawnvar, string spawnvalue, ... )
:This function can only be called inside the '''et_InitGame''' callback
et.trap_LinkEntity( '''entnum''' )
:Links the entity '''entnum'''
et.trap_UnlinkEntity( '''entnum''' )
:Unlinks the entity '''entnum'''
'''(variable)''' = et.gentity_get ( '''entnum''', '''[[Fieldname]]''' '',arraynumber'')
:Gets the value of '''[[Fieldname]]''' from entity '''entnum''' out of the g_entity struct. For NULL entities or clients, ''nil'' is returned. 
:''arraynumber'' is an optional parameter to use when working whit array fields. In that case it represents the position in the array
et.gentity_set( '''entnum''', '''[[Fieldname]]''', ''arraynumber,'' '''(variable)''' )
:Sets the value of '''[[Fieldname]]''' from entity '''entnum''' in the g_entity struct to '''(variable)'''
:''arraynumber'' is an optional parameter to use when working whit array fields. In that case it represents the position in the array 
et.G_AddEvent( '''ent''', '''event''', '''eventparm'''' )
:Adds event '''event''' whit eventparameter '''eventparm'''' to entity '''ent'''
 

==callbacks==

===qagame execution===
et_InitGame( '''levelTime''', '''randomSeed''', '''restart''' )
:Called when qagame initializes. '''levelTime''' is the current level time in milliseconds. '''randomSeed''' is a number that can be used to seed random number generators. '''restart''' indicates if et_InitGame() is being called due to a map restart (1) or not (0).
et_ShutdownGame( '''restart''' )
:Called when qagame shuts down. '''restart''' indicates if the shutdown is being called due to a map_restart (1) or not (0).
et_RunFrame( '''levelTime''' )
:Called when qagame runs a server frame. '''levelTime''' is the current level time in milliseconds.
et_Quit()
:Called when ETPro unloads the mod. The mod should close all open filedescriptors and perform all cleanup.
 

===client management===
'''rejectreason''' = et_ClientConnect( '''clientNum''', '''firstTime''', '''isBot''' )
:Called when a client attempts to connect to the server. '''clientNum''' is the client slot id, '''firstTime''' indicates if this is a new connection (1) or a reconnection (0). '''isBot''' indicates if the client is a bot (1) or not (0). If the mod accepts the connection, it should return nil. Otherwise, the mod should return a string describing the reason the client connection was rejected.
et_ClientDisconnect( '''clientNum''' )
:Called when a client disconnects. '''clientNum''' is the client slot id.
et_ClientBegin( '''clientNum''' )
:Called when a client begins (becomes active, and enters the gameworld). '''clientNum''' is the client slot id.
et_ClientUserinfoChanged( '''clientNum''' )
:Called when a client's Userinfo string has changed. '''clientNum''' is the client slot id.
et_ClientSpawn( '''clientNum''', '''revived''' )
:Called when a client is spawned. '''clientNum''' is the client slot id. '''revived''' is 1 if the client was spawned by beeying revived.
 

===commands===
'''intercepted''' = et_ClientCommand( '''clientNum''', '''command''' )
:Called when a command is received from a client. '''clientNum''' is the client slot id. '''command''' is the command. The mod should return 1 if the command was intercepted by the mod, and 0 if the command was ignored by the mod and should be passed through to the server (and other mods in the chain).
:The actual command can be accessed through the [[#argument_handling|argument handling]] functions, as seen in the [[ETPro:Lua Sample Code]].
'''intercepted''' = et_ConsoleCommand()
:Called when a command is entered on the server console. The mod should return 1 if the command was intercepted by the mod, and 0 if the command was ignored by the mod and should be passed through to the server (and other mods in the chain).
:The actual command can be accessed through the [[#argument_handling|argument handling]] functions, as seen in the [[ETPro:Lua Sample Code]].
 

===miscellaneous===
et_IPCReceive( '''vmnumber''', '''message''' )
:Called when another mod sends an et.IPCSend() message to this mod. '''vmnumber''' is the VM slot number of the sender, and '''message''' is the message.
et_Print( '''text''' )
:Called whenever the server or qagame prints a string to the console.
et_Obituary( '''victim''', '''killer''', '''meansOfDeath''' )
:Called whenever a player is killed.
 

==predefined constants==
et.EXEC_NOW 
et.EXEC_INSERT 
et.EXEC_APPEND 
et.FS_READ 
et.FS_WRITE 
et.FS_APPEND 
et.FS_APPEND_SYNC 
et.SAY_ALL 
et.SAY_TEAM 
et.SAY_BUDDY 
et.SAY_TEAMNL 
 
et.HOSTARCH
:set to WIN32 or UNIX depending on the host architecture qagame is running on.
LUA_PATH
:set to fs_homepath/fs_game/?.lua in order to ease use of the [http://www.lua.org/pil/8.1.html require] function.
 

==configs==
If a config is loaded, all modules are shutdown and reloaded. If a ''certified'' config is loaded, all modules are shutdown and reloaded, and additionally the following functions are disabled: '''require()''', '''loadfile()''', '''loadlib()''', '''loadstring()''', '''dofile()''' 
 

==caveats==
Like qagame, lua modules are unloaded and reloaded on map_restart and map changes. This means that all global variables and other information is lost. Mods may choose to store persistent data in cvars or external files. 
 

==FAQ==

Q: OMG I hate the libary prefix et.* on everything!!11!1oneone 
A: table.foreach(et, function (func, value) _G[func] = value; end)

Q: How do a re-load my lua file without restarting the whole server ? 
A: change maps or map_restart

Q: Can I see some sample code? 
A: [[ETPro:Lua Sample Code]]

Q: Is there a list of [[ETPro]] mods? 
A: Yes, [[:Category:ETPro:Mods|here]].

Q: OMG my mod doesn't work! 
A: Make sure you added your mod's filename to the lua_modules cvar (e.g. set lua_modules mymod.lua).

Q: OMG why has et_ClientSay been removed? 
A: Thats a secret but, to keep the function as it was, just add the following code to your et_ClientCommand() function 
<pre> -- et_ClientSay had to be removed in order to intercept all commands
-- so here's a wrapper for that
arg0 = et.trap_Argv(0) -- get the main command

if arg0 == "say" then
return et_ClientSay( clientNum, et.SAY_ALL, et.ConcatArgs(1))
elseif arg0 == "say_team" then
return et_ClientSay( clientNum, et.SAY_TEAM, et.ConcatArgs(1))
elseif arg0 == "say_buddy" then
return et_ClientSay( clientNum, et.SAY_BUDDY, et.ConcatArgs(1))
elseif arg0 == "say_teamnl" then
return et_ClientSay( clientNum, et.SAY_TEAMNL, et.ConcatArgs(1))
end
-- et_ClientSay wrapper end
</pre>

[[Category:ETPro]]
[[Category:ETPro:Mods]]

Lua Mod API

2006-03-07T09:11:56Z

=FF=im2good4u: added et.gentity_get and et.gentity_set arrays

__NOEDITSECTION__
ETPro now supports serverside mods via the [http://www.lua.org/ lua] scripting language. For more information about lua, visit the [http://www.lua.org/manual/5.0/ Reference manual], the online edition of the book [http://www.lua.org/pil/ Programming in Lua] or the [http://lua-users.org/wiki/ lua-users wiki].

ETPro has an embedded lua 5.0.2 interpreter, and if present will load user-defined scripts from the etpro directory. ETPro also provides an "et" library of function calls for lua to access the server engine, and provides callbacks so a serverside mod may trigger on specific server events.

The following standard lua libraries are initialized by default and available to ETPro lua scripts:
[http://www.lua.org/manual/5.0/manual.html#5.1 basic], [http://www.lua.org/manual/5.0/manual.html#5.4 table], [http://www.lua.org/manual/5.0/manual.html#5.6 i/o], [http://www.lua.org/manual/5.0/manual.html#5.3 string], [http://www.lua.org/manual/5.0/manual.html#5.5 math].

A list of [[ETPro]] mods can be found [[:Category:ETPro:Mods|here]].

API Requests can be discussed [http://wolfwiki.anime.net/index.php/Talk:ETPro:Lua_Mod_API here].

==client commands==
===lua_status===
:lists all currently loaded lua modules.
:''lua mods cannot override this client command.''

==server commands==
===lua_status===
:lists all currently loaded lua modules.

==cvars==
===lua_modules===
:(default "", disabled)
:space separated list of lua modules for ETPro to load. modules will be run in the order listed.

===lua_allowedmodules===
:(default "", disabled)
:if set, only lua modules with the matching sha1 signatures listed in this cvar will be allowed to load.
 
:changing either cvar will cause all currently loaded modules to :quit and be unloaded until the next map_restart. 
 

==et library calls==

===modules===
et.RegisterModname( '''modname''' )
:Registers a descriptive string '''modname''' for this mod.
'''vmnumber''' = et.FindSelf()
:Returns a number indicating the VM slot the current mod is loaded into.
'''modname''', '''signature''' = et.FindMod( '''vmnumber''' )
:Returns the '''modname''' and sha1 '''signature''' for the mod loaded in the VM slot '''vmnumber'''. Returns nil, nil if the VM slot is invalid.
'''success''' = et.IPCSend( '''vmnumber''', '''message''' )
:Sends the string '''message''' to the mod in the VM slot indicated by '''vmnumber'''. The mod receiving '''message''' must have an ''et_IPCReceive()'' callback. If the message is successfully sent, '''success''' will be 1. On failure it will be 0.
 

===printing===
et.G_Print( '''text''' )
:Prints the string '''text''' to the server console.
et.G_LogPrint( '''text''' )
:Prints the string '''text''' to the server console and writes it to the server log.
 

===argument handling===
These functions are to be used within the [[#commands|command callback functions]]. 
'''args''' = et.ConcatArgs( '''index''' )
:Returns all arguments beginning from '''index''' concatenated into a single string '''args'''
'''argcount''' = et.trap_Argc()
:Returns a number indicating the number of command line arguments in the command buffer.
'''arg''' = et.trap_Argv( '''argnum''' )
:Returns the contents of the command line argument '''argnum'''.
 

===cvars===
'''cvarvalue''' = et.trap_Cvar_Get( '''cvarname''' )
:Returns the value of the cvar '''cvarname''' as a string. If there is no cvar named '''cvarname''', returns a zero length string.
et.trap_Cvar_Set( '''cvarname''', '''cvarvalue''' )
:Sets the cvar '''cvarname''' to '''cvarvalue'''
 

===configstrings===
'''configstringvalue''' = et.trap_GetConfigstring( '''index''' )
:Returns the string '''configstringvalue''' containing the contents of the configstring '''index'''
et.trap_SetConfigstring( '''index''', '''configstringvalue''' )
:Sets the configstring '''index''' to the string '''configstringvalue'''
 

===server===
et.trap_SendConsoleCommand( '''when''', '''command''' )
:Sends the command '''command''' to the server console, to be executed '''when''' (see et.EXEC_* constants)
 

===clients===
et.trap_DropClient( '''clientnum''', '''reason''', '''ban_time''' )
:Disconnects '''clientnum''' from the server, with descriptive string '''reason''' reported to clients. '''ban_time''' is the time in seconds to ban the client from the server. '''ban_time''' is optional and may be entirely omitted, in which case the ban time defaults to the cvar ''b_defaultbantime''
et.trap_SendServerCommand( '''clientnum''', '''[[SendServerCommand|command]]''' )
:Sends the command '''[[SendServerCommand|command]]''' to the client '''clientnum'''. If '''clientnum''' is -1, the '''[[SendServerCommand|command]]''' is broadcast to all connected clients.
et.G_Say( '''clientNum''', '''mode''', '''text''' )
:Sends a chat command on behalf of client '''clientNum''' with the mode '''mode''' (see et.SAY_* constants) and chat text '''text'''.
et.ClientUserinfoChanged( '''clientNum''' )
:Loads the new Userinfo of '''clientNum''' and stores it in the configstring and client variables
 

===userinfo===
'''userinfo''' = et.trap_GetUserinfo( '''clientnum''' )
:Returns the contents of the userinfo string for the client '''clientnum'''
et.trap_SetUserinfo( '''clientnum''', '''userinfo''' )
:Sets the userinfo string for the client '''clientnum''' to '''userinfo'''
 

===string utility functions===
'''infostring''' = et.Info_RemoveKey( '''infostring''', '''key''' )
:Removes key '''key''' from infostring '''infostring''' and returns the modified infostring.
'''infostring''' = et.Info_SetValueForKey( '''infostring''', '''key''', '''value''' )
:Sets the key '''key''' in the infostring '''infostring''' to '''value''' and returns the modified infostring. If '''value''' is an empty string, '''key''' is removed from the string.
'''keyvalue''' = et.Info_ValueForKey( '''infostring''', '''key''' )
:Returns the value of the key '''key''' in the infostring '''infostring'''. If '''key''' is not present in the string, an empty string is returned.
'''cleanstring''' = et.Q_CleanStr( '''string''' )
:Returns '''string''' stripped of all color codes
 

===ET filesystem===
'''fd''', '''len''' = et.trap_FS_FOpenFile( '''filename''', '''mode''' )
:Attempts to open the file '''filename''' with the access mode '''mode''' (see et.FS_ constants). Returns the filedescriptor '''fd''' and file length '''len'''. On error, '''len''' returns -1.
'''filedata''' = et.trap_FS_Read( fd, count )
:Reads '''count''' bytes from filedescriptor '''fd'''.
'''count''' = et.trap_FS_Write( '''filedata''', '''count''', '''fd''' )
:Attempts to write '''count''' bytes of '''filedata''' to filedescriptor '''fd'''. Returns number of bytes successfully written.
et.trap_FS_Rename( '''oldname''', '''newname''' )
:Renames file '''oldname''' to '''newname'''.
et.trap_FS_FCloseFile( '''fd''' )
:Closes filedescriptor '''fd'''
 

===indexes===
'''soundindex''' = et.G_SoundIndex( '''filename''' )
:Returns an index to the soundfile indicated by '''filename'''
'''modelindex''' = et.G_ModelIndex( '''filename''' )
:Returns an index to the model indicated by '''filename'''
 

===sound===
et.G_globalSound( '''sound''' )
:Plays the global sound indicated by the filename '''sound'''.
et.G_Sound( '''entnum''', '''soundindex''' )
:Plays the sound '''soundindex''' at the location of entity '''entnum'''
 

===miscellaneous===
'''milliseconds''' = et.trap_Milliseconds()
:Returns a number indicating the current server time in milliseconds.
et.G_Damage( '''target''', '''inflictor''', '''attacker''', '''damage''', '''[[etdamage|dflags]]''', '''[[etdamage|mod]]''' )
:Does '''damage''' amount of damage on '''target''' inflicted by '''inflictor''' and cased by '''attacker'''
:'''target''', '''inflictor''', '''attacker''' are entity numbers
:'''[[etdamage|dflags]]''' is a [[Bitmask-cvar|bitflag]] number to decide how the damage is inflickted, see '''[[etdamage|dflags]]''' [[etdamage|flaglist]]
:'''[[etdamage|mod]]''' is a number from 0 up to 64 o set the type of damage, see '''[[etdamage|mod]]''' [[etdamage|list]]
 

===entities===
'''entnum''' = et.G_Spawn()
:Spawns a new entity and returns the new entity number.
'''entnum''' = et.G_TempEntity( '''origin''', '''event''' )
:Spawns a new TempEntity of event type '''event''' and places it at '''origin''' in the world.
:'''Warning:''' up to and including ETPro 3.2.4 the signature of the method is broken and expects four instead of two parameters. To successfully call it, you need to prepend the parameter list with two dummy parameters like et.G_TempEntity( 0, 0, origin, event ). Use this method with care, because in future ETPro versions it will probably be corrected to the one stated above and might break your script.
et.G_FreeEntity( '''entnum''' )
:Frees the entity '''entnum'''
'''spawnval''' = et.G_GetSpawnVar( '''entnum''', '''key''' )
:Returns the value of spawnvar '''key''' for entity '''entnum'''
et.G_SetSpawnVar( '''entnum''', '''key''', '''value''' )
:Sets the spawnvar '''key''' to '''value''' for entity '''entnum'''
'''integer entnum''' = et.G_SpawnGEntityFromSpawnVars( string spawnvar, string spawnvalue, ... )
:This function can only be called inside the '''et_InitGame''' callback
et.trap_LinkEntity( '''entnum''' )
:Links the entity '''entnum'''
et.trap_UnlinkEntity( '''entnum''' )
:Unlinks the entity '''entnum'''
'''(variable)''' = et.gentity_get ( '''entnum''', '''[[Fieldname]]''' '',arraynumber'')
:Gets the value of '''[[Fieldname]]''' from entity '''entnum''' out of the g_entity struct. For NULL entities or clients, ''nil'' is returned. 
:''arraynumber'' is an optional parameter to use when working whit array fields. In that case ''arraynumber'' is position in the array
et.gentity_set( '''entnum''', '''[[Fieldname]]''', ''arraynumber,'' '''(variable)''' )
:Sets the value of '''[[Fieldname]]''' from entity '''entnum''' in the g_entity struct to '''(variable)'''
:''arraynumber'' is an optional parameter to use when working whit array fields. In that case ''arraynumber'' is position in the array 
et.G_AddEvent( '''ent''', '''event''', '''eventparm'''' )
:Adds event '''event''' whit eventparameter '''eventparm'''' to entity '''ent'''
 

==callbacks==

===qagame execution===
et_InitGame( '''levelTime''', '''randomSeed''', '''restart''' )
:Called when qagame initializes. '''levelTime''' is the current level time in milliseconds. '''randomSeed''' is a number that can be used to seed random number generators. '''restart''' indicates if et_InitGame() is being called due to a map restart (1) or not (0).
et_ShutdownGame( '''restart''' )
:Called when qagame shuts down. '''restart''' indicates if the shutdown is being called due to a map_restart (1) or not (0).
et_RunFrame( '''levelTime''' )
:Called when qagame runs a server frame. '''levelTime''' is the current level time in milliseconds.
et_Quit()
:Called when ETPro unloads the mod. The mod should close all open filedescriptors and perform all cleanup.
 

===client management===
'''rejectreason''' = et_ClientConnect( '''clientNum''', '''firstTime''', '''isBot''' )
:Called when a client attempts to connect to the server. '''clientNum''' is the client slot id, '''firstTime''' indicates if this is a new connection (1) or a reconnection (0). '''isBot''' indicates if the client is a bot (1) or not (0). If the mod accepts the connection, it should return nil. Otherwise, the mod should return a string describing the reason the client connection was rejected.
et_ClientDisconnect( '''clientNum''' )
:Called when a client disconnects. '''clientNum''' is the client slot id.
et_ClientBegin( '''clientNum''' )
:Called when a client begins (becomes active, and enters the gameworld). '''clientNum''' is the client slot id.
et_ClientUserinfoChanged( '''clientNum''' )
:Called when a client's Userinfo string has changed. '''clientNum''' is the client slot id.
et_ClientSpawn( '''clientNum''', '''revived''' )
:Called when a client is spawned. '''clientNum''' is the client slot id. '''revived''' is 1 if the client was spawned by beeying revived.
 

===commands===
'''intercepted''' = et_ClientCommand( '''clientNum''', '''command''' )
:Called when a command is received from a client. '''clientNum''' is the client slot id. '''command''' is the command. The mod should return 1 if the command was intercepted by the mod, and 0 if the command was ignored by the mod and should be passed through to the server (and other mods in the chain).
:The actual command can be accessed through the [[#argument_handling|argument handling]] functions, as seen in the [[ETPro:Lua Sample Code]].
'''intercepted''' = et_ConsoleCommand()
:Called when a command is entered on the server console. The mod should return 1 if the command was intercepted by the mod, and 0 if the command was ignored by the mod and should be passed through to the server (and other mods in the chain).
:The actual command can be accessed through the [[#argument_handling|argument handling]] functions, as seen in the [[ETPro:Lua Sample Code]].
 

===miscellaneous===
et_IPCReceive( '''vmnumber''', '''message''' )
:Called when another mod sends an et.IPCSend() message to this mod. '''vmnumber''' is the VM slot number of the sender, and '''message''' is the message.
et_Print( '''text''' )
:Called whenever the server or qagame prints a string to the console.
et_Obituary( '''victim''', '''killer''', '''meansOfDeath''' )
:Called whenever a player is killed.
 

==predefined constants==
et.EXEC_NOW 
et.EXEC_INSERT 
et.EXEC_APPEND 
et.FS_READ 
et.FS_WRITE 
et.FS_APPEND 
et.FS_APPEND_SYNC 
et.SAY_ALL 
et.SAY_TEAM 
et.SAY_BUDDY 
et.SAY_TEAMNL 
 
et.HOSTARCH
:set to WIN32 or UNIX depending on the host architecture qagame is running on.
LUA_PATH
:set to fs_homepath/fs_game/?.lua in order to ease use of the [http://www.lua.org/pil/8.1.html require] function.
 

==configs==
If a config is loaded, all modules are shutdown and reloaded. If a ''certified'' config is loaded, all modules are shutdown and reloaded, and additionally the following functions are disabled: '''require()''', '''loadfile()''', '''loadlib()''', '''loadstring()''', '''dofile()''' 
 

==caveats==
Like qagame, lua modules are unloaded and reloaded on map_restart and map changes. This means that all global variables and other information is lost. Mods may choose to store persistent data in cvars or external files. 
 

==FAQ==

Q: OMG I hate the libary prefix et.* on everything!!11!1oneone 
A: table.foreach(et, function (func, value) _G[func] = value; end)

Q: How do a re-load my lua file without restarting the whole server ? 
A: change maps or map_restart

Q: Can I see some sample code? 
A: [[ETPro:Lua Sample Code]]

Q: Is there a list of [[ETPro]] mods? 
A: Yes, [[:Category:ETPro:Mods|here]].

Q: OMG my mod doesn't work! 
A: Make sure you added your mod's filename to the lua_modules cvar (e.g. set lua_modules mymod.lua).

Q: OMG why has et_ClientSay been removed? 
A: Thats a secret but, to keep the function as it was, just add the following code to your et_ClientCommand() function 
<pre> -- et_ClientSay had to be removed in order to intercept all commands
-- so here's a wrapper for that
arg0 = et.trap_Argv(0) -- get the main command

if arg0 == "say" then
return et_ClientSay( clientNum, et.SAY_ALL, et.ConcatArgs(1))
elseif arg0 == "say_team" then
return et_ClientSay( clientNum, et.SAY_TEAM, et.ConcatArgs(1))
elseif arg0 == "say_buddy" then
return et_ClientSay( clientNum, et.SAY_BUDDY, et.ConcatArgs(1))
elseif arg0 == "say_teamnl" then
return et_ClientSay( clientNum, et.SAY_TEAMNL, et.ConcatArgs(1))
end
-- et_ClientSay wrapper end
</pre>

[[Category:ETPro]]
[[Category:ETPro:Mods]]

Lua Mod API

2006-03-07T09:07:25Z

=FF=im2good4u: snapshot 2 functions

__NOEDITSECTION__
ETPro now supports serverside mods via the [http://www.lua.org/ lua] scripting language. For more information about lua, visit the [http://www.lua.org/manual/5.0/ Reference manual], the online edition of the book [http://www.lua.org/pil/ Programming in Lua] or the [http://lua-users.org/wiki/ lua-users wiki].

ETPro has an embedded lua 5.0.2 interpreter, and if present will load user-defined scripts from the etpro directory. ETPro also provides an "et" library of function calls for lua to access the server engine, and provides callbacks so a serverside mod may trigger on specific server events.

The following standard lua libraries are initialized by default and available to ETPro lua scripts:
[http://www.lua.org/manual/5.0/manual.html#5.1 basic], [http://www.lua.org/manual/5.0/manual.html#5.4 table], [http://www.lua.org/manual/5.0/manual.html#5.6 i/o], [http://www.lua.org/manual/5.0/manual.html#5.3 string], [http://www.lua.org/manual/5.0/manual.html#5.5 math].

A list of [[ETPro]] mods can be found [[:Category:ETPro:Mods|here]].

API Requests can be discussed [http://wolfwiki.anime.net/index.php/Talk:ETPro:Lua_Mod_API here].

==client commands==
===lua_status===
:lists all currently loaded lua modules.
:''lua mods cannot override this client command.''

==server commands==
===lua_status===
:lists all currently loaded lua modules.

==cvars==
===lua_modules===
:(default "", disabled)
:space separated list of lua modules for ETPro to load. modules will be run in the order listed.

===lua_allowedmodules===
:(default "", disabled)
:if set, only lua modules with the matching sha1 signatures listed in this cvar will be allowed to load.
 
:changing either cvar will cause all currently loaded modules to :quit and be unloaded until the next map_restart. 
 

==et library calls==

===modules===
et.RegisterModname( '''modname''' )
:Registers a descriptive string '''modname''' for this mod.
'''vmnumber''' = et.FindSelf()
:Returns a number indicating the VM slot the current mod is loaded into.
'''modname''', '''signature''' = et.FindMod( '''vmnumber''' )
:Returns the '''modname''' and sha1 '''signature''' for the mod loaded in the VM slot '''vmnumber'''. Returns nil, nil if the VM slot is invalid.
'''success''' = et.IPCSend( '''vmnumber''', '''message''' )
:Sends the string '''message''' to the mod in the VM slot indicated by '''vmnumber'''. The mod receiving '''message''' must have an ''et_IPCReceive()'' callback. If the message is successfully sent, '''success''' will be 1. On failure it will be 0.
 

===printing===
et.G_Print( '''text''' )
:Prints the string '''text''' to the server console.
et.G_LogPrint( '''text''' )
:Prints the string '''text''' to the server console and writes it to the server log.
 

===argument handling===
These functions are to be used within the [[#commands|command callback functions]]. 
'''args''' = et.ConcatArgs( '''index''' )
:Returns all arguments beginning from '''index''' concatenated into a single string '''args'''
'''argcount''' = et.trap_Argc()
:Returns a number indicating the number of command line arguments in the command buffer.
'''arg''' = et.trap_Argv( '''argnum''' )
:Returns the contents of the command line argument '''argnum'''.
 

===cvars===
'''cvarvalue''' = et.trap_Cvar_Get( '''cvarname''' )
:Returns the value of the cvar '''cvarname''' as a string. If there is no cvar named '''cvarname''', returns a zero length string.
et.trap_Cvar_Set( '''cvarname''', '''cvarvalue''' )
:Sets the cvar '''cvarname''' to '''cvarvalue'''
 

===configstrings===
'''configstringvalue''' = et.trap_GetConfigstring( '''index''' )
:Returns the string '''configstringvalue''' containing the contents of the configstring '''index'''
et.trap_SetConfigstring( '''index''', '''configstringvalue''' )
:Sets the configstring '''index''' to the string '''configstringvalue'''
 

===server===
et.trap_SendConsoleCommand( '''when''', '''command''' )
:Sends the command '''command''' to the server console, to be executed '''when''' (see et.EXEC_* constants)
 

===clients===
et.trap_DropClient( '''clientnum''', '''reason''', '''ban_time''' )
:Disconnects '''clientnum''' from the server, with descriptive string '''reason''' reported to clients. '''ban_time''' is the time in seconds to ban the client from the server. '''ban_time''' is optional and may be entirely omitted, in which case the ban time defaults to the cvar ''b_defaultbantime''
et.trap_SendServerCommand( '''clientnum''', '''[[SendServerCommand|command]]''' )
:Sends the command '''[[SendServerCommand|command]]''' to the client '''clientnum'''. If '''clientnum''' is -1, the '''[[SendServerCommand|command]]''' is broadcast to all connected clients.
et.G_Say( '''clientNum''', '''mode''', '''text''' )
:Sends a chat command on behalf of client '''clientNum''' with the mode '''mode''' (see et.SAY_* constants) and chat text '''text'''.
et.ClientUserinfoChanged( '''clientNum''' )
:Loads the new Userinfo of '''clientNum''' and stores it in the configstring and client variables
 

===userinfo===
'''userinfo''' = et.trap_GetUserinfo( '''clientnum''' )
:Returns the contents of the userinfo string for the client '''clientnum'''
et.trap_SetUserinfo( '''clientnum''', '''userinfo''' )
:Sets the userinfo string for the client '''clientnum''' to '''userinfo'''
 

===string utility functions===
'''infostring''' = et.Info_RemoveKey( '''infostring''', '''key''' )
:Removes key '''key''' from infostring '''infostring''' and returns the modified infostring.
'''infostring''' = et.Info_SetValueForKey( '''infostring''', '''key''', '''value''' )
:Sets the key '''key''' in the infostring '''infostring''' to '''value''' and returns the modified infostring. If '''value''' is an empty string, '''key''' is removed from the string.
'''keyvalue''' = et.Info_ValueForKey( '''infostring''', '''key''' )
:Returns the value of the key '''key''' in the infostring '''infostring'''. If '''key''' is not present in the string, an empty string is returned.
'''cleanstring''' = et.Q_CleanStr( '''string''' )
:Returns '''string''' stripped of all color codes
 

===ET filesystem===
'''fd''', '''len''' = et.trap_FS_FOpenFile( '''filename''', '''mode''' )
:Attempts to open the file '''filename''' with the access mode '''mode''' (see et.FS_ constants). Returns the filedescriptor '''fd''' and file length '''len'''. On error, '''len''' returns -1.
'''filedata''' = et.trap_FS_Read( fd, count )
:Reads '''count''' bytes from filedescriptor '''fd'''.
'''count''' = et.trap_FS_Write( '''filedata''', '''count''', '''fd''' )
:Attempts to write '''count''' bytes of '''filedata''' to filedescriptor '''fd'''. Returns number of bytes successfully written.
et.trap_FS_Rename( '''oldname''', '''newname''' )
:Renames file '''oldname''' to '''newname'''.
et.trap_FS_FCloseFile( '''fd''' )
:Closes filedescriptor '''fd'''
 

===indexes===
'''soundindex''' = et.G_SoundIndex( '''filename''' )
:Returns an index to the soundfile indicated by '''filename'''
'''modelindex''' = et.G_ModelIndex( '''filename''' )
:Returns an index to the model indicated by '''filename'''
 

===sound===
et.G_globalSound( '''sound''' )
:Plays the global sound indicated by the filename '''sound'''.
et.G_Sound( '''entnum''', '''soundindex''' )
:Plays the sound '''soundindex''' at the location of entity '''entnum'''
 

===miscellaneous===
'''milliseconds''' = et.trap_Milliseconds()
:Returns a number indicating the current server time in milliseconds.
et.G_Damage( '''target''', '''inflictor''', '''attacker''', '''damage''', '''[[etdamage|dflags]]''', '''[[etdamage|mod]]''' )
:Does '''damage''' amount of damage on '''target''' inflicted by '''inflictor''' and cased by '''attacker'''
:'''target''', '''inflictor''', '''attacker''' are entity numbers
:'''[[etdamage|dflags]]''' is a [[Bitmask-cvar|bitflag]] number to decide how the damage is inflickted, see '''[[etdamage|dflags]]''' [[etdamage|flaglist]]
:'''[[etdamage|mod]]''' is a number from 0 up to 64 o set the type of damage, see '''[[etdamage|mod]]''' [[etdamage|list]]
 

===entities===
'''entnum''' = et.G_Spawn()
:Spawns a new entity and returns the new entity number.
'''entnum''' = et.G_TempEntity( '''origin''', '''event''' )
:Spawns a new TempEntity of event type '''event''' and places it at '''origin''' in the world.
:'''Warning:''' up to and including ETPro 3.2.4 the signature of the method is broken and expects four instead of two parameters. To successfully call it, you need to prepend the parameter list with two dummy parameters like et.G_TempEntity( 0, 0, origin, event ). Use this method with care, because in future ETPro versions it will probably be corrected to the one stated above and might break your script.
et.G_FreeEntity( '''entnum''' )
:Frees the entity '''entnum'''
'''spawnval''' = et.G_GetSpawnVar( '''entnum''', '''key''' )
:Returns the value of spawnvar '''key''' for entity '''entnum'''
et.G_SetSpawnVar( '''entnum''', '''key''', '''value''' )
:Sets the spawnvar '''key''' to '''value''' for entity '''entnum'''
'''integer entnum''' = et.G_SpawnGEntityFromSpawnVars( string spawnvar, string spawnvalue, ... )
:This function can only be called inside the '''et_InitGame''' callback
et.trap_LinkEntity( '''entnum''' )
:Links the entity '''entnum'''
et.trap_UnlinkEntity( '''entnum''' )
:Unlinks the entity '''entnum'''
'''(variable)''' = et.gentity_get ( '''entnum''', '''[[Fieldname]]''' )
:Gets the value of '''[[Fieldname]]''' from entity '''entnum''' out of the g_entity struct. For NULL entities or clients, ''nil'' is returned. 
et.gentity_set( '''entnum''', '''[[Fieldname]]''', '''(variable)''' )
:Sets the value of '''[[Fieldname]]''' from entity '''entnum''' in the g_entity struct to '''(variable)''' 
et.G_AddEvent( '''ent''', '''event''', '''eventparm'''' )
:Adds event '''event''' whit eventparameter '''eventparm'''' to entity '''ent'''
 

==callbacks==

===qagame execution===
et_InitGame( '''levelTime''', '''randomSeed''', '''restart''' )
:Called when qagame initializes. '''levelTime''' is the current level time in milliseconds. '''randomSeed''' is a number that can be used to seed random number generators. '''restart''' indicates if et_InitGame() is being called due to a map restart (1) or not (0).
et_ShutdownGame( '''restart''' )
:Called when qagame shuts down. '''restart''' indicates if the shutdown is being called due to a map_restart (1) or not (0).
et_RunFrame( '''levelTime''' )
:Called when qagame runs a server frame. '''levelTime''' is the current level time in milliseconds.
et_Quit()
:Called when ETPro unloads the mod. The mod should close all open filedescriptors and perform all cleanup.
 

===client management===
'''rejectreason''' = et_ClientConnect( '''clientNum''', '''firstTime''', '''isBot''' )
:Called when a client attempts to connect to the server. '''clientNum''' is the client slot id, '''firstTime''' indicates if this is a new connection (1) or a reconnection (0). '''isBot''' indicates if the client is a bot (1) or not (0). If the mod accepts the connection, it should return nil. Otherwise, the mod should return a string describing the reason the client connection was rejected.
et_ClientDisconnect( '''clientNum''' )
:Called when a client disconnects. '''clientNum''' is the client slot id.
et_ClientBegin( '''clientNum''' )
:Called when a client begins (becomes active, and enters the gameworld). '''clientNum''' is the client slot id.
et_ClientUserinfoChanged( '''clientNum''' )
:Called when a client's Userinfo string has changed. '''clientNum''' is the client slot id.
et_ClientSpawn( '''clientNum''', '''revived''' )
:Called when a client is spawned. '''clientNum''' is the client slot id. '''revived''' is 1 if the client was spawned by beeying revived.
 

===commands===
'''intercepted''' = et_ClientCommand( '''clientNum''', '''command''' )
:Called when a command is received from a client. '''clientNum''' is the client slot id. '''command''' is the command. The mod should return 1 if the command was intercepted by the mod, and 0 if the command was ignored by the mod and should be passed through to the server (and other mods in the chain).
:The actual command can be accessed through the [[#argument_handling|argument handling]] functions, as seen in the [[ETPro:Lua Sample Code]].
'''intercepted''' = et_ConsoleCommand()
:Called when a command is entered on the server console. The mod should return 1 if the command was intercepted by the mod, and 0 if the command was ignored by the mod and should be passed through to the server (and other mods in the chain).
:The actual command can be accessed through the [[#argument_handling|argument handling]] functions, as seen in the [[ETPro:Lua Sample Code]].
 

===miscellaneous===
et_IPCReceive( '''vmnumber''', '''message''' )
:Called when another mod sends an et.IPCSend() message to this mod. '''vmnumber''' is the VM slot number of the sender, and '''message''' is the message.
et_Print( '''text''' )
:Called whenever the server or qagame prints a string to the console.
et_Obituary( '''victim''', '''killer''', '''meansOfDeath''' )
:Called whenever a player is killed.
 

==predefined constants==
et.EXEC_NOW 
et.EXEC_INSERT 
et.EXEC_APPEND 
et.FS_READ 
et.FS_WRITE 
et.FS_APPEND 
et.FS_APPEND_SYNC 
et.SAY_ALL 
et.SAY_TEAM 
et.SAY_BUDDY 
et.SAY_TEAMNL 
 
et.HOSTARCH
:set to WIN32 or UNIX depending on the host architecture qagame is running on.
LUA_PATH
:set to fs_homepath/fs_game/?.lua in order to ease use of the [http://www.lua.org/pil/8.1.html require] function.
 

==configs==
If a config is loaded, all modules are shutdown and reloaded. If a ''certified'' config is loaded, all modules are shutdown and reloaded, and additionally the following functions are disabled: '''require()''', '''loadfile()''', '''loadlib()''', '''loadstring()''', '''dofile()''' 
 

==caveats==
Like qagame, lua modules are unloaded and reloaded on map_restart and map changes. This means that all global variables and other information is lost. Mods may choose to store persistent data in cvars or external files. 
 

==FAQ==

Q: OMG I hate the libary prefix et.* on everything!!11!1oneone 
A: table.foreach(et, function (func, value) _G[func] = value; end)

Q: How do a re-load my lua file without restarting the whole server ? 
A: change maps or map_restart

Q: Can I see some sample code? 
A: [[ETPro:Lua Sample Code]]

Q: Is there a list of [[ETPro]] mods? 
A: Yes, [[:Category:ETPro:Mods|here]].

Q: OMG my mod doesn't work! 
A: Make sure you added your mod's filename to the lua_modules cvar (e.g. set lua_modules mymod.lua).

Q: OMG why has et_ClientSay been removed? 
A: Thats a secret but, to keep the function as it was, just add the following code to your et_ClientCommand() function 
<pre> -- et_ClientSay had to be removed in order to intercept all commands
-- so here's a wrapper for that
arg0 = et.trap_Argv(0) -- get the main command

if arg0 == "say" then
return et_ClientSay( clientNum, et.SAY_ALL, et.ConcatArgs(1))
elseif arg0 == "say_team" then
return et_ClientSay( clientNum, et.SAY_TEAM, et.ConcatArgs(1))
elseif arg0 == "say_buddy" then
return et_ClientSay( clientNum, et.SAY_BUDDY, et.ConcatArgs(1))
elseif arg0 == "say_teamnl" then
return et_ClientSay( clientNum, et.SAY_TEAMNL, et.ConcatArgs(1))
end
-- et_ClientSay wrapper end
</pre>

[[Category:ETPro]]
[[Category:ETPro:Mods]]

Fieldname

2006-03-07T08:23:04Z

=FF=im2good4u: snapshot 1 fields

List of fields supported by [[ETPro:Lua Mod API#entities|et.gentity_get() and et.gentity_set()]] functions 
<pitatable columns=3 headlines="field;type;access" widths="180;120;60" headerfontcolor="#FFFFFF">
activator;entity;RO;
chain;entity;RW;
classname;string;RW;
clipmask;integer;?;
closespeed;float;RW;
count;integer;RW;
count2;integer;RW;
damage;integer;RW;
deathType;meansOfDeath_t;RW;
delay;float;RW;
dl_atten;integer;RW;
dl_color;vec3;RW;
dl_shader;string;RO;
dl_stylestring;string;RO;
duration;float;RW;
end_size;integer;RW;
enemy;entity;RW;
flags;bitflag;RO;
harc;float;RW;
health;integer;RW;
inuse;qboolean;RO;
isProp;qboolean;RO;
item;string;RW;
key;integer;RW;
message;string;RW;
methodOfDeath;integer;RW;
mg42BaseEnt;integer;RW;
missionLevel;integer;RW;
model;string;RO;
model2;string;RO;
nextTrain;entity;RW;
noise_index;integer;RW;
origin;vec3;RW;
pers.connected;connected_t;?;
pers.netname;string;?;
pers.localClient;qboolean;?;
pers.initialSpawn;qboolean;?;
pers.enterTime;integer;?;
pers.connectTime;integer;?;
pers.teamState;teamState_t;?;
pers.voteCount;integer;?;
pers.teamVoteCount;integer;?;
pers.complaints;integer;?;
pers.complaintClient;integer;?;
pers.complaintEndTime;integer;?;
pers.lastReinforceTime;integer;?;
pers.applicationClient;integer;?;
pers.applicationEndTime;integer;?;
pers.invitationClient;integer;?;
pers.invitationEndTime;integer;?;
pers.propositionClient;integer;?;
pers.propositionClient2;integer;?;
pers.propositionEndTime;integer;?;
pers.autofireteamEndTime;integer;?;
pers.autofireteamCreateEndTime;integer;?;
pers.autofireteamJoinEndTime;integer;?;
pers.lastSpawnTime;integer;?;
pers.ready;qboolean;?;
prevTrain;entity;RW;
props_frame_state;integer;RO;
ps.stats;integer array;RW;
ps.persistant;integer array;RW;
ps.powerups;integer array;RW;
ps.ammo;integer array;RW;
ps.ammoclip;integer array;RW;
r.absmax;vec3;RO;
r.absmin;vec3;RO;
r.bmodel;qboolean;RO;
r.contents;integer;RW;
r.currentAngles;vec3;RW;
r.currentOrigin;vec3;RW;
r.eventTime;integer;RW;
r.linkcount;integer;RO;
r.linked;qboolean;RO;
r.maxs;vec3;RW;
r.mins;vec3;RW;
r.ownerNum;integer;RW;
r.singleClient;integer;RW;
r.svFlags;integer;RW;
r.worldflags;integer;RO;
radius;integer;RW;
random;float;RW;
rotate;vec3;RW;
s.angles;vec3;RW;
s.angles2;vec3;RW;
s.apos;trajectory;RW;
s.clientNum;integer;RW;
s.constantLight;integer;RW;
s.density;integer;RW;
s.dl_intensity;integer;RW;
s.dmgFlags;integer;RW;
s.eFlags;integer;RW;
s.eType;integer;?;
s.effect1Time;integer;RW;
s.effect2Time;integer;RW;
s.effect3Time;integer;RW;
s.frame;integer;RW;
s.groundEntityNum;integer;RO;
s.loopSound;integer;RW;
s.modelindex;integer;RW;
s.modelindex2;integer;RW;
s.number;integer;RO;
s.onFireEnd;integer;RW;
s.onFireStart;integer;RW;
s.origin;vec3;?;
s.origin2;vec3;?;
s.pos;trajectory;RW;
s.powerups;integer;RO;
s.solid;integer;RW;
s.teamNum;integer;RW;
s.time;integer;RW;
s.time2;integer;RW;
s.weapon;integer;RO;
scriptName;string;RO;
sess.sessionTeam;team_t;RW;
sess.spectatorTime;integer;RW;
sess.spectatorState;spectatorState_t;RW;
sess.spectatorClient;integer;RW;
sess.latchSpectatorClient;integer;RW;
sess.playerType;integer;RW;
sess.playerWeapon;integer;RW;
sess.playerWeapon2;integer;RW;
sess.spawnObjectiveIndex;integer;RW;
sess.latchPlayerType;integer;RW;
sess.latchPlayerWeapon;integer;RW;
sess.latchPlayerWeapon2;integer;RW;
sess.damage_given;integer;RW;
sess.damage_received;integer;RW;
sess.deaths;integer;RW;
sess.game_points;integer;RW;
sess.gibs;integer;RW;
sess.kills;integer;RW;
sess.muted;qboolean;RW;
sess.referee;integer;RW;
sess.rounds;integer;RW;
sess.semiadmin;integer;RW;
sess.spec_invite;integer;RW;
sess.spec_team;integer;RW;
sess.suicides;integer;RW;
sess.team_damage;integer;RW;
sess.team_kills;integer;RW;
sess.team_received;integer;RW;
spawnflags;integer;RO;
spawnitem;string;RO;
speed;float;RW;
splashDamage;integer;RW;
splashMethodOfDeath;integer;RW;
splashRadius;integer;RW;
start_size;integer;RW;
tagName;string;RO;
tagParent;entity;RW;
takedamage;boolean;RW;
tankLink;entity;RW;
target;string;RW;
TargetAngles;vec3;RW;
TargetFlag;integer;RO;
targetname;string;RO;
teamchain;entity;RW;
teammaster;entity;RW;
track;string;RO;
varc;float;RW;
wait;float;RW;
waterlevel;integer;RO;
watertype;integer;RO;
</pitatable>
:''note'': all the sess.* fields will return nil unless the entity is associated with client slot < sv_maxclients.

----

'''ET variable types''':

*'''vec3''': a '''vec3''' is a 3-element array of numbers (C definition: <tt>typedef float vec3_t[3];
</tt>). It is usually used to store and process coordinates in 3D space. 
In etpro-lua a vector is an array (table indexed by integers) containing 3 numbers. It can be accessed by
doing:
<pre>
origin = et.gentity_get(entNum,"r.currentOrigin") --a vec3 value
x,y,z = origin[1],origin[2],origin[3]</pre>

*'''trajectory''': a '''trajectory''' is returned as a lua table described below
{
trDuration = <number>, --- int
trTime = <number>, -- int
trType = <number>, -- see below for allowed values
trBase { -- this is a vec3, as described above
[1] = <number>
[2] = <number>
[3] = <number>
},
trDelta { -- also a vec3
[1] = <number>
[2] = <number>
[3] = <number>
},
}
: the allowed values for trType (along with the enum names and original comments from the ET source), are as follows. Note
: that not all values make sense for all entity types <tt>
<ol start=0>
<li>TR_STATIONARY</li>
<li>TR_INTERPOLATE // non-parametric, but interpolate between snapshots</li>
<li> TR_LINEAR</li>
<li>TR_LINEAR_STOP</li>
<li>TR_LINEAR_STOP_BACK //----(SA) added. so reverse movement can be different than forward</li>
<li>TR_SINE // value = base + sin( time / duration ) * delta</li>
<li>TR_GRAVITY</li>
<li>TR_GRAVITY_LOW</li>
<li>TR_GRAVITY_FLOAT // super low grav with no gravity acceleration (floating feathers/fabric/leaves/...)</li>
<li>TR_GRAVITY_PAUSED //----(SA) has stopped, but will still do a short trace to see if it should be switched back to TR_GRAVITY</li>
<li>TR_ACCELERATE</li>
<li>TR_DECCELERATE</li>
<li>TR_SPLINE</li>
<li>TR_LINEAR_PATH</li>
</ol>
</tt>

*'''entity''': The fields listed as having type '''enitity''' return an entity number or nil. Entity numbers are integers from 0 through 1023. Some of the entity numbers have special meanings:
** 0 - (sv_privateclients - 1) are reserved for clients who connect with the private slot password
** 0 - 63 are reserved for clients. A client's entity number is also its client number (as shown by /players for example)
** 1022 is the '''worldspawn''' entity
** 1023 is '''ENTITYNUM_NONE''' which is used instead of null in C under some circumstances to indicate no entity. This is needed where an entity number will be passed over the network.
''Note'': Some other fields not listed as type 'entity' may take an entity number value. '''mg42BaseEnt''' and '''s.number''' are examples. 

[[Category:ETPro]]
[[Category:ETPro:Mods]]

Fieldname

2006-03-06T19:31:49Z

=FF=im2good4u: oops i got to go ill finish it tomorow

List of fields supported by [[ETPro:Lua Mod API#entities|et.gentity_get() and et.gentity_set()]] functions 
<pitatable columns=3 headlines="field;type;access" widths="180;80;60" headerfontcolor="#FFFFFF">
activator;entity;RO;
chain;entity;RW;
classname;string;RW;
closespeed;float;RW;
count;integer;RW;
count2;integer;RW;
damage;integer;RW;
deathType;integer;RW;
delay;float;RW;
dl_atten;integer;RW;
dl_color;vec3;RW;
dl_shader;string;RO;
dl_stylestring;string;RO;
duration;float;RW;
end_size;integer;RW;
enemy;entity;RW;
flags;integer;RO;
harc;float;RW;
health;integer;RW;
inuse;boolean;RO;
isProp;boolean;RO;
item;string;RW;
key;integer;RW;
message;string;RW;
methodOfDeath;integer;RW;
mg42BaseEnt;integer;RW;
missionLevel;integer;RW;
model;string;RO;
model2;string;RO;
nextTrain;entity;RW;
noise_index;integer;RW;
origin;vec3;RW;
prevTrain;entity;RW;
props_frame_state;integer;RO;
r.absmax;vec3;RO;
r.absmin;vec3;RO;
r.bmodel;boolean;RO;
r.contents;integer;RW;
r.currentAngles;vec3;RW;
r.currentOrigin;vec3;RW;
r.eventTime;integer;RW;
r.linkcount;integer;RO;
r.linked;boolean;RO;
r.maxs;vec3;RW;
r.mins;vec3;RW;
r.ownerNum;integer;RW;
r.singleClient;integer;RW;
r.svFlags;integer;RW;
r.worldflags;integer;RO;
radius;integer;RW;
random;float;RW;
rotate;vec3;RW;
s.angles;vec3;RW;
s.angles2;vec3;RW;
s.apos;trajectory;RW;
s.clientNum;integer;RW;
s.constantLight;integer;RW;
s.density;integer;RW;
s.dl_intensity;integer;RW;
s.dmgFlags;integer;RW;
s.eFlags;integer;RW;
s.effect1Time;integer;RW;
s.effect2Time;integer;RW;
s.effect3Time;integer;RW;
s.frame;integer;RW;
s.groundEntityNum;integer;RO;
s.loopSound;integer;RW;
s.modelindex;integer;RW;
s.modelindex2;integer;RW;
s.number;integer;RO;
s.onFireEnd;integer;RW;
s.onFireStart;integer;RW;
s.pos;trajectory;RW;
s.powerups;integer;RO;
s.solid;integer;RW;
s.teamNum;integer;RW;
s.time;integer;RW;
s.time2;integer;RW;
s.weapon;integer;RO;
scriptName;string;RO;
sess.sessionTeam;integer;RW;
sess.spectatorTime;integer;RW;
sess.spectatorState;integer;RW;
sess.spectatorClient;integer;RW;
sess.latchSpectatorClient;integer;RW;
sess.playerType;integer;RW;
sess.playerWeapon;integer;RW;
sess.playerWeapon2;integer;RW;
sess.spawnObjectiveIndex;integer;RW;
sess.latchPlayerType;integer;RW;
sess.latchPlayerWeapon;integer;RW;
sess.latchPlayerWeapon2;integer;RW;
sess.damage_given;integer;RW;
sess.damage_received;integer;RW;
sess.deaths;integer;RW;
sess.game_points;integer;RW;
sess.gibs;integer;RW;
sess.kills;integer;RW;
sess.muted;integer;RW;
sess.referee;integer;RW;
sess.rounds;integer;RW;
sess.semiadmin;integer;RW;
sess.spec_invite;integer;RW;
sess.spec_team;integer;RW;
sess.suicides;integer;RW;
sess.team_damage;integer;RW;
sess.team_kills;integer;RW;
sess.team_received;integer;RW;
spawnflags;integer;RO;
spawnitem;string;RO;
speed;float;RW;
splashDamage;integer;RW;
splashMethodOfDeath;integer;RW;
splashRadius;integer;RW;
start_size;integer;RW;
tagName;string;RO;
tagParent;entity;RW;
takedamage;boolean;RW;
tankLink;entity;RW;
target;string;RW;
TargetAngles;vec3;RW;
TargetFlag;integer;RO;
targetname;string;RO;
teamchain;entity;RW;
teammaster;entity;RW;
track;string;RO;
varc;float;RW;
wait;float;RW;
waterlevel;integer;RO;
watertype;integer;RO;
clipmask;integer;RW;
s.eType;integer;RW;
s.origin;vec3;RW;
s.origin2;vec3;RW;
pers.connected
pers.netname
pers.localClient
pers.initialSpawn
pers.enterTime
pers.connectTime
pers.teamState
pers.voteCount
pers.teamVoteCount
pers.complaints
pers.complaintClient
pers.complaintEndTime
pers.lastReinforceTime
pers.applicationClient
pers.applicationEndTime
pers.invitationClient
pers.invitationEndTime
pers.propositionClient
pers.propositionClient2
pers.propositionEndTime
pers.autofireteamEndTime
pers.autofireteamCreateEndTime
pers.autofireteamJoinEndTime
pers.lastSpawnTime
pers.ready
ps.stats
ps.persistant
ps.powerups
ps.ammo
ps.ammoclip
</pitatable>
:''note'': all the sess.* fields will return nil unless the entity is associated with client slot < sv_maxclients.

----

'''ET variable types''':

*'''vec3''': a '''vec3''' is a 3-element array of numbers (C definition: <tt>typedef float vec3_t[3];
</tt>). It is usually used to store and process coordinates in 3D space. 
In etpro-lua a vector is an array (table indexed by integers) containing 3 numbers. It can be accessed by
doing:
<pre>
origin = et.gentity_get(entNum,"r.currentOrigin") --a vec3 value
x,y,z = origin[1],origin[2],origin[3]</pre>

*'''trajectory''': a '''trajectory''' is returned as a lua table described below
{
trDuration = <number>, --- int
trTime = <number>, -- int
trType = <number>, -- see below for allowed values
trBase { -- this is a vec3, as described above
[1] = <number>
[2] = <number>
[3] = <number>
},
trDelta { -- also a vec3
[1] = <number>
[2] = <number>
[3] = <number>
},
}
: the allowed values for trType (along with the enum names and original comments from the ET source), are as follows. Note
: that not all values make sense for all entity types <tt>
<ol start=0>
<li>TR_STATIONARY</li>
<li>TR_INTERPOLATE // non-parametric, but interpolate between snapshots</li>
<li> TR_LINEAR</li>
<li>TR_LINEAR_STOP</li>
<li>TR_LINEAR_STOP_BACK //----(SA) added. so reverse movement can be different than forward</li>
<li>TR_SINE // value = base + sin( time / duration ) * delta</li>
<li>TR_GRAVITY</li>
<li>TR_GRAVITY_LOW</li>
<li>TR_GRAVITY_FLOAT // super low grav with no gravity acceleration (floating feathers/fabric/leaves/...)</li>
<li>TR_GRAVITY_PAUSED //----(SA) has stopped, but will still do a short trace to see if it should be switched back to TR_GRAVITY</li>
<li>TR_ACCELERATE</li>
<li>TR_DECCELERATE</li>
<li>TR_SPLINE</li>
<li>TR_LINEAR_PATH</li>
</ol>
</tt>

*'''entity''': The fields listed as having type '''enitity''' return an entity number or nil. Entity numbers are integers from 0 through 1023. Some of the entity numbers have special meanings:
** 0 - (sv_privateclients - 1) are reserved for clients who connect with the private slot password
** 0 - 63 are reserved for clients. A client's entity number is also its client number (as shown by /players for example)
** 1022 is the '''worldspawn''' entity
** 1023 is '''ENTITYNUM_NONE''' which is used instead of null in C under some circumstances to indicate no entity. This is needed where an entity number will be passed over the network.
''Note'': Some other fields not listed as type 'entity' may take an entity number value. '''mg42BaseEnt''' and '''s.number''' are examples. 

[[Category:ETPro]]
[[Category:ETPro:Mods]]

Lua Mod API

2006-03-06T19:15:45Z

=FF=im2good4u: fixed revived since it apears tobe a number

__NOEDITSECTION__
ETPro now supports serverside mods via the [http://www.lua.org/ lua] scripting language. For more information about lua, visit the [http://www.lua.org/manual/5.0/ Reference manual], the online edition of the book [http://www.lua.org/pil/ Programming in Lua] or the [http://lua-users.org/wiki/ lua-users wiki].

ETPro has an embedded lua 5.0.2 interpreter, and if present will load user-defined scripts from the etpro directory. ETPro also provides an "et" library of function calls for lua to access the server engine, and provides callbacks so a serverside mod may trigger on specific server events.

The following standard lua libraries are initialized by default and available to ETPro lua scripts:
[http://www.lua.org/manual/5.0/manual.html#5.1 basic], [http://www.lua.org/manual/5.0/manual.html#5.4 table], [http://www.lua.org/manual/5.0/manual.html#5.6 i/o], [http://www.lua.org/manual/5.0/manual.html#5.3 string], [http://www.lua.org/manual/5.0/manual.html#5.5 math].

A list of [[ETPro]] mods can be found [[:Category:ETPro:Mods|here]].

API Requests can be discussed [http://wolfwiki.anime.net/index.php/Talk:ETPro:Lua_Mod_API here].

==client commands==
===lua_status===
:lists all currently loaded lua modules.
:''lua mods cannot override this client command.''

==server commands==
===lua_status===
:lists all currently loaded lua modules.

==cvars==
===lua_modules===
:(default "", disabled)
:space separated list of lua modules for ETPro to load. modules will be run in the order listed.

===lua_allowedmodules===
:(default "", disabled)
:if set, only lua modules with the matching sha1 signatures listed in this cvar will be allowed to load.
 
:changing either cvar will cause all currently loaded modules to :quit and be unloaded until the next map_restart. 
 

==et library calls==

===modules===
et.RegisterModname( '''modname''' )
:Registers a descriptive string '''modname''' for this mod.
'''vmnumber''' = et.FindSelf()
:Returns a number indicating the VM slot the current mod is loaded into.
'''modname''', '''signature''' = et.FindMod( '''vmnumber''' )
:Returns the '''modname''' and sha1 '''signature''' for the mod loaded in the VM slot '''vmnumber'''. Returns nil, nil if the VM slot is invalid.
'''success''' = et.IPCSend( '''vmnumber''', '''message''' )
:Sends the string '''message''' to the mod in the VM slot indicated by '''vmnumber'''. The mod receiving '''message''' must have an ''et_IPCReceive()'' callback. If the message is successfully sent, '''success''' will be 1. On failure it will be 0.
 

===printing===
et.G_Print( '''text''' )
:Prints the string '''text''' to the server console.
et.G_LogPrint( '''text''' )
:Prints the string '''text''' to the server console and writes it to the server log.
 

===argument handling===
These functions are to be used within the [[#commands|command callback functions]]. 
'''args''' = et.ConcatArgs( '''index''' )
:Returns all arguments beginning from '''index''' concatenated into a single string '''args'''
'''argcount''' = et.trap_Argc()
:Returns a number indicating the number of command line arguments in the command buffer.
'''arg''' = et.trap_Argv( '''argnum''' )
:Returns the contents of the command line argument '''argnum'''.
 

===cvars===
'''cvarvalue''' = et.trap_Cvar_Get( '''cvarname''' )
:Returns the value of the cvar '''cvarname''' as a string. If there is no cvar named '''cvarname''', returns a zero length string.
et.trap_Cvar_Set( '''cvarname''', '''cvarvalue''' )
:Sets the cvar '''cvarname''' to '''cvarvalue'''
 

===configstrings===
'''configstringvalue''' = et.trap_GetConfigstring( '''index''' )
:Returns the string '''configstringvalue''' containing the contents of the configstring '''index'''
et.trap_SetConfigstring( '''index''', '''configstringvalue''' )
:Sets the configstring '''index''' to the string '''configstringvalue'''
 

===server===
et.trap_SendConsoleCommand( '''when''', '''command''' )
:Sends the command '''command''' to the server console, to be executed '''when''' (see et.EXEC_* constants)
 

===clients===
et.trap_DropClient( '''clientnum''', '''reason''', '''ban_time''' )
:Disconnects '''clientnum''' from the server, with descriptive string '''reason''' reported to clients. '''ban_time''' is the time in seconds to ban the client from the server. '''ban_time''' is optional and may be entirely omitted, in which case the ban time defaults to the cvar ''b_defaultbantime''
et.trap_SendServerCommand( '''clientnum''', '''[[SendServerCommand|command]]''' )
:Sends the command '''[[SendServerCommand|command]]''' to the client '''clientnum'''. If '''clientnum''' is -1, the '''[[SendServerCommand|command]]''' is broadcast to all connected clients.
et.G_Say( '''clientNum''', '''mode''', '''text''' )
:Sends a chat command on behalf of client '''clientNum''' with the mode '''mode''' (see et.SAY_* constants) and chat text '''text'''.
et.ClientUserinfoChanged( '''clientNum''' )
:Loads the new Userinfo of '''clientNum''' and stores it in the configstring and client variables
 

===userinfo===
'''userinfo''' = et.trap_GetUserinfo( '''clientnum''' )
:Returns the contents of the userinfo string for the client '''clientnum'''
et.trap_SetUserinfo( '''clientnum''', '''userinfo''' )
:Sets the userinfo string for the client '''clientnum''' to '''userinfo'''
 

===string utility functions===
'''infostring''' = et.Info_RemoveKey( '''infostring''', '''key''' )
:Removes key '''key''' from infostring '''infostring''' and returns the modified infostring.
'''infostring''' = et.Info_SetValueForKey( '''infostring''', '''key''', '''value''' )
:Sets the key '''key''' in the infostring '''infostring''' to '''value''' and returns the modified infostring. If '''value''' is an empty string, '''key''' is removed from the string.
'''keyvalue''' = et.Info_ValueForKey( '''infostring''', '''key''' )
:Returns the value of the key '''key''' in the infostring '''infostring'''. If '''key''' is not present in the string, an empty string is returned.
'''cleanstring''' = et.Q_CleanStr( '''string''' )
:Returns '''string''' stripped of all color codes
 

===ET filesystem===
'''fd''', '''len''' = et.trap_FS_FOpenFile( '''filename''', '''mode''' )
:Attempts to open the file '''filename''' with the access mode '''mode''' (see et.FS_ constants). Returns the filedescriptor '''fd''' and file length '''len'''. On error, '''len''' returns -1.
'''filedata''' = et.trap_FS_Read( fd, count )
:Reads '''count''' bytes from filedescriptor '''fd'''.
'''count''' = et.trap_FS_Write( '''filedata''', '''count''', '''fd''' )
:Attempts to write '''count''' bytes of '''filedata''' to filedescriptor '''fd'''. Returns number of bytes successfully written.
et.trap_FS_Rename( '''oldname''', '''newname''' )
:Renames file '''oldname''' to '''newname'''.
et.trap_FS_FCloseFile( '''fd''' )
:Closes filedescriptor '''fd'''
 

===indexes===
'''soundindex''' = et.G_SoundIndex( '''filename''' )
:Returns an index to the soundfile indicated by '''filename'''
'''modelindex''' = et.G_ModelIndex( '''filename''' )
:Returns an index to the model indicated by '''filename'''
 

===sound===
et.G_globalSound( '''sound''' )
:Plays the global sound indicated by the filename '''sound'''.
et.G_Sound( '''entnum''', '''soundindex''' )
:Plays the sound '''soundindex''' at the location of entity '''entnum'''
 

===miscellaneous===
'''milliseconds''' = et.trap_Milliseconds()
:Returns a number indicating the current server time in milliseconds.
et.G_Damage( '''target''', '''inflictor''', '''attacker''', '''damage''', '''[[etdamage|dflags]]''', '''[[etdamage|mod]]''' )
:Does '''damage''' amount of damage on '''target''' inflicted by '''inflictor''' and cased by '''attacker'''
:'''target''', '''inflictor''', '''attacker''' are entity numbers
:'''[[etdamage|dflags]]''' is a [[Bitmask-cvar|bitflag]] number to decide how the damage is inflickted, see '''[[etdamage|dflags]]''' [[etdamage|flaglist]]
:'''[[etdamage|mod]]''' is a number from 0 up to 64 o set the type of damage, see '''[[etdamage|mod]]''' [[etdamage|list]]
 

===entities===
'''entnum''' = et.G_Spawn()
:Spawns a new entity and returns the new entity number.
'''entnum''' = et.G_TempEntity( '''origin''', '''event''' )
:Spawns a new TempEntity of event type '''event''' and places it at '''origin''' in the world.
:'''Warning:''' up to and including ETPro 3.2.4 the signature of the method is broken and expects four instead of two parameters. To successfully call it, you need to prepend the parameter list with two dummy parameters like et.G_TempEntity( 0, 0, origin, event ). Use this method with care, because in future ETPro versions it will probably be corrected to the one stated above and might break your script.
et.G_FreeEntity( '''entnum''' )
:Frees the entity '''entnum'''
'''spawnval''' = et.G_GetSpawnVar( '''entnum''', '''key''' )
:Returns the value of spawnvar '''key''' for entity '''entnum'''
et.G_SetSpawnVar( '''entnum''', '''key''', '''value''' )
:Sets the spawnvar '''key''' to '''value''' for entity '''entnum'''
'''integer entnum''' = et.G_SpawnGEntityFromSpawnVars( string spawnvar, string spawnvalue, ... )
:This function can only be called inside the '''et_InitGame''' callback
et.trap_LinkEntity( '''entnum''' )
:Links the entity '''entnum'''
et.trap_UnlinkEntity( '''entnum''' )
:Unlinks the entity '''entnum'''
'''(variable)''' = et.gentity_get ( '''entnum''', '''[[Fieldname]]''' )
:Gets the value of '''[[Fieldname]]''' from entity '''entnum''' out of the g_entity struct. For NULL entities or clients, ''nil'' is returned. 
et.gentity_set( '''entnum''', '''[[Fieldname]]''', '''(variable)''' )
:Sets the value of '''[[Fieldname]]''' from entity '''entnum''' in the g_entity struct to '''(variable)''' 

 

==callbacks==

===qagame execution===
et_InitGame( '''levelTime''', '''randomSeed''', '''restart''' )
:Called when qagame initializes. '''levelTime''' is the current level time in milliseconds. '''randomSeed''' is a number that can be used to seed random number generators. '''restart''' indicates if et_InitGame() is being called due to a map restart (1) or not (0).
et_ShutdownGame( '''restart''' )
:Called when qagame shuts down. '''restart''' indicates if the shutdown is being called due to a map_restart (1) or not (0).
et_RunFrame( '''levelTime''' )
:Called when qagame runs a server frame. '''levelTime''' is the current level time in milliseconds.
et_Quit()
:Called when ETPro unloads the mod. The mod should close all open filedescriptors and perform all cleanup.
 

===client management===
'''rejectreason''' = et_ClientConnect( '''clientNum''', '''firstTime''', '''isBot''' )
:Called when a client attempts to connect to the server. '''clientNum''' is the client slot id, '''firstTime''' indicates if this is a new connection (1) or a reconnection (0). '''isBot''' indicates if the client is a bot (1) or not (0). If the mod accepts the connection, it should return nil. Otherwise, the mod should return a string describing the reason the client connection was rejected.
et_ClientDisconnect( '''clientNum''' )
:Called when a client disconnects. '''clientNum''' is the client slot id.
et_ClientBegin( '''clientNum''' )
:Called when a client begins (becomes active, and enters the gameworld). '''clientNum''' is the client slot id.
et_ClientUserinfoChanged( '''clientNum''' )
:Called when a client's Userinfo string has changed. '''clientNum''' is the client slot id.
et_ClientSpawn( '''clientNum''', '''revived''' )
:Called when a client is spawned. '''clientNum''' is the client slot id. '''revived''' is 1 if the client was spawned by beeying revived.
 

===commands===
'''intercepted''' = et_ClientCommand( '''clientNum''', '''command''' )
:Called when a command is received from a client. '''clientNum''' is the client slot id. '''command''' is the command. The mod should return 1 if the command was intercepted by the mod, and 0 if the command was ignored by the mod and should be passed through to the server (and other mods in the chain).
:The actual command can be accessed through the [[#argument_handling|argument handling]] functions, as seen in the [[ETPro:Lua Sample Code]].
'''intercepted''' = et_ConsoleCommand()
:Called when a command is entered on the server console. The mod should return 1 if the command was intercepted by the mod, and 0 if the command was ignored by the mod and should be passed through to the server (and other mods in the chain).
:The actual command can be accessed through the [[#argument_handling|argument handling]] functions, as seen in the [[ETPro:Lua Sample Code]].
 

===miscellaneous===
et_IPCReceive( '''vmnumber''', '''message''' )
:Called when another mod sends an et.IPCSend() message to this mod. '''vmnumber''' is the VM slot number of the sender, and '''message''' is the message.
et_Print( '''text''' )
:Called whenever the server or qagame prints a string to the console.
et_Obituary( '''victim''', '''killer''', '''meansOfDeath''' )
:Called whenever a player is killed.
 

==predefined constants==
et.EXEC_NOW 
et.EXEC_INSERT 
et.EXEC_APPEND 
et.FS_READ 
et.FS_WRITE 
et.FS_APPEND 
et.FS_APPEND_SYNC 
et.SAY_ALL 
et.SAY_TEAM 
et.SAY_BUDDY 
et.SAY_TEAMNL 
 
et.HOSTARCH
:set to WIN32 or UNIX depending on the host architecture qagame is running on.
LUA_PATH
:set to fs_homepath/fs_game/?.lua in order to ease use of the [http://www.lua.org/pil/8.1.html require] function.
 

==configs==
If a config is loaded, all modules are shutdown and reloaded. If a ''certified'' config is loaded, all modules are shutdown and reloaded, and additionally the following functions are disabled: '''require()''', '''loadfile()''', '''loadlib()''', '''loadstring()''', '''dofile()''' 
 

==caveats==
Like qagame, lua modules are unloaded and reloaded on map_restart and map changes. This means that all global variables and other information is lost. Mods may choose to store persistent data in cvars or external files. 
 

==FAQ==

Q: OMG I hate the libary prefix et.* on everything!!11!1oneone 
A: table.foreach(et, function (func, value) _G[func] = value; end)

Q: How do a re-load my lua file without restarting the whole server ? 
A: change maps or map_restart

Q: Can I see some sample code? 
A: [[ETPro:Lua Sample Code]]

Q: Is there a list of [[ETPro]] mods? 
A: Yes, [[:Category:ETPro:Mods|here]].

Q: OMG my mod doesn't work! 
A: Make sure you added your mod's filename to the lua_modules cvar (e.g. set lua_modules mymod.lua).

Q: OMG why has et_ClientSay been removed? 
A: Thats a secret but, to keep the function as it was, just add the following code to your et_ClientCommand() function 
<pre> -- et_ClientSay had to be removed in order to intercept all commands
-- so here's a wrapper for that
arg0 = et.trap_Argv(0) -- get the main command

if arg0 == "say" then
return et_ClientSay( clientNum, et.SAY_ALL, et.ConcatArgs(1))
elseif arg0 == "say_team" then
return et_ClientSay( clientNum, et.SAY_TEAM, et.ConcatArgs(1))
elseif arg0 == "say_buddy" then
return et_ClientSay( clientNum, et.SAY_BUDDY, et.ConcatArgs(1))
elseif arg0 == "say_teamnl" then
return et_ClientSay( clientNum, et.SAY_TEAMNL, et.ConcatArgs(1))
end
-- et_ClientSay wrapper end
</pre>

[[Category:ETPro]]
[[Category:ETPro:Mods]]

Lua Mod API

2006-03-06T18:58:45Z

=FF=im2good4u: made bitflag a link

__NOEDITSECTION__
ETPro now supports serverside mods via the [http://www.lua.org/ lua] scripting language. For more information about lua, visit the [http://www.lua.org/manual/5.0/ Reference manual], the online edition of the book [http://www.lua.org/pil/ Programming in Lua] or the [http://lua-users.org/wiki/ lua-users wiki].

ETPro has an embedded lua 5.0.2 interpreter, and if present will load user-defined scripts from the etpro directory. ETPro also provides an "et" library of function calls for lua to access the server engine, and provides callbacks so a serverside mod may trigger on specific server events.

The following standard lua libraries are initialized by default and available to ETPro lua scripts:
[http://www.lua.org/manual/5.0/manual.html#5.1 basic], [http://www.lua.org/manual/5.0/manual.html#5.4 table], [http://www.lua.org/manual/5.0/manual.html#5.6 i/o], [http://www.lua.org/manual/5.0/manual.html#5.3 string], [http://www.lua.org/manual/5.0/manual.html#5.5 math].

A list of [[ETPro]] mods can be found [[:Category:ETPro:Mods|here]].

API Requests can be discussed [http://wolfwiki.anime.net/index.php/Talk:ETPro:Lua_Mod_API here].

==client commands==
===lua_status===
:lists all currently loaded lua modules.
:''lua mods cannot override this client command.''

==server commands==
===lua_status===
:lists all currently loaded lua modules.

==cvars==
===lua_modules===
:(default "", disabled)
:space separated list of lua modules for ETPro to load. modules will be run in the order listed.

===lua_allowedmodules===
:(default "", disabled)
:if set, only lua modules with the matching sha1 signatures listed in this cvar will be allowed to load.
 
:changing either cvar will cause all currently loaded modules to :quit and be unloaded until the next map_restart. 
 

==et library calls==

===modules===
et.RegisterModname( '''modname''' )
:Registers a descriptive string '''modname''' for this mod.
'''vmnumber''' = et.FindSelf()
:Returns a number indicating the VM slot the current mod is loaded into.
'''modname''', '''signature''' = et.FindMod( '''vmnumber''' )
:Returns the '''modname''' and sha1 '''signature''' for the mod loaded in the VM slot '''vmnumber'''. Returns nil, nil if the VM slot is invalid.
'''success''' = et.IPCSend( '''vmnumber''', '''message''' )
:Sends the string '''message''' to the mod in the VM slot indicated by '''vmnumber'''. The mod receiving '''message''' must have an ''et_IPCReceive()'' callback. If the message is successfully sent, '''success''' will be 1. On failure it will be 0.
 

===printing===
et.G_Print( '''text''' )
:Prints the string '''text''' to the server console.
et.G_LogPrint( '''text''' )
:Prints the string '''text''' to the server console and writes it to the server log.
 

===argument handling===
These functions are to be used within the [[#commands|command callback functions]]. 
'''args''' = et.ConcatArgs( '''index''' )
:Returns all arguments beginning from '''index''' concatenated into a single string '''args'''
'''argcount''' = et.trap_Argc()
:Returns a number indicating the number of command line arguments in the command buffer.
'''arg''' = et.trap_Argv( '''argnum''' )
:Returns the contents of the command line argument '''argnum'''.
 

===cvars===
'''cvarvalue''' = et.trap_Cvar_Get( '''cvarname''' )
:Returns the value of the cvar '''cvarname''' as a string. If there is no cvar named '''cvarname''', returns a zero length string.
et.trap_Cvar_Set( '''cvarname''', '''cvarvalue''' )
:Sets the cvar '''cvarname''' to '''cvarvalue'''
 

===configstrings===
'''configstringvalue''' = et.trap_GetConfigstring( '''index''' )
:Returns the string '''configstringvalue''' containing the contents of the configstring '''index'''
et.trap_SetConfigstring( '''index''', '''configstringvalue''' )
:Sets the configstring '''index''' to the string '''configstringvalue'''
 

===server===
et.trap_SendConsoleCommand( '''when''', '''command''' )
:Sends the command '''command''' to the server console, to be executed '''when''' (see et.EXEC_* constants)
 

===clients===
et.trap_DropClient( '''clientnum''', '''reason''', '''ban_time''' )
:Disconnects '''clientnum''' from the server, with descriptive string '''reason''' reported to clients. '''ban_time''' is the time in seconds to ban the client from the server. '''ban_time''' is optional and may be entirely omitted, in which case the ban time defaults to the cvar ''b_defaultbantime''
et.trap_SendServerCommand( '''clientnum''', '''[[SendServerCommand|command]]''' )
:Sends the command '''[[SendServerCommand|command]]''' to the client '''clientnum'''. If '''clientnum''' is -1, the '''[[SendServerCommand|command]]''' is broadcast to all connected clients.
et.G_Say( '''clientNum''', '''mode''', '''text''' )
:Sends a chat command on behalf of client '''clientNum''' with the mode '''mode''' (see et.SAY_* constants) and chat text '''text'''.
et.ClientUserinfoChanged( '''clientNum''' )
:Loads the new Userinfo of '''clientNum''' and stores it in the configstring and client variables
 

===userinfo===
'''userinfo''' = et.trap_GetUserinfo( '''clientnum''' )
:Returns the contents of the userinfo string for the client '''clientnum'''
et.trap_SetUserinfo( '''clientnum''', '''userinfo''' )
:Sets the userinfo string for the client '''clientnum''' to '''userinfo'''
 

===string utility functions===
'''infostring''' = et.Info_RemoveKey( '''infostring''', '''key''' )
:Removes key '''key''' from infostring '''infostring''' and returns the modified infostring.
'''infostring''' = et.Info_SetValueForKey( '''infostring''', '''key''', '''value''' )
:Sets the key '''key''' in the infostring '''infostring''' to '''value''' and returns the modified infostring. If '''value''' is an empty string, '''key''' is removed from the string.
'''keyvalue''' = et.Info_ValueForKey( '''infostring''', '''key''' )
:Returns the value of the key '''key''' in the infostring '''infostring'''. If '''key''' is not present in the string, an empty string is returned.
'''cleanstring''' = et.Q_CleanStr( '''string''' )
:Returns '''string''' stripped of all color codes
 

===ET filesystem===
'''fd''', '''len''' = et.trap_FS_FOpenFile( '''filename''', '''mode''' )
:Attempts to open the file '''filename''' with the access mode '''mode''' (see et.FS_ constants). Returns the filedescriptor '''fd''' and file length '''len'''. On error, '''len''' returns -1.
'''filedata''' = et.trap_FS_Read( fd, count )
:Reads '''count''' bytes from filedescriptor '''fd'''.
'''count''' = et.trap_FS_Write( '''filedata''', '''count''', '''fd''' )
:Attempts to write '''count''' bytes of '''filedata''' to filedescriptor '''fd'''. Returns number of bytes successfully written.
et.trap_FS_Rename( '''oldname''', '''newname''' )
:Renames file '''oldname''' to '''newname'''.
et.trap_FS_FCloseFile( '''fd''' )
:Closes filedescriptor '''fd'''
 

===indexes===
'''soundindex''' = et.G_SoundIndex( '''filename''' )
:Returns an index to the soundfile indicated by '''filename'''
'''modelindex''' = et.G_ModelIndex( '''filename''' )
:Returns an index to the model indicated by '''filename'''
 

===sound===
et.G_globalSound( '''sound''' )
:Plays the global sound indicated by the filename '''sound'''.
et.G_Sound( '''entnum''', '''soundindex''' )
:Plays the sound '''soundindex''' at the location of entity '''entnum'''
 

===miscellaneous===
'''milliseconds''' = et.trap_Milliseconds()
:Returns a number indicating the current server time in milliseconds.
et.G_Damage( '''target''', '''inflictor''', '''attacker''', '''damage''', '''[[etdamage|dflags]]''', '''[[etdamage|mod]]''' )
:Does '''damage''' amount of damage on '''target''' inflicted by '''inflictor''' and cased by '''attacker'''
:'''target''', '''inflictor''', '''attacker''' are entity numbers
:'''[[etdamage|dflags]]''' is a [[Bitmask-cvar|bitflag]] number to decide how the damage is inflickted, see '''[[etdamage|dflags]]''' [[etdamage|flaglist]]
:'''[[etdamage|mod]]''' is a number from 0 up to 64 o set the type of damage, see '''[[etdamage|mod]]''' [[etdamage|list]]
 

===entities===
'''entnum''' = et.G_Spawn()
:Spawns a new entity and returns the new entity number.
'''entnum''' = et.G_TempEntity( '''origin''', '''event''' )
:Spawns a new TempEntity of event type '''event''' and places it at '''origin''' in the world.
:'''Warning:''' up to and including ETPro 3.2.4 the signature of the method is broken and expects four instead of two parameters. To successfully call it, you need to prepend the parameter list with two dummy parameters like et.G_TempEntity( 0, 0, origin, event ). Use this method with care, because in future ETPro versions it will probably be corrected to the one stated above and might break your script.
et.G_FreeEntity( '''entnum''' )
:Frees the entity '''entnum'''
'''spawnval''' = et.G_GetSpawnVar( '''entnum''', '''key''' )
:Returns the value of spawnvar '''key''' for entity '''entnum'''
et.G_SetSpawnVar( '''entnum''', '''key''', '''value''' )
:Sets the spawnvar '''key''' to '''value''' for entity '''entnum'''
'''integer entnum''' = et.G_SpawnGEntityFromSpawnVars( string spawnvar, string spawnvalue, ... )
:This function can only be called inside the '''et_InitGame''' callback
et.trap_LinkEntity( '''entnum''' )
:Links the entity '''entnum'''
et.trap_UnlinkEntity( '''entnum''' )
:Unlinks the entity '''entnum'''
'''(variable)''' = et.gentity_get ( '''entnum''', '''[[Fieldname]]''' )
:Gets the value of '''[[Fieldname]]''' from entity '''entnum''' out of the g_entity struct. For NULL entities or clients, ''nil'' is returned. 
et.gentity_set( '''entnum''', '''[[Fieldname]]''', '''(variable)''' )
:Sets the value of '''[[Fieldname]]''' from entity '''entnum''' in the g_entity struct to '''(variable)''' 

 

==callbacks==

===qagame execution===
et_InitGame( '''levelTime''', '''randomSeed''', '''restart''' )
:Called when qagame initializes. '''levelTime''' is the current level time in milliseconds. '''randomSeed''' is a number that can be used to seed random number generators. '''restart''' indicates if et_InitGame() is being called due to a map restart (1) or not (0).
et_ShutdownGame( '''restart''' )
:Called when qagame shuts down. '''restart''' indicates if the shutdown is being called due to a map_restart (1) or not (0).
et_RunFrame( '''levelTime''' )
:Called when qagame runs a server frame. '''levelTime''' is the current level time in milliseconds.
et_Quit()
:Called when ETPro unloads the mod. The mod should close all open filedescriptors and perform all cleanup.
 

===client management===
'''rejectreason''' = et_ClientConnect( '''clientNum''', '''firstTime''', '''isBot''' )
:Called when a client attempts to connect to the server. '''clientNum''' is the client slot id, '''firstTime''' indicates if this is a new connection (1) or a reconnection (0). '''isBot''' indicates if the client is a bot (1) or not (0). If the mod accepts the connection, it should return nil. Otherwise, the mod should return a string describing the reason the client connection was rejected.
et_ClientDisconnect( '''clientNum''' )
:Called when a client disconnects. '''clientNum''' is the client slot id.
et_ClientBegin( '''clientNum''' )
:Called when a client begins (becomes active, and enters the gameworld). '''clientNum''' is the client slot id.
et_ClientUserinfoChanged( '''clientNum''' )
:Called when a client's Userinfo string has changed. '''clientNum''' is the client slot id.
et_ClientSpawn( '''clientNum''', '''revived''' )
:Called when a client is spawned. '''clientNum''' is the client slot id. '''revived''' is ''true'' if the client was spawned by beeying revived.
 

===commands===
'''intercepted''' = et_ClientCommand( '''clientNum''', '''command''' )
:Called when a command is received from a client. '''clientNum''' is the client slot id. '''command''' is the command. The mod should return 1 if the command was intercepted by the mod, and 0 if the command was ignored by the mod and should be passed through to the server (and other mods in the chain).
:The actual command can be accessed through the [[#argument_handling|argument handling]] functions, as seen in the [[ETPro:Lua Sample Code]].
'''intercepted''' = et_ConsoleCommand()
:Called when a command is entered on the server console. The mod should return 1 if the command was intercepted by the mod, and 0 if the command was ignored by the mod and should be passed through to the server (and other mods in the chain).
:The actual command can be accessed through the [[#argument_handling|argument handling]] functions, as seen in the [[ETPro:Lua Sample Code]].
 

===miscellaneous===
et_IPCReceive( '''vmnumber''', '''message''' )
:Called when another mod sends an et.IPCSend() message to this mod. '''vmnumber''' is the VM slot number of the sender, and '''message''' is the message.
et_Print( '''text''' )
:Called whenever the server or qagame prints a string to the console.
et_Obituary( '''victim''', '''killer''', '''meansOfDeath''' )
:Called whenever a player is killed.
 

==predefined constants==
et.EXEC_NOW 
et.EXEC_INSERT 
et.EXEC_APPEND 
et.FS_READ 
et.FS_WRITE 
et.FS_APPEND 
et.FS_APPEND_SYNC 
et.SAY_ALL 
et.SAY_TEAM 
et.SAY_BUDDY 
et.SAY_TEAMNL 
 
et.HOSTARCH
:set to WIN32 or UNIX depending on the host architecture qagame is running on.
LUA_PATH
:set to fs_homepath/fs_game/?.lua in order to ease use of the [http://www.lua.org/pil/8.1.html require] function.
 

==configs==
If a config is loaded, all modules are shutdown and reloaded. If a ''certified'' config is loaded, all modules are shutdown and reloaded, and additionally the following functions are disabled: '''require()''', '''loadfile()''', '''loadlib()''', '''loadstring()''', '''dofile()''' 
 

==caveats==
Like qagame, lua modules are unloaded and reloaded on map_restart and map changes. This means that all global variables and other information is lost. Mods may choose to store persistent data in cvars or external files. 
 

==FAQ==

Q: OMG I hate the libary prefix et.* on everything!!11!1oneone 
A: table.foreach(et, function (func, value) _G[func] = value; end)

Q: How do a re-load my lua file without restarting the whole server ? 
A: change maps or map_restart

Q: Can I see some sample code? 
A: [[ETPro:Lua Sample Code]]

Q: Is there a list of [[ETPro]] mods? 
A: Yes, [[:Category:ETPro:Mods|here]].

Q: OMG my mod doesn't work! 
A: Make sure you added your mod's filename to the lua_modules cvar (e.g. set lua_modules mymod.lua).

Q: OMG why has et_ClientSay been removed? 
A: Thats a secret but, to keep the function as it was, just add the following code to your et_ClientCommand() function 
<pre> -- et_ClientSay had to be removed in order to intercept all commands
-- so here's a wrapper for that
arg0 = et.trap_Argv(0) -- get the main command

if arg0 == "say" then
return et_ClientSay( clientNum, et.SAY_ALL, et.ConcatArgs(1))
elseif arg0 == "say_team" then
return et_ClientSay( clientNum, et.SAY_TEAM, et.ConcatArgs(1))
elseif arg0 == "say_buddy" then
return et_ClientSay( clientNum, et.SAY_BUDDY, et.ConcatArgs(1))
elseif arg0 == "say_teamnl" then
return et_ClientSay( clientNum, et.SAY_TEAMNL, et.ConcatArgs(1))
end
-- et_ClientSay wrapper end
</pre>

[[Category:ETPro]]
[[Category:ETPro:Mods]]

Lua Mod API

2006-03-06T18:51:54Z

=FF=im2good4u: snapshot 1 callbacks

__NOEDITSECTION__
ETPro now supports serverside mods via the [http://www.lua.org/ lua] scripting language. For more information about lua, visit the [http://www.lua.org/manual/5.0/ Reference manual], the online edition of the book [http://www.lua.org/pil/ Programming in Lua] or the [http://lua-users.org/wiki/ lua-users wiki].

ETPro has an embedded lua 5.0.2 interpreter, and if present will load user-defined scripts from the etpro directory. ETPro also provides an "et" library of function calls for lua to access the server engine, and provides callbacks so a serverside mod may trigger on specific server events.

The following standard lua libraries are initialized by default and available to ETPro lua scripts:
[http://www.lua.org/manual/5.0/manual.html#5.1 basic], [http://www.lua.org/manual/5.0/manual.html#5.4 table], [http://www.lua.org/manual/5.0/manual.html#5.6 i/o], [http://www.lua.org/manual/5.0/manual.html#5.3 string], [http://www.lua.org/manual/5.0/manual.html#5.5 math].

A list of [[ETPro]] mods can be found [[:Category:ETPro:Mods|here]].

API Requests can be discussed [http://wolfwiki.anime.net/index.php/Talk:ETPro:Lua_Mod_API here].

==client commands==
===lua_status===
:lists all currently loaded lua modules.
:''lua mods cannot override this client command.''

==server commands==
===lua_status===
:lists all currently loaded lua modules.

==cvars==
===lua_modules===
:(default "", disabled)
:space separated list of lua modules for ETPro to load. modules will be run in the order listed.

===lua_allowedmodules===
:(default "", disabled)
:if set, only lua modules with the matching sha1 signatures listed in this cvar will be allowed to load.
 
:changing either cvar will cause all currently loaded modules to :quit and be unloaded until the next map_restart. 
 

==et library calls==

===modules===
et.RegisterModname( '''modname''' )
:Registers a descriptive string '''modname''' for this mod.
'''vmnumber''' = et.FindSelf()
:Returns a number indicating the VM slot the current mod is loaded into.
'''modname''', '''signature''' = et.FindMod( '''vmnumber''' )
:Returns the '''modname''' and sha1 '''signature''' for the mod loaded in the VM slot '''vmnumber'''. Returns nil, nil if the VM slot is invalid.
'''success''' = et.IPCSend( '''vmnumber''', '''message''' )
:Sends the string '''message''' to the mod in the VM slot indicated by '''vmnumber'''. The mod receiving '''message''' must have an ''et_IPCReceive()'' callback. If the message is successfully sent, '''success''' will be 1. On failure it will be 0.
 

===printing===
et.G_Print( '''text''' )
:Prints the string '''text''' to the server console.
et.G_LogPrint( '''text''' )
:Prints the string '''text''' to the server console and writes it to the server log.
 

===argument handling===
These functions are to be used within the [[#commands|command callback functions]]. 
'''args''' = et.ConcatArgs( '''index''' )
:Returns all arguments beginning from '''index''' concatenated into a single string '''args'''
'''argcount''' = et.trap_Argc()
:Returns a number indicating the number of command line arguments in the command buffer.
'''arg''' = et.trap_Argv( '''argnum''' )
:Returns the contents of the command line argument '''argnum'''.
 

===cvars===
'''cvarvalue''' = et.trap_Cvar_Get( '''cvarname''' )
:Returns the value of the cvar '''cvarname''' as a string. If there is no cvar named '''cvarname''', returns a zero length string.
et.trap_Cvar_Set( '''cvarname''', '''cvarvalue''' )
:Sets the cvar '''cvarname''' to '''cvarvalue'''
 

===configstrings===
'''configstringvalue''' = et.trap_GetConfigstring( '''index''' )
:Returns the string '''configstringvalue''' containing the contents of the configstring '''index'''
et.trap_SetConfigstring( '''index''', '''configstringvalue''' )
:Sets the configstring '''index''' to the string '''configstringvalue'''
 

===server===
et.trap_SendConsoleCommand( '''when''', '''command''' )
:Sends the command '''command''' to the server console, to be executed '''when''' (see et.EXEC_* constants)
 

===clients===
et.trap_DropClient( '''clientnum''', '''reason''', '''ban_time''' )
:Disconnects '''clientnum''' from the server, with descriptive string '''reason''' reported to clients. '''ban_time''' is the time in seconds to ban the client from the server. '''ban_time''' is optional and may be entirely omitted, in which case the ban time defaults to the cvar ''b_defaultbantime''
et.trap_SendServerCommand( '''clientnum''', '''[[SendServerCommand|command]]''' )
:Sends the command '''[[SendServerCommand|command]]''' to the client '''clientnum'''. If '''clientnum''' is -1, the '''[[SendServerCommand|command]]''' is broadcast to all connected clients.
et.G_Say( '''clientNum''', '''mode''', '''text''' )
:Sends a chat command on behalf of client '''clientNum''' with the mode '''mode''' (see et.SAY_* constants) and chat text '''text'''.
et.ClientUserinfoChanged( '''clientNum''' )
:Loads the new Userinfo of '''clientNum''' and stores it in the configstring and client variables
 

===userinfo===
'''userinfo''' = et.trap_GetUserinfo( '''clientnum''' )
:Returns the contents of the userinfo string for the client '''clientnum'''
et.trap_SetUserinfo( '''clientnum''', '''userinfo''' )
:Sets the userinfo string for the client '''clientnum''' to '''userinfo'''
 

===string utility functions===
'''infostring''' = et.Info_RemoveKey( '''infostring''', '''key''' )
:Removes key '''key''' from infostring '''infostring''' and returns the modified infostring.
'''infostring''' = et.Info_SetValueForKey( '''infostring''', '''key''', '''value''' )
:Sets the key '''key''' in the infostring '''infostring''' to '''value''' and returns the modified infostring. If '''value''' is an empty string, '''key''' is removed from the string.
'''keyvalue''' = et.Info_ValueForKey( '''infostring''', '''key''' )
:Returns the value of the key '''key''' in the infostring '''infostring'''. If '''key''' is not present in the string, an empty string is returned.
'''cleanstring''' = et.Q_CleanStr( '''string''' )
:Returns '''string''' stripped of all color codes
 

===ET filesystem===
'''fd''', '''len''' = et.trap_FS_FOpenFile( '''filename''', '''mode''' )
:Attempts to open the file '''filename''' with the access mode '''mode''' (see et.FS_ constants). Returns the filedescriptor '''fd''' and file length '''len'''. On error, '''len''' returns -1.
'''filedata''' = et.trap_FS_Read( fd, count )
:Reads '''count''' bytes from filedescriptor '''fd'''.
'''count''' = et.trap_FS_Write( '''filedata''', '''count''', '''fd''' )
:Attempts to write '''count''' bytes of '''filedata''' to filedescriptor '''fd'''. Returns number of bytes successfully written.
et.trap_FS_Rename( '''oldname''', '''newname''' )
:Renames file '''oldname''' to '''newname'''.
et.trap_FS_FCloseFile( '''fd''' )
:Closes filedescriptor '''fd'''
 

===indexes===
'''soundindex''' = et.G_SoundIndex( '''filename''' )
:Returns an index to the soundfile indicated by '''filename'''
'''modelindex''' = et.G_ModelIndex( '''filename''' )
:Returns an index to the model indicated by '''filename'''
 

===sound===
et.G_globalSound( '''sound''' )
:Plays the global sound indicated by the filename '''sound'''.
et.G_Sound( '''entnum''', '''soundindex''' )
:Plays the sound '''soundindex''' at the location of entity '''entnum'''
 

===miscellaneous===
'''milliseconds''' = et.trap_Milliseconds()
:Returns a number indicating the current server time in milliseconds.
et.G_Damage( '''target''', '''inflictor''', '''attacker''', '''damage''', '''[[etdamage|dflags]]''', '''[[etdamage|mod]]''' )
:Does '''damage''' amount of damage on '''target''' inflicted by '''inflictor''' and cased by '''attacker'''
:'''target''', '''inflictor''', '''attacker''' are entity numbers
:'''[[etdamage|dflags]]''' is a bitflag number to decide how the damage is inflickted, see '''[[etdamage|dflags]]''' [[etdamage|flaglist]]
:'''[[etdamage|mod]]''' is a number from 0 up to 64 o set the type of damage, see '''[[etdamage|mod]]''' [[etdamage|list]]
 

===entities===
'''entnum''' = et.G_Spawn()
:Spawns a new entity and returns the new entity number.
'''entnum''' = et.G_TempEntity( '''origin''', '''event''' )
:Spawns a new TempEntity of event type '''event''' and places it at '''origin''' in the world.
:'''Warning:''' up to and including ETPro 3.2.4 the signature of the method is broken and expects four instead of two parameters. To successfully call it, you need to prepend the parameter list with two dummy parameters like et.G_TempEntity( 0, 0, origin, event ). Use this method with care, because in future ETPro versions it will probably be corrected to the one stated above and might break your script.
et.G_FreeEntity( '''entnum''' )
:Frees the entity '''entnum'''
'''spawnval''' = et.G_GetSpawnVar( '''entnum''', '''key''' )
:Returns the value of spawnvar '''key''' for entity '''entnum'''
et.G_SetSpawnVar( '''entnum''', '''key''', '''value''' )
:Sets the spawnvar '''key''' to '''value''' for entity '''entnum'''
'''integer entnum''' = et.G_SpawnGEntityFromSpawnVars( string spawnvar, string spawnvalue, ... )
:This function can only be called inside the '''et_InitGame''' callback
et.trap_LinkEntity( '''entnum''' )
:Links the entity '''entnum'''
et.trap_UnlinkEntity( '''entnum''' )
:Unlinks the entity '''entnum'''
'''(variable)''' = et.gentity_get ( '''entnum''', '''[[Fieldname]]''' )
:Gets the value of '''[[Fieldname]]''' from entity '''entnum''' out of the g_entity struct. For NULL entities or clients, ''nil'' is returned. 
et.gentity_set( '''entnum''', '''[[Fieldname]]''', '''(variable)''' )
:Sets the value of '''[[Fieldname]]''' from entity '''entnum''' in the g_entity struct to '''(variable)''' 

 

==callbacks==

===qagame execution===
et_InitGame( '''levelTime''', '''randomSeed''', '''restart''' )
:Called when qagame initializes. '''levelTime''' is the current level time in milliseconds. '''randomSeed''' is a number that can be used to seed random number generators. '''restart''' indicates if et_InitGame() is being called due to a map restart (1) or not (0).
et_ShutdownGame( '''restart''' )
:Called when qagame shuts down. '''restart''' indicates if the shutdown is being called due to a map_restart (1) or not (0).
et_RunFrame( '''levelTime''' )
:Called when qagame runs a server frame. '''levelTime''' is the current level time in milliseconds.
et_Quit()
:Called when ETPro unloads the mod. The mod should close all open filedescriptors and perform all cleanup.
 

===client management===
'''rejectreason''' = et_ClientConnect( '''clientNum''', '''firstTime''', '''isBot''' )
:Called when a client attempts to connect to the server. '''clientNum''' is the client slot id, '''firstTime''' indicates if this is a new connection (1) or a reconnection (0). '''isBot''' indicates if the client is a bot (1) or not (0). If the mod accepts the connection, it should return nil. Otherwise, the mod should return a string describing the reason the client connection was rejected.
et_ClientDisconnect( '''clientNum''' )
:Called when a client disconnects. '''clientNum''' is the client slot id.
et_ClientBegin( '''clientNum''' )
:Called when a client begins (becomes active, and enters the gameworld). '''clientNum''' is the client slot id.
et_ClientUserinfoChanged( '''clientNum''' )
:Called when a client's Userinfo string has changed. '''clientNum''' is the client slot id.
et_ClientSpawn( '''clientNum''', '''revived''' )
:Called when a client is spawned. '''clientNum''' is the client slot id. '''revived''' is ''true'' if the client was spawned by beeying revived.
 

===commands===
'''intercepted''' = et_ClientCommand( '''clientNum''', '''command''' )
:Called when a command is received from a client. '''clientNum''' is the client slot id. '''command''' is the command. The mod should return 1 if the command was intercepted by the mod, and 0 if the command was ignored by the mod and should be passed through to the server (and other mods in the chain).
:The actual command can be accessed through the [[#argument_handling|argument handling]] functions, as seen in the [[ETPro:Lua Sample Code]].
'''intercepted''' = et_ConsoleCommand()
:Called when a command is entered on the server console. The mod should return 1 if the command was intercepted by the mod, and 0 if the command was ignored by the mod and should be passed through to the server (and other mods in the chain).
:The actual command can be accessed through the [[#argument_handling|argument handling]] functions, as seen in the [[ETPro:Lua Sample Code]].
 

===miscellaneous===
et_IPCReceive( '''vmnumber''', '''message''' )
:Called when another mod sends an et.IPCSend() message to this mod. '''vmnumber''' is the VM slot number of the sender, and '''message''' is the message.
et_Print( '''text''' )
:Called whenever the server or qagame prints a string to the console.
et_Obituary( '''victim''', '''killer''', '''meansOfDeath''' )
:Called whenever a player is killed.
 

==predefined constants==
et.EXEC_NOW 
et.EXEC_INSERT 
et.EXEC_APPEND 
et.FS_READ 
et.FS_WRITE 
et.FS_APPEND 
et.FS_APPEND_SYNC 
et.SAY_ALL 
et.SAY_TEAM 
et.SAY_BUDDY 
et.SAY_TEAMNL 
 
et.HOSTARCH
:set to WIN32 or UNIX depending on the host architecture qagame is running on.
LUA_PATH
:set to fs_homepath/fs_game/?.lua in order to ease use of the [http://www.lua.org/pil/8.1.html require] function.
 

==configs==
If a config is loaded, all modules are shutdown and reloaded. If a ''certified'' config is loaded, all modules are shutdown and reloaded, and additionally the following functions are disabled: '''require()''', '''loadfile()''', '''loadlib()''', '''loadstring()''', '''dofile()''' 
 

==caveats==
Like qagame, lua modules are unloaded and reloaded on map_restart and map changes. This means that all global variables and other information is lost. Mods may choose to store persistent data in cvars or external files. 
 

==FAQ==

Q: OMG I hate the libary prefix et.* on everything!!11!1oneone 
A: table.foreach(et, function (func, value) _G[func] = value; end)

Q: How do a re-load my lua file without restarting the whole server ? 
A: change maps or map_restart

Q: Can I see some sample code? 
A: [[ETPro:Lua Sample Code]]

Q: Is there a list of [[ETPro]] mods? 
A: Yes, [[:Category:ETPro:Mods|here]].

Q: OMG my mod doesn't work! 
A: Make sure you added your mod's filename to the lua_modules cvar (e.g. set lua_modules mymod.lua).

Q: OMG why has et_ClientSay been removed? 
A: Thats a secret but, to keep the function as it was, just add the following code to your et_ClientCommand() function 
<pre> -- et_ClientSay had to be removed in order to intercept all commands
-- so here's a wrapper for that
arg0 = et.trap_Argv(0) -- get the main command

if arg0 == "say" then
return et_ClientSay( clientNum, et.SAY_ALL, et.ConcatArgs(1))
elseif arg0 == "say_team" then
return et_ClientSay( clientNum, et.SAY_TEAM, et.ConcatArgs(1))
elseif arg0 == "say_buddy" then
return et_ClientSay( clientNum, et.SAY_BUDDY, et.ConcatArgs(1))
elseif arg0 == "say_teamnl" then
return et_ClientSay( clientNum, et.SAY_TEAMNL, et.ConcatArgs(1))
end
-- et_ClientSay wrapper end
</pre>

[[Category:ETPro]]
[[Category:ETPro:Mods]]

Etdamage

2006-03-06T18:47:10Z

=FF=im2good4u: page started

comming soon.

Lua Mod API

2006-03-06T18:46:06Z

=FF=im2good4u: snapshot 1 functions

__NOEDITSECTION__
ETPro now supports serverside mods via the [http://www.lua.org/ lua] scripting language. For more information about lua, visit the [http://www.lua.org/manual/5.0/ Reference manual], the online edition of the book [http://www.lua.org/pil/ Programming in Lua] or the [http://lua-users.org/wiki/ lua-users wiki].

ETPro has an embedded lua 5.0.2 interpreter, and if present will load user-defined scripts from the etpro directory. ETPro also provides an "et" library of function calls for lua to access the server engine, and provides callbacks so a serverside mod may trigger on specific server events.

The following standard lua libraries are initialized by default and available to ETPro lua scripts:
[http://www.lua.org/manual/5.0/manual.html#5.1 basic], [http://www.lua.org/manual/5.0/manual.html#5.4 table], [http://www.lua.org/manual/5.0/manual.html#5.6 i/o], [http://www.lua.org/manual/5.0/manual.html#5.3 string], [http://www.lua.org/manual/5.0/manual.html#5.5 math].

A list of [[ETPro]] mods can be found [[:Category:ETPro:Mods|here]].

API Requests can be discussed [http://wolfwiki.anime.net/index.php/Talk:ETPro:Lua_Mod_API here].

==client commands==
===lua_status===
:lists all currently loaded lua modules.
:''lua mods cannot override this client command.''

==server commands==
===lua_status===
:lists all currently loaded lua modules.

==cvars==
===lua_modules===
:(default "", disabled)
:space separated list of lua modules for ETPro to load. modules will be run in the order listed.

===lua_allowedmodules===
:(default "", disabled)
:if set, only lua modules with the matching sha1 signatures listed in this cvar will be allowed to load.
 
:changing either cvar will cause all currently loaded modules to :quit and be unloaded until the next map_restart. 
 

==et library calls==

===modules===
et.RegisterModname( '''modname''' )
:Registers a descriptive string '''modname''' for this mod.
'''vmnumber''' = et.FindSelf()
:Returns a number indicating the VM slot the current mod is loaded into.
'''modname''', '''signature''' = et.FindMod( '''vmnumber''' )
:Returns the '''modname''' and sha1 '''signature''' for the mod loaded in the VM slot '''vmnumber'''. Returns nil, nil if the VM slot is invalid.
'''success''' = et.IPCSend( '''vmnumber''', '''message''' )
:Sends the string '''message''' to the mod in the VM slot indicated by '''vmnumber'''. The mod receiving '''message''' must have an ''et_IPCReceive()'' callback. If the message is successfully sent, '''success''' will be 1. On failure it will be 0.
 

===printing===
et.G_Print( '''text''' )
:Prints the string '''text''' to the server console.
et.G_LogPrint( '''text''' )
:Prints the string '''text''' to the server console and writes it to the server log.
 

===argument handling===
These functions are to be used within the [[#commands|command callback functions]]. 
'''args''' = et.ConcatArgs( '''index''' )
:Returns all arguments beginning from '''index''' concatenated into a single string '''args'''
'''argcount''' = et.trap_Argc()
:Returns a number indicating the number of command line arguments in the command buffer.
'''arg''' = et.trap_Argv( '''argnum''' )
:Returns the contents of the command line argument '''argnum'''.
 

===cvars===
'''cvarvalue''' = et.trap_Cvar_Get( '''cvarname''' )
:Returns the value of the cvar '''cvarname''' as a string. If there is no cvar named '''cvarname''', returns a zero length string.
et.trap_Cvar_Set( '''cvarname''', '''cvarvalue''' )
:Sets the cvar '''cvarname''' to '''cvarvalue'''
 

===configstrings===
'''configstringvalue''' = et.trap_GetConfigstring( '''index''' )
:Returns the string '''configstringvalue''' containing the contents of the configstring '''index'''
et.trap_SetConfigstring( '''index''', '''configstringvalue''' )
:Sets the configstring '''index''' to the string '''configstringvalue'''
 

===server===
et.trap_SendConsoleCommand( '''when''', '''command''' )
:Sends the command '''command''' to the server console, to be executed '''when''' (see et.EXEC_* constants)
 

===clients===
et.trap_DropClient( '''clientnum''', '''reason''', '''ban_time''' )
:Disconnects '''clientnum''' from the server, with descriptive string '''reason''' reported to clients. '''ban_time''' is the time in seconds to ban the client from the server. '''ban_time''' is optional and may be entirely omitted, in which case the ban time defaults to the cvar ''b_defaultbantime''
et.trap_SendServerCommand( '''clientnum''', '''[[SendServerCommand|command]]''' )
:Sends the command '''[[SendServerCommand|command]]''' to the client '''clientnum'''. If '''clientnum''' is -1, the '''[[SendServerCommand|command]]''' is broadcast to all connected clients.
et.G_Say( '''clientNum''', '''mode''', '''text''' )
:Sends a chat command on behalf of client '''clientNum''' with the mode '''mode''' (see et.SAY_* constants) and chat text '''text'''.
et.ClientUserinfoChanged( '''clientNum''' )
:Loads the new Userinfo of '''clientNum''' and stores it in the configstring and client variables
 

===userinfo===
'''userinfo''' = et.trap_GetUserinfo( '''clientnum''' )
:Returns the contents of the userinfo string for the client '''clientnum'''
et.trap_SetUserinfo( '''clientnum''', '''userinfo''' )
:Sets the userinfo string for the client '''clientnum''' to '''userinfo'''
 

===string utility functions===
'''infostring''' = et.Info_RemoveKey( '''infostring''', '''key''' )
:Removes key '''key''' from infostring '''infostring''' and returns the modified infostring.
'''infostring''' = et.Info_SetValueForKey( '''infostring''', '''key''', '''value''' )
:Sets the key '''key''' in the infostring '''infostring''' to '''value''' and returns the modified infostring. If '''value''' is an empty string, '''key''' is removed from the string.
'''keyvalue''' = et.Info_ValueForKey( '''infostring''', '''key''' )
:Returns the value of the key '''key''' in the infostring '''infostring'''. If '''key''' is not present in the string, an empty string is returned.
'''cleanstring''' = et.Q_CleanStr( '''string''' )
:Returns '''string''' stripped of all color codes
 

===ET filesystem===
'''fd''', '''len''' = et.trap_FS_FOpenFile( '''filename''', '''mode''' )
:Attempts to open the file '''filename''' with the access mode '''mode''' (see et.FS_ constants). Returns the filedescriptor '''fd''' and file length '''len'''. On error, '''len''' returns -1.
'''filedata''' = et.trap_FS_Read( fd, count )
:Reads '''count''' bytes from filedescriptor '''fd'''.
'''count''' = et.trap_FS_Write( '''filedata''', '''count''', '''fd''' )
:Attempts to write '''count''' bytes of '''filedata''' to filedescriptor '''fd'''. Returns number of bytes successfully written.
et.trap_FS_Rename( '''oldname''', '''newname''' )
:Renames file '''oldname''' to '''newname'''.
et.trap_FS_FCloseFile( '''fd''' )
:Closes filedescriptor '''fd'''
 

===indexes===
'''soundindex''' = et.G_SoundIndex( '''filename''' )
:Returns an index to the soundfile indicated by '''filename'''
'''modelindex''' = et.G_ModelIndex( '''filename''' )
:Returns an index to the model indicated by '''filename'''
 

===sound===
et.G_globalSound( '''sound''' )
:Plays the global sound indicated by the filename '''sound'''.
et.G_Sound( '''entnum''', '''soundindex''' )
:Plays the sound '''soundindex''' at the location of entity '''entnum'''
 

===miscellaneous===
'''milliseconds''' = et.trap_Milliseconds()
:Returns a number indicating the current server time in milliseconds.
et.G_Damage( '''target''', '''inflictor''', '''attacker''', '''damage''', '''[[etdamage|dflags]]''', '''[[etdamage|mod]]''' )
:Does '''damage''' amount of damage on '''target''' inflicted by '''inflictor''' and cased by '''attacker'''
:'''target''', '''inflictor''', '''attacker''' are entity numbers
:'''[[etdamage|dflags]]''' is a bitflag number to decide how the damage is inflickted, see '''[[etdamage|dflags]]''' [[etdamage|flaglist]]
:'''[[etdamage|mod]]''' is a number from 0 up to 64 o set the type of damage, see '''[[etdamage|mod]]''' [[etdamage|list]]
 

===entities===
'''entnum''' = et.G_Spawn()
:Spawns a new entity and returns the new entity number.
'''entnum''' = et.G_TempEntity( '''origin''', '''event''' )
:Spawns a new TempEntity of event type '''event''' and places it at '''origin''' in the world.
:'''Warning:''' up to and including ETPro 3.2.4 the signature of the method is broken and expects four instead of two parameters. To successfully call it, you need to prepend the parameter list with two dummy parameters like et.G_TempEntity( 0, 0, origin, event ). Use this method with care, because in future ETPro versions it will probably be corrected to the one stated above and might break your script.
et.G_FreeEntity( '''entnum''' )
:Frees the entity '''entnum'''
'''spawnval''' = et.G_GetSpawnVar( '''entnum''', '''key''' )
:Returns the value of spawnvar '''key''' for entity '''entnum'''
et.G_SetSpawnVar( '''entnum''', '''key''', '''value''' )
:Sets the spawnvar '''key''' to '''value''' for entity '''entnum'''
'''integer entnum''' = et.G_SpawnGEntityFromSpawnVars( string spawnvar, string spawnvalue, ... )
:This function can only be called inside the '''et_InitGame''' callback
et.trap_LinkEntity( '''entnum''' )
:Links the entity '''entnum'''
et.trap_UnlinkEntity( '''entnum''' )
:Unlinks the entity '''entnum'''
'''(variable)''' = et.gentity_get ( '''entnum''', '''[[Fieldname]]''' )
:Gets the value of '''[[Fieldname]]''' from entity '''entnum''' out of the g_entity struct. For NULL entities or clients, ''nil'' is returned. 
et.gentity_set( '''entnum''', '''[[Fieldname]]''', '''(variable)''' )
:Sets the value of '''[[Fieldname]]''' from entity '''entnum''' in the g_entity struct to '''(variable)''' 

 

==callbacks==

===qagame execution===
et_InitGame( '''levelTime''', '''randomSeed''', '''restart''' )
:Called when qagame initializes. '''levelTime''' is the current level time in milliseconds. '''randomSeed''' is a number that can be used to seed random number generators. '''restart''' indicates if et_InitGame() is being called due to a map restart (1) or not (0).
et_ShutdownGame( '''restart''' )
:Called when qagame shuts down. '''restart''' indicates if the shutdown is being called due to a map_restart (1) or not (0).
et_RunFrame( '''levelTime''' )
:Called when qagame runs a server frame. '''levelTime''' is the current level time in milliseconds.
et_Quit()
:Called when ETPro unloads the mod. The mod should close all open filedescriptors and perform all cleanup.
 

===client management===
'''rejectreason''' = et_ClientConnect( '''clientNum''', '''firstTime''', '''isBot''' )
:Called when a client attempts to connect to the server. '''clientNum''' is the client slot id, '''firstTime''' indicates if this is a new connection (1) or a reconnection (0). '''isBot''' indicates if the client is a bot (1) or not (0). If the mod accepts the connection, it should return nil. Otherwise, the mod should return a string describing the reason the client connection was rejected.
et_ClientDisconnect( '''clientNum''' )
:Called when a client disconnects. '''clientNum''' is the client slot id.
et_ClientBegin( '''clientNum''' )
:Called when a client begins (becomes active, and enters the gameworld). '''clientNum''' is the client slot id.
et_ClientUserinfoChanged( '''clientNum''' )
:Called when a client's Userinfo string has changed. '''clientNum''' is the client slot id.
 

===commands===
'''intercepted''' = et_ClientCommand( '''clientNum''', '''command''' )
:Called when a command is received from a client. '''clientNum''' is the client slot id. '''command''' is the command. The mod should return 1 if the command was intercepted by the mod, and 0 if the command was ignored by the mod and should be passed through to the server (and other mods in the chain).
:The actual command can be accessed through the [[#argument_handling|argument handling]] functions, as seen in the [[ETPro:Lua Sample Code]].
'''intercepted''' = et_ConsoleCommand()
:Called when a command is entered on the server console. The mod should return 1 if the command was intercepted by the mod, and 0 if the command was ignored by the mod and should be passed through to the server (and other mods in the chain).
:The actual command can be accessed through the [[#argument_handling|argument handling]] functions, as seen in the [[ETPro:Lua Sample Code]].
 

===miscellaneous===
et_IPCReceive( '''vmnumber''', '''message''' )
:Called when another mod sends an et.IPCSend() message to this mod. '''vmnumber''' is the VM slot number of the sender, and '''message''' is the message.
et_Print( '''text''' )
:Called whenever the server or qagame prints a string to the console.
et_Obituary( '''victim''', '''killer''', '''meansOfDeath''' )
:Called whenever a player is killed.
 

==predefined constants==
et.EXEC_NOW 
et.EXEC_INSERT 
et.EXEC_APPEND 
et.FS_READ 
et.FS_WRITE 
et.FS_APPEND 
et.FS_APPEND_SYNC 
et.SAY_ALL 
et.SAY_TEAM 
et.SAY_BUDDY 
et.SAY_TEAMNL 
 
et.HOSTARCH
:set to WIN32 or UNIX depending on the host architecture qagame is running on.
LUA_PATH
:set to fs_homepath/fs_game/?.lua in order to ease use of the [http://www.lua.org/pil/8.1.html require] function.
 

==configs==
If a config is loaded, all modules are shutdown and reloaded. If a ''certified'' config is loaded, all modules are shutdown and reloaded, and additionally the following functions are disabled: '''require()''', '''loadfile()''', '''loadlib()''', '''loadstring()''', '''dofile()''' 
 

==caveats==
Like qagame, lua modules are unloaded and reloaded on map_restart and map changes. This means that all global variables and other information is lost. Mods may choose to store persistent data in cvars or external files. 
 

==FAQ==

Q: OMG I hate the libary prefix et.* on everything!!11!1oneone 
A: table.foreach(et, function (func, value) _G[func] = value; end)

Q: How do a re-load my lua file without restarting the whole server ? 
A: change maps or map_restart

Q: Can I see some sample code? 
A: [[ETPro:Lua Sample Code]]

Q: Is there a list of [[ETPro]] mods? 
A: Yes, [[:Category:ETPro:Mods|here]].

Q: OMG my mod doesn't work! 
A: Make sure you added your mod's filename to the lua_modules cvar (e.g. set lua_modules mymod.lua).

Q: OMG why has et_ClientSay been removed? 
A: Thats a secret but, to keep the function as it was, just add the following code to your et_ClientCommand() function 
<pre> -- et_ClientSay had to be removed in order to intercept all commands
-- so here's a wrapper for that
arg0 = et.trap_Argv(0) -- get the main command

if arg0 == "say" then
return et_ClientSay( clientNum, et.SAY_ALL, et.ConcatArgs(1))
elseif arg0 == "say_team" then
return et_ClientSay( clientNum, et.SAY_TEAM, et.ConcatArgs(1))
elseif arg0 == "say_buddy" then
return et_ClientSay( clientNum, et.SAY_BUDDY, et.ConcatArgs(1))
elseif arg0 == "say_teamnl" then
return et_ClientSay( clientNum, et.SAY_TEAMNL, et.ConcatArgs(1))
end
-- et_ClientSay wrapper end
</pre>

[[Category:ETPro]]
[[Category:ETPro:Mods]]

Talk:Lua Mod API

2006-02-15T13:16:10Z

=FF=im2good4u: LoadLib

SendServerCommand

2006-01-26T15:32:18Z

=FF=im2good4u: fixored the locations for voicechats

__NOEDITSECTION__
et.trap_SendServerCommand() is used to send a command from the server to one or more clients. The first argument is the slot number of the client the command will be sent to. If it's equal to -1, the command will be broadcast to all clients.

The following commands can be issued with this function:

==Prining==
===Print===
* "'''print''' \"''Message''\n\""
:'''print''' prints ''Message'' to the client's console.

===Center Print MoO===
* "'''cpm''' \"''Message''\n\"" 
:'''cpm''' prints ''Message'' to the client's annoucement area and console.

===Center Print===
* "'''cp''' \"''Message''\n\"" 
:'''cp''' prints ''Message'' to the center of the client's screen.

===Banner Print===
* "'''b''' ''locations'' \"''Message''\n\"" 
:'''b''' prints ''Message'' to the client's banner ''locations'' 
:the ''locations'' can be a number from 0 to 248
:For compatibility, the old-style locations (from 0-4) are also supported. 
:8 - player chat area 
:16 - left popup area (not recommended) 
:32 - centered above the chat area 
:64 - console only 
:128 - banner area (recommended)(top of screen)

===Scores Print===
* "'''sc''' \"''Message''\n\"" 
:'''sc''' prints ''Message'' to the client's console and writes it to the statsdump file.

==Chatting==
===Chat===
* "'''c''' ''ClientNum'' \"''Message''\"" 
:'''c''' prints ''Message'' as a global chat message on behalf of the client specified by ''ClientNum''.

===Team Chat===
* "'''tc''' ''ClientNum'' \"''Message''\" ''X-Location'' ''Y-Location'' ''Z-Location''" 
:'''tc''' prints ''Message'' as a team chat message on behalf of the client specified by ''ClientNum'', 
:the ''X,Y,Z-Location's'' are optional parematers that represent the client's location, 
:if the ''X,Y,Z-Location's'' are left out then the message will be printed without a location.

===Fireteam Chat===
* "'''bc''' ''ClientNum'' \"''Message''\" ''X-Location'' ''Y-Location'' ''Z-Location''". 
:'''bc''' prints ''Message'' as a fireteam chat message on behalf of the client specified by ''ClientNum'', 
:the ''X,Y,Z-Location's'' are parematers that represent the client's location.

==Voice Chat==
===Global Voice Chat===
* "'''vchat''' ''VoiceOnly'' ''ClientNum'' 50 ''Vsay-String'' ''Vsay-Number'' \"''Custom-Message''\"". 
:'''vchat''' sends a global voice chat ''Vsay-String'' on behalf of the client specified by ''ClientNum''. 
:''Vsay-Number'' is by default random, however, it can be set by the player by passing parameters to the vsay command (/vsay <''Vsay-Number''> <''Vsay-String''>), ''Vsay-Number'' represents the vsay number of Vsay as listed in the .voice files. 
:''Custom-Message'' is by default \"\" (empty), otherwise it's the message that gets printed in the chat area.
:if ''VoiceOnly'' is 0 it will print a chat message on behalf of ''ClientNum'' contaning the message 
:if ''VoiceOnly'' is 1 it will only do the sound but not the message

===Team Voice Chat===
* "'''vtchat''' ''VoiceOnly'' ''ClientNum'' 50 ''Vsay-String'' ''Vsay-Number'' ''X-Location'' ''Y-Location'' ''Z-Location'' \"''Custom-Message''\"" 
:'''vchat''' sends a team voice chat ''Vsay-String'' a on behalf of client ''ClienNtum''. 
:''Vsay-Number'' is by default random, however, it can be set by the player by passing parameters to the vsay command (/vsay <''Vsay-Number''> <''Vsay-String''>), ''Vsay-Number'' represents the vsay number of Vsay as listed in the .voice files. 
:the ''X,Y,Z-Location's'' parematers the represent the clients location. 
:''Custom-Message'' is by default \"\" (empty), otherwise it's the message that gets printed in the chat area.
:if ''VoiceOnly'' is 0 it will print a chat message on behalf of ''ClientNum'' contaning the message 
:if ''VoiceOnly'' is 1 it will only do the sound but not the message

===Fireteam Voice Chat===
* "'''vtchat''' ''VoiceOnly'' ''ClientNum'' 50 ''Fireteam-String'' ''Vsay-Number'' ''X-Location'' ''Y-Location'' ''Z-Location'' \"''Custom-Message''\"" 
:'''vchat''' will team voice chat ''Vsay-String'' on behalf of client ''ClienNum''. 
:''Vsay-Number'' is by default random, however, it can be set by the player by passing parameters to the vsay command (/vsay <''Vsay-Number''> <''Vsay-String''>), ''Vsay-Number'' represents the vsay number of Vsay as listed in the .voice files. 
:the ''X,Y,Z-Location's'' parematers the represent the clients location. 
:''Custom-Message'' is by default \"\" (empty), otherwise it's the message that gets printed in the chat area.
:if ''VoiceOnly'' is 0 it will print a chat message on behalf of ''ClientNum'' contaning the message 
:if ''VoiceOnly'' is 1 it will only do the sound but not the message

==Fireteam==
===Application===
* "'''application''' ''Number''"
:'''application''' shows a fireteam invation message to the client. 
:if ''Number'' > -1 - the "accept ... application to join your fireteam" message shows up. In this case ''Number'' is the ClientNum of the applying client. 
:if ''Number'' == -1 - the "your aplication has been submitted" message shows up. 
:if ''Number'' == -2 - the "your aplication failed" message shows up. 
:if ''Number'' == -3 - the "your aplication has been approved" message shows up. 
:if ''Number'' == -4 - the "your aplication reply has been sent" message shows up.

===Proposition===
* "'''proposition''' ''Number'' ''Number2''"
:'''proposition''' shows a fireteam proposition message to the client. 
:if ''Number'' > -1 - the "accept ... proposition to invite ... to your fireteam" message shows up. In this case ''Number'' is the ClientNum of the proposed client, and ''Number2'' is the ClientNum of the proposing player. 
:if ''Number'' == -1 - the "your proposition has been submitted" message shows up. 
:if ''Number'' == -2 - the "your proposition was rejected" message shows up. 
:if ''Number'' == -3 - the "your proposition was accepted" message shows up. 
:if ''Number'' == -4 - the "your proposition reply has been sent" message shows up. 
:''Number2'' is an optional paramater only used when ''Number'' > -1.

===Invitation===
* "'''invitation''' ''Number''"
:'''invitation''' shows the fireteam invation message to the client. 
:if ''Number'' > -1 - the "accept .. invitation to join your fireteam" message shows up. In this case ''Number'' is the ClientNum of the applying client. 
:if ''Number'' == -1 - the "your invitation has been submitted" message shows up. 
:if ''Number'' == -2 - the "your invitation rejected" message shows up. 
:if ''Number'' == -3 - the "your invitation was accepted" message shows up. 
:if ''Number'' == -4 - the "your invitation reply has been sent" message shows up.

==Others==
===Complaining===
* "'''complaint''' ''Number''" 
:'''complaint''' shows the complaint vote message to the client. 
:if ''Number'' > 1 - the vote shows up. In this case ''Number'' is the ClientNum of the teamkilling player. 
:if ''Number'' == -1 - the "complaint filed" message shows up. 
:if ''Number'' == -2 - the "complaint dismissed" message shows up.

===Spawning===
* "'''setspawnpt''' ''Number''" 
:'''setspawnpt''' sets the client game selected spawnpoint to number ''number''.

===kicking===
* "'''disconnect''' \"''reason''\"" 
:'''disconnect''' will disconnect the client it has been send with a "Server disconnected" message 
:''reason'' is an optialnal parameter to show a reason after "Server disconnected"

===Configstrings===
* "'''cs''' ''Number'' \"''String''\"" 
: '''cs''' will set the clients configstringnumber ''Number'' to the ''String''

===Shaders===
* "'''remapShader''' \"''OldShader''\" \"''NewShader''\" ''0''" 
: '''remapShader''' remaps the ''OldShader'' whit ''NewShader'' 
: ''0'' is the Timeoffset, i have no idea wut it means so better leave it 0

[[Category:ETPro]]
[[Category:ETPro:Mods]]

SendServerCommand

2006-01-26T15:30:27Z

=FF=im2good4u: updaed voicechats

__NOEDITSECTION__
et.trap_SendServerCommand() is used to send a command from the server to one or more clients. The first argument is the slot number of the client the command will be sent to. If it's equal to -1, the command will be broadcast to all clients.

The following commands can be issued with this function:

==Prining==
===Print===
* "'''print''' \"''Message''\n\""
:'''print''' prints ''Message'' to the client's console.

===Center Print MoO===
* "'''cpm''' \"''Message''\n\"" 
:'''cpm''' prints ''Message'' to the client's annoucement area and console.

===Center Print===
* "'''cp''' \"''Message''\n\"" 
:'''cp''' prints ''Message'' to the center of the client's screen.

===Banner Print===
* "'''b''' ''locations'' \"''Message''\n\"" 
:'''b''' prints ''Message'' to the client's banner ''locations'' 
:the ''locations'' can be a number from 0 to 248
:For compatibility, the old-style locations (from 0-4) are also supported. 
:8 - player chat area 
:16 - left popup area (not recommended) 
:32 - centered above the chat area 
:64 - console only 
:128 - banner area (recommended)(top of screen)

===Scores Print===
* "'''sc''' \"''Message''\n\"" 
:'''sc''' prints ''Message'' to the client's console and writes it to the statsdump file.

==Chatting==
===Chat===
* "'''c''' ''ClientNum'' \"''Message''\"" 
:'''c''' prints ''Message'' as a global chat message on behalf of the client specified by ''ClientNum''.

===Team Chat===
* "'''tc''' ''ClientNum'' \"''Message''\" ''X-Location'' ''Y-Location'' ''Z-Location''" 
:'''tc''' prints ''Message'' as a team chat message on behalf of the client specified by ''ClientNum'', 
:the ''X,Y,Z-Location's'' are optional parematers that represent the client's location, 
:if the ''X,Y,Z-Location's'' are left out then the message will be printed without a location.

===Fireteam Chat===
* "'''bc''' ''ClientNum'' \"''Message''\" ''X-Location'' ''Y-Location'' ''Z-Location''". 
:'''bc''' prints ''Message'' as a fireteam chat message on behalf of the client specified by ''ClientNum'', 
:the ''X,Y,Z-Location's'' are parematers that represent the client's location.

==Voice Chat==
===Global Voice Chat===
* "'''vchat''' ''VoiceOnly'' ''ClientNum'' 50 ''Vsay-String'' ''Vsay-Number'' \"''Custom-Message''\"". 
:'''vchat''' sends a global voice chat ''Vsay-String'' on behalf of the client specified by ''ClientNum''. 
:''Vsay-Number'' is by default random, however, it can be set by the player by passing parameters to the vsay command (/vsay <''Vsay-Number''> <''Vsay-String''>), ''Vsay-Number'' represents the vsay number of Vsay as listed in the .voice files. 
:''Custom-Message'' is by default \"\" (empty), otherwise it's the message that gets printed in the chat area.
:if ''VoiceOnly'' is 0 it will print a chat message on behalf of ''ClientNum'' contaning the message 
:if ''VoiceOnly'' is 1 it will only do the sound but not the message

===Team Voice Chat===
* "'''vtchat''' ''VoiceOnly'' ''ClientNum'' 50 ''Vsay-String'' ''Vsay-Number'' ''Y-Location'' ''Y-Location'' ''Z-Location'' \"''Custom-Message''\"" 
:'''vchat''' sends a team voice chat ''Vsay-String'' a on behalf of client ''ClienNtum''. 
:''Vsay-Number'' is by default random, however, it can be set by the player by passing parameters to the vsay command (/vsay <''Vsay-Number''> <''Vsay-String''>), ''Vsay-Number'' represents the vsay number of Vsay as listed in the .voice files. 
:the ''X,Y,Z-Location's'' parematers the represent the clients location. 
:''Custom-Message'' is by default \"\" (empty), otherwise it's the message that gets printed in the chat area.
:if ''VoiceOnly'' is 0 it will print a chat message on behalf of ''ClientNum'' contaning the message 
:if ''VoiceOnly'' is 1 it will only do the sound but not the message

===Fireteam Voice Chat===
* "'''vtchat''' ''VoiceOnly'' ''ClientNum'' 50 ''Fireteam-String'' ''Vsay-Number'' ''Y-Location'' ''Y-Location'' ''Z-Location'' \"''Custom-Message''\"" 
:'''vchat''' will team voice chat ''Vsay-String'' on behalf of client ''ClienNum''. 
:''Vsay-Number'' is by default random, however, it can be set by the player by passing parameters to the vsay command (/vsay <''Vsay-Number''> <''Vsay-String''>), ''Vsay-Number'' represents the vsay number of Vsay as listed in the .voice files. 
:the ''X,Y,Z-Location's'' parematers the represent the clients location. 
:''Custom-Message'' is by default \"\" (empty), otherwise it's the message that gets printed in the chat area.
:if ''VoiceOnly'' is 0 it will print a chat message on behalf of ''ClientNum'' contaning the message 
:if ''VoiceOnly'' is 1 it will only do the sound but not the message

==Fireteam==
===Application===
* "'''application''' ''Number''"
:'''application''' shows a fireteam invation message to the client. 
:if ''Number'' > -1 - the "accept ... application to join your fireteam" message shows up. In this case ''Number'' is the ClientNum of the applying client. 
:if ''Number'' == -1 - the "your aplication has been submitted" message shows up. 
:if ''Number'' == -2 - the "your aplication failed" message shows up. 
:if ''Number'' == -3 - the "your aplication has been approved" message shows up. 
:if ''Number'' == -4 - the "your aplication reply has been sent" message shows up.

===Proposition===
* "'''proposition''' ''Number'' ''Number2''"
:'''proposition''' shows a fireteam proposition message to the client. 
:if ''Number'' > -1 - the "accept ... proposition to invite ... to your fireteam" message shows up. In this case ''Number'' is the ClientNum of the proposed client, and ''Number2'' is the ClientNum of the proposing player. 
:if ''Number'' == -1 - the "your proposition has been submitted" message shows up. 
:if ''Number'' == -2 - the "your proposition was rejected" message shows up. 
:if ''Number'' == -3 - the "your proposition was accepted" message shows up. 
:if ''Number'' == -4 - the "your proposition reply has been sent" message shows up. 
:''Number2'' is an optional paramater only used when ''Number'' > -1.

===Invitation===
* "'''invitation''' ''Number''"
:'''invitation''' shows the fireteam invation message to the client. 
:if ''Number'' > -1 - the "accept .. invitation to join your fireteam" message shows up. In this case ''Number'' is the ClientNum of the applying client. 
:if ''Number'' == -1 - the "your invitation has been submitted" message shows up. 
:if ''Number'' == -2 - the "your invitation rejected" message shows up. 
:if ''Number'' == -3 - the "your invitation was accepted" message shows up. 
:if ''Number'' == -4 - the "your invitation reply has been sent" message shows up.

==Others==
===Complaining===
* "'''complaint''' ''Number''" 
:'''complaint''' shows the complaint vote message to the client. 
:if ''Number'' > 1 - the vote shows up. In this case ''Number'' is the ClientNum of the teamkilling player. 
:if ''Number'' == -1 - the "complaint filed" message shows up. 
:if ''Number'' == -2 - the "complaint dismissed" message shows up.

===Spawning===
* "'''setspawnpt''' ''Number''" 
:'''setspawnpt''' sets the client game selected spawnpoint to number ''number''.

===kicking===
* "'''disconnect''' \"''reason''\"" 
:'''disconnect''' will disconnect the client it has been send with a "Server disconnected" message 
:''reason'' is an optialnal parameter to show a reason after "Server disconnected"

===Configstrings===
* "'''cs''' ''Number'' \"''String''\"" 
: '''cs''' will set the clients configstringnumber ''Number'' to the ''String''

===Shaders===
* "'''remapShader''' \"''OldShader''\" \"''NewShader''\" ''0''" 
: '''remapShader''' remaps the ''OldShader'' whit ''NewShader'' 
: ''0'' is the Timeoffset, i have no idea wut it means so better leave it 0

[[Category:ETPro]]
[[Category:ETPro:Mods]]

Talk:Lua Mod API

2006-01-12T20:49:27Z

=FF=im2good4u:

Talk:Lua Mod API

2006-01-12T20:49:05Z

=FF=im2good4u:

Talk:Lua Mod API

2006-01-09T18:45:43Z

=FF=im2good4u: