User talk:ReyalP

2005-11-17T14:29:14Z

Rookie One: OMG OMG OMG im2good4u SPELLING!!!

in your etconst it says at top : <code>-- [23:10] <|Rain|> 2 became CS_ETPRO_INFO instead of CS_MUSIC, because I needed the version info before any more configstrings were parsed
-- [23:10] <|Rain|> and CS_MUSIC moved up to 53<code> but u still got CS_MUSIC at 2 --2good

:yup. Since I had no idea what you'd do with either of those config strings, I just left things as I got them found them in the etmain sdk. [[User:ReyalP|ReyalP]]

three [[User:ReyalP|ReyalP]] or [[User:ReyalP|ReyalP]] 13:25, 16 November 2005 (PST) four ?

thats nice but oh well ok i dont care i dont use it myself its a lityle this i made out of my debuglib that was a print function that works like a printf you add variables and dont care but it is since it will check each variable first [[User:=FF=im2good4u|=FF=Im2good4u]] 13:45, 16 November 2005 (PST)

Talk:Fieldname

2005-11-17T14:26:30Z

Rookie One:

someone feel free to make this table pretty.

Roger that. --Rookie One 03:31, 13 November 2005 (PST)

// Comment by Deus 13:22, 13 November 2005 (CET)
I liked the former one more.
I thought about some colorisation like red for readonly and green for r/w. maybe some mouseover stuff, or just the one tr light the next darker, to have a better viewability ?
// End of Deus Comment

Alright, I'll restore the previous borders and add some colour. --Rookie One 04:33, 13 November 2005 (PST)

That was just my suggestion. Maybe this differs from banis view of beautification :) --Deus 04:46, 13 November 2005 (PST)

== use of color...bad! ==

use of color to convey specific data (ro/rw) is bad. red/green is the worst possible choice too :) 
consider someone who is colorblind. check the article via http://colorfilter.wickline.org/ to see how bad this is.
but it looks bad even for those who aren't color blind :P

Yeah, reyalP, I also thought it's weird to initialize the table like that, but wasn't sure. ;) --Rookie One 06:26, 17 November 2005 (PST)

Lua Mod API

2005-11-16T21:22:41Z

Rookie One: Corrected misleading info. ;)

__NOEDITSECTION__
<div align="center" style="background: #FFFFCC; padding: 2px; border: 2px solid #000000;">The latest version of the lua-enabled ETPro qagame is etpro-lua-4 and can be downloaded [http://etpro.anime.net/etpro-lua-4.zip here].</div>

ETPro now supports serverside mods via the [http://www.lua.org/ lua] scripting language.

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

==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|et_ConsoleCommand function]]. 
'''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'''
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''', '''command''' )
:Sends the command '''command''' to the client '''clientnum'''. If '''clientnum''' is -1, the '''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'''.
 

===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.
'''keyvalue''' = et.Info_ValueForKey( '''infostring''', '''key''' )
:Returns the value of the key '''key''' in the infostring '''infostring'''
'''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.
 

===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.
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 
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).
'''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]].
'''intercepted''' = et_ClientSay( '''clientNum''', '''mode''', '''text''' )
:Called when a client sends a chat command. '''clientNum''' is the client slot id. '''mode''' is the chat mode (see et.SAY_* constants). '''text''' is the chat text. 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)
 

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

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

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

User talk:Rookie One

2005-11-16T21:21:19Z

Rookie One:

User talk:Rookie One

2005-11-16T21:12:26Z

Rookie One:

User talk:=FF=im2good4u

2005-11-16T20:51:03Z

Rookie One:

Lua Mod API

2005-11-16T20:41:50Z

Rookie One:

__NOEDITSECTION__
<div align="center" style="background: #FFFFCC; padding: 2px; border: 2px solid #000000;">The latest version of the lua-enabled ETPro qagame is etpro-lua-3 and can be downloaded [http://etpro.anime.net/etpro-lua-3.zip here].</div>

ETPro now supports serverside mods via the [http://www.lua.org/ lua] scripting language.

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

==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'''
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''', '''command''' )
:Sends the command '''command''' to the client '''clientnum'''. If '''clientnum''' is -1, the '''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'''.
 

===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.
'''keyvalue''' = et.Info_ValueForKey( '''infostring''', '''key''' )
:Returns the value of the key '''key''' in the infostring '''infostring'''
'''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.
 

===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.
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 
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''' )
: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]].
'''intercepted''' = et_ClientSay( '''clientNum''', '''mode''', '''text''' )
:Called when a client sends a chat command. '''clientNum''' is the client slot id. '''mode''' is the chat mode (see et.SAY_* constants). '''text''' is the chat text. 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)
:Note that this command '''does not''' use the [[#argument_handling|argument handling]] functions.
 

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

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

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

Lua Mod API

2005-11-16T20:40:29Z

Rookie One: Fixed an error with ClientCommand and added an explanation of argument handling in ClientCommand and ConsoleCommand.

__NOEDITSECTION__
<div align="center" style="background: #FFFFCC; padding: 2px; border: 2px solid #000000;">The latest version of the lua-enabled ETPro qagame is etpro-lua-3 and can be downloaded [http://etpro.anime.net/etpro-lua-3.zip here].</div>

ETPro now supports serverside mods via the [http://www.lua.org/ lua] scripting language.

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

==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'''
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''', '''command''' )
:Sends the command '''command''' to the client '''clientnum'''. If '''clientnum''' is -1, the '''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'''.
 

===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.
'''keyvalue''' = et.Info_ValueForKey( '''infostring''', '''key''' )
:Returns the value of the key '''key''' in the infostring '''infostring'''
'''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.
 

===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.
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 
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''' )
: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]].
'''intercepted''' = et_ClientSay( '''clientNum''', '''mode''', '''text''' )
:Called when a client sends a chat command. '''clientNum''' is the client slot id. '''mode''' is the chat mode (see et.SAY_* constants). '''text''' is the chat text. 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)
 

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

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

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

Fieldname

2005-11-16T13:45:43Z

Rookie One: Vec3_t is not an array of vectors, it is one. Rewrote the vec3_t explanation. And OMG! 2good you really need to work on your spelling.

List of fields supported by et.gentity_get() and et.gentity_set() 
<table border=1>
<td>
<table border=0>
<tr bgcolor=#555555><th>field</th><th>type</th><th>access</th></tr>
<tr bgcolor='white'><td align=left>activator</td><td align=center>entity</td><td align=center>RO </td></tr>
<tr bgcolor='lightgrey'><td align=left>chain</td><td align=center>entity</td><td align=center>RW </td></tr>
<tr bgcolor='white'><td align=left>classname</td><td align=center>string</td><td align=center>RW </td></tr>
<tr bgcolor='lightgrey'><td align=left>closespeed</td><td align=center>float</td><td align=center>RW </td></tr>
<tr bgcolor='white'><td align=left>count</td><td align=center>integer</td><td align=center>RW </td></tr>
<tr bgcolor='lightgrey'><td align=left>count2</td><td align=center>integer</td><td align=center>RW </td></tr>
<tr bgcolor='white'><td align=left>damage</td><td align=center>integer</td><td align=center>RW </td></tr>
<tr bgcolor='lightgrey'><td align=left>deathType</td><td align=center>integer</td><td align=center>RW </td></tr>
<tr bgcolor='white'><td align=left>delay</td><td align=center>float</td><td align=center>RW </td></tr>
<tr bgcolor='lightgrey'><td align=left>dl_atten</td><td align=center>integer</td><td align=center>RW </td></tr>
<tr bgcolor='white'><td align=left>dl_color</td><td align=center>vec3</td><td align=center>RW </td></tr>
<tr bgcolor='lightgrey'><td align=left>dl_shader</td><td align=center>string</td><td align=center>RO </td></tr>
<tr bgcolor='white'><td align=left>dl_stylestring</td><td align=center>string</td><td align=center>RO </td></tr>
<tr bgcolor='lightgrey'><td align=left>duration</td><td align=center>float</td><td align=center>RW </td></tr>
<tr bgcolor='white'><td align=left>end_size</td><td align=center>integer</td><td align=center>RW </td></tr>
<tr bgcolor='lightgrey'><td align=left>enemy</td><td align=center>entity</td><td align=center>RW </td></tr>
<tr bgcolor='white'><td align=left>flags</td><td align=center>integer</td><td align=center>RO </td></tr>
<tr bgcolor='lightgrey'><td align=left>harc</td><td align=center>float</td><td align=center>RW </td></tr>
<tr bgcolor='white'><td align=left>health</td><td align=center>integer</td><td align=center>RW </td></tr>
<tr bgcolor='lightgrey'><td align=left>inuse</td><td align=center>boolean</td><td align=center>RO </td></tr>
<tr bgcolor='white'><td align=left>isProp</td><td align=center>boolean</td><td align=center>RO </td></tr>
<tr bgcolor='lightgrey'><td align=left>item</td><td align=center>string</td><td align=center>RW </td></tr>
<tr bgcolor='white'><td align=left>key</td><td align=center>integer</td><td align=center>RW </td></tr>
<tr bgcolor='lightgrey'><td align=left>message</td><td align=center>string</td><td align=center>RW </td></tr>
<tr bgcolor='white'><td align=left>methodOfDeath</td><td align=center>integer</td><td align=center>RW </td></tr>
<tr bgcolor='lightgrey'><td align=left>mg42BaseEnt</td><td align=center>integer</td><td align=center>RW </td></tr>
<tr bgcolor='white'><td align=left>missionLevel</td><td align=center>integer</td><td align=center>RW </td></tr>
<tr bgcolor='lightgrey'><td align=left>model</td><td align=center>string</td><td align=center>RO </td></tr>
<tr bgcolor='white'><td align=left>model2</td><td align=center>string</td><td align=center>RO </td></tr>
<tr bgcolor='lightgrey'><td align=left>nextTrain</td><td align=center>entity</td><td align=center>RW </td></tr>
<tr bgcolor='white'><td align=left>noise_index</td><td align=center>integer</td><td align=center>RW </td></tr>
<tr bgcolor='lightgrey'><td align=left>origin</td><td align=center>vec3</td><td align=center>RW </td></tr>
<tr bgcolor='white'><td align=left>prevTrain</td><td align=center>entity</td><td align=center>RW </td></tr>
<tr bgcolor='lightgrey'><td align=left>props_frame_state</td><td align=center>integer</td><td align=center>RO </td></tr>
<tr bgcolor='white'><td align=left>r.absmax</td><td align=center>vec3</td><td align=center>RO </td></tr>
<tr bgcolor='lightgrey'><td align=left>r.absmin</td><td align=center>vec3</td><td align=center>RO </td></tr>
<tr bgcolor='white'><td align=left>r.bmodel</td><td align=center>boolean</td><td align=center>RO </td></tr>
<tr bgcolor='lightgrey'><td align=left>r.contents</td><td align=center>integer</td><td align=center>RW </td></tr>
<tr bgcolor='white'><td align=left>r.currentAngles</td><td align=center>vec3</td><td align=center>RW </td></tr>
<tr bgcolor='lightgrey'><td align=left>r.currentOrigin</td><td align=center>vec3</td><td align=center>RW </td></tr>
<tr bgcolor='white'><td align=left>r.eventTime</td><td align=center>integer</td><td align=center>RW </td></tr>
<tr bgcolor='lightgrey'><td align=left>r.linkcount</td><td align=center>integer</td><td align=center>RO </td></tr>
<tr bgcolor='white'><td align=left>r.linked</td><td align=center>boolean</td><td align=center>RO </td></tr>
<tr bgcolor='lightgrey'><td align=left>r.maxs</td><td align=center>vec3</td><td align=center>RW </td></tr>
<tr bgcolor='white'><td align=left>r.mins</td><td align=center>vec3</td><td align=center>RW </td></tr>
<tr bgcolor='lightgrey'><td align=left>r.ownerNum</td><td align=center>integer</td><td align=center>RW </td></tr>
<tr bgcolor='white'><td align=left>r.singleClient</td><td align=center>integer</td><td align=center>RW </td></tr>
<tr bgcolor='lightgrey'><td align=left>r.svFlags</td><td align=center>integer</td><td align=center>RW </td></tr>
<tr bgcolor='white'><td align=left>r.worldflags</td><td align=center>integer</td><td align=center>RO </td></tr>
<tr bgcolor='lightgrey'><td align=left>radius</td><td align=center>integer</td><td align=center>RW </td></tr>
<tr bgcolor='white'><td align=left>random</td><td align=center>float</td><td align=center>RW </td></tr>
<tr bgcolor='lightgrey'><td align=left>rotate</td><td align=center>vec3</td><td align=center>RW </td></tr>
<tr bgcolor='white'><td align=left>s.angles</td><td align=center>vec3</td><td align=center>RW </td></tr>
<tr bgcolor='lightgrey'><td align=left>s.angles2</td><td align=center>vec3</td><td align=center>RW </td></tr>
<tr bgcolor='white'><td align=left>s.apos</td><td align=center>trajectory</td><td align=center>RW </td></tr>
<tr bgcolor='lightgrey'><td align=left>s.clientNum</td><td align=center>integer</td><td align=center>RW </td></tr>
<tr bgcolor='white'><td align=left>s.constantLight</td><td align=center>integer</td><td align=center>RW </td></tr>
<tr bgcolor='lightgrey'><td align=left>s.density</td><td align=center>integer</td><td align=center>RW </td></tr>
<tr bgcolor='white'><td align=left>s.dl_intensity</td><td align=center>integer</td><td align=center>RW </td></tr>
<tr bgcolor='lightgrey'><td align=left>s.dmgFlags</td><td align=center>integer</td><td align=center>RW </td></tr>
<tr bgcolor='white'><td align=left>s.eFlags</td><td align=center>integer</td><td align=center>RW </td></tr>
<tr bgcolor='lightgrey'><td align=left>s.effect1Time</td><td align=center>integer</td><td align=center>RW </td></tr>
<tr bgcolor='white'><td align=left>s.effect2Time</td><td align=center>integer</td><td align=center>RW </td></tr>
<tr bgcolor='lightgrey'><td align=left>s.effect3Time</td><td align=center>integer</td><td align=center>RW </td></tr>
<tr bgcolor='white'><td align=left>s.frame</td><td align=center>integer</td><td align=center>RW </td></tr>
<tr bgcolor='lightgrey'><td align=left>s.groundEntityNum</td><td align=center>integer</td><td align=center>RO </td></tr>
<tr bgcolor='white'><td align=left>s.loopSound</td><td align=center>integer</td><td align=center>RW </td></tr>
<tr bgcolor='lightgrey'><td align=left>s.modelindex</td><td align=center>integer</td><td align=center>RW </td></tr>
<tr bgcolor='white'><td align=left>s.modelindex2</td><td align=center>integer</td><td align=center>RW </td></tr>
<tr bgcolor='lightgrey'><td align=left>s.number</td><td align=center>integer</td><td align=center>RO </td></tr>
<tr bgcolor='white'><td align=left>s.onFireEnd</td><td align=center>integer</td><td align=center>RW </td></tr>
<tr bgcolor='lightgrey'><td align=left>s.onFireStart</td><td align=center>integer</td><td align=center>RW </td></tr>
<tr bgcolor='white'><td align=left>s.pos</td><td align=center>trajectory</td><td align=center>RW </td></tr>
<tr bgcolor='lightgrey'><td align=left>s.powerups</td><td align=center>integer</td><td align=center>RO </td></tr>
<tr bgcolor='white'><td align=left>s.solid</td><td align=center>integer</td><td align=center>RW </td></tr>
<tr bgcolor='lightgrey'><td align=left>s.teamNum</td><td align=center>integer</td><td align=center>RW </td></tr>
<tr bgcolor='white'><td align=left>s.time</td><td align=center>integer</td><td align=center>RW </td></tr>
<tr bgcolor='lightgrey'><td align=left>s.time2</td><td align=center>integer</td><td align=center>RW </td></tr>
<tr bgcolor='white'><td align=left>s.weapon</td><td align=center>integer</td><td align=center>RO </td></tr>
<tr bgcolor='lightgrey'><td align=left>scriptName</td><td align=center>string</td><td align=center>RO </td></tr>
<tr bgcolor='white'><td align=left>sess.damage_given</td><td align=center>integer</td><td align=center>RO </td></tr>
<tr bgcolor='lightgrey'><td align=left>sess.damage_received</td><td align=center>integer</td><td align=center>RO </td></tr>
<tr bgcolor='white'><td align=left>sess.deaths</td><td align=center>integer</td><td align=center>RO </td></tr>
<tr bgcolor='lightgrey'><td align=left>sess.game_points</td><td align=center>integer</td><td align=center>RO </td></tr>
<tr bgcolor='white'><td align=left>sess.gibs</td><td align=center>integer</td><td align=center>RO </td></tr>
<tr bgcolor='lightgrey'><td align=left>sess.kills</td><td align=center>integer</td><td align=center>RO </td></tr>
<tr bgcolor='white'><td align=left>sess.muted</td><td align=center>integer</td><td align=center>RO </td></tr>
<tr bgcolor='lightgrey'><td align=left>sess.referee</td><td align=center>integer</td><td align=center>RO </td></tr>
<tr bgcolor='white'><td align=left>sess.rounds</td><td align=center>integer</td><td align=center>RO </td></tr>
<tr bgcolor='lightgrey'><td align=left>sess.semiadmin</td><td align=center>integer</td><td align=center>RO</td></tr>
<tr bgcolor='white'><td align=left>sess.spec_invite</td><td align=center>integer</td><td align=center>RO </td></tr>
<tr bgcolor='lightgrey'><td align=left>sess.spec_team</td><td align=center>integer</td><td align=center>RO </td></tr>
<tr bgcolor='white'><td align=left>sess.suicides</td><td align=center>integer</td><td align=center>RO </td></tr>
<tr bgcolor='lightgrey'><td align=left>sess.team_damage</td><td align=center>integer</td><td align=center>RO </td></tr>
<tr bgcolor='white'><td align=left>sess.team_kills</td><td align=center>integer</td><td align=center>RO </td></tr>
<tr bgcolor='lightgrey'><td align=left>sess.team_received</td><td align=center>integer</td><td align=center>RO </td></tr>
<tr bgcolor='white'><td align=left>spawnflags</td><td align=center>integer</td><td align=center>RO </td></tr>
<tr bgcolor='lightgrey'><td align=left>spawnitem</td><td align=center>string</td><td align=center>RO </td></tr>
<tr bgcolor='white'><td align=left>speed</td><td align=center>float</td><td align=center>RW </td></tr>
<tr bgcolor='lightgrey'><td align=left>splashDamage</td><td align=center>integer</td><td align=center>RW </td></tr>
<tr bgcolor='white'><td align=left>splashMethodOfDeath</td><td align=center>integer</td><td align=center>RW </td></tr>
<tr bgcolor='lightgrey'><td align=left>splashRadius</td><td align=center>integer</td><td align=center>RW </td></tr>
<tr bgcolor='white'><td align=left>start_size</td><td align=center>integer</td><td align=center>RW </td></tr>
<tr bgcolor='lightgrey'><td align=left>tagName</td><td align=center>string</td><td align=center>RO </td></tr>
<tr bgcolor='white'><td align=left>tagParent</td><td align=center>entity</td><td align=center>RW </td></tr>
<tr bgcolor='lightgrey'><td align=left>takedamage</td><td align=center>boolean</td><td align=center>RW </td></tr>
<tr bgcolor='white'><td align=left>tankLink</td><td align=center>entity</td><td align=center>RW </td></tr>
<tr bgcolor='lightgrey'><td align=left>target</td><td align=center>string</td><td align=center>RW </td></tr>
<tr bgcolor='white'><td align=left>TargetAngles</td><td align=center>vec3</td><td align=center>RW </td></tr>
<tr bgcolor='lightgrey'><td align=left>TargetFlag</td><td align=center>integer</td><td align=center>RO </td></tr>
<tr bgcolor='white'><td align=left>targetname</td><td align=center>string</td><td align=center>RO </td></tr>
<tr bgcolor='lightgrey'><td align=left>teamchain</td><td align=center>entity</td><td align=center>RW </td></tr>
<tr bgcolor='white'><td align=left>teammaster</td><td align=center>entity</td><td align=center>RW </td></tr>
<tr bgcolor='lightgrey'><td align=left>track</td><td align=center>string</td><td align=center>RO </td></tr>
<tr bgcolor='white'><td align=left>varc</td><td align=center>float</td><td align=center>RW </td></tr>
<tr bgcolor='lightgrey'><td align=left>wait</td><td align=center>float</td><td align=center>RW </td></tr>
<tr bgcolor='white'><td align=left>waterlevel</td><td align=center>integer</td><td align=center>RO </td></tr>
<tr bgcolor='lightgrey'><td align=left>watertype</td><td align=center>integer</td><td align=center>RO </td></tr>
</table>
</td>
</table>

'''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 a table containing 3 numbers. It can be accessed by
doing:
<pre>tablevar = {}
tablevar = et.gentity_get() --a vec3 value
x = tablevar[1]
y = tablevar[2]
z = tablevar[3]</pre>

[[Category:ETPro]]

User talk:Rookie One

2005-11-15T20:03:48Z

Rookie One:

2005-11-15T18:47:01Z

Rookie One:

2005-11-13T16:48:28Z

Rookie One:

== For Maps In Production ==

A ''target_location'' is a non-brush entity that allows a mapper to specify a name for a certain area of the map. Unless a player has configured their client to do otherwise, these names will be used instead of map coordinates in both the fireteam box and teammate chat messages.

Using these entities will cause a warning to be displayed on the server console for every entity in the map during map load on etmain, shrub, and etpub (although etpub is actively developed, and this may change in the future.) The map will still run, unaffected, though. To use them with GtkRadiant, first make a file called ''et_entities_location.def'' in the scripts directory of your mapping install. Then, open the file in notepad and paste the following in the file, and then save.

===Target_location entity===
<pre>
/*QUAKED target_location (0 0.5 0) (-8 -8 -8) (8 8 8)
Set "message" to the name of this location.

The message can contain colorcodes, default color is ^3(yellow)

Closest target_location in sight used for the location, if none
in site, closest in distance, within PVS
*/
</pre>

This will allow you to place a ''target_location'' into your map within GtkRadiant, which will appear as a small green box. When selected, give it a key called ''message'' with a value that is the name you want at that location. You only need to place ''target_location''s so that you can always see one; placing too many may be a waste of resources.

== For Completed Maps ==

Note: This method is slightly less efficient than using actual target_locations.

''target_location''s on exisitng maps are saved into an external file named ''maps/'''(mapname)'''_loc.dat''. They are generally located outside of a .pk3, but this is not a requirement. If a file named ''maps/'''(mapname)'''_loc_override.dat'' exists, it will be read instead — this allows individual players or clans to override or add locations, even if the map or a .pk3 contains a location file.

etpro has the following commands to aid the addition of ''target_location''s to a map:

===loc_commands===

'''loc_add <name>'''
:Adds a new target_location at your current position named <name>.

'''loc_del'''
:Deletes the nearest target_location (the one that you are currently "in".)

'''loc_move'''
:Moves the nearest target_location to your current position.

'''loc_rename <name>'''
:Renames the nearest target_location to <name>.

'''loc_show'''
:Shows the name and origin of the nearest target_location in the console.

'''loc_save'''
:Saves all target_locations to a file named ''maps/'''(mapname)'''_loc_override.dat''

'''loc_load'''
:Reloads all target_locations from a file named ''maps/'''(mapname)'''_loc_override.dat''

==Viewing locations==

While adding locations to your map you are able to monitor your changes. This can be enabled using a cvar.

'''b_debuglocations''' (default: 0) - Bitmask to enable debugging/design aids for location names. Works with external .dats as well as target_location ents. The following values can be added together:
* 1 - Draw a bubble sprite at each location marker. The nearest location is drawn in green, with all the others being drawn in red.
*2 - Add a dynamic light at each location marker. The nearest location is lit in red, with all the others being lit in green.
*4 - Draw floating text at each location marker containing the location's name. The nearest location is colored green instead of white.
*8 - Send updates to other players when a location is added, deleted, or renamed. This function allows multiple people to cooperatively edit locations in a level.
*16 - Accept updates to locations from other players who are using b_debuglocations 8.
 
[[Category:ETPro]][[Category:ETPro:Mapping]]

2005-11-13T16:09:19Z

Rookie One: Just thought this might come in handy.

{{selfref|The title of this article is incorrect due to [http://en.wikipedia.org/wiki/Wikipedia:Naming_conventions_%28technical_restrictions%29 technical restrictions]. The correct title is'' '''{{{title|{{{1}}}}}}'''.}}