Configstring: Difference between revisions
Jump to navigation
Jump to search
general info about configstrings |
added lua example |
||
| Line 1: | Line 1: | ||
__NOEDITSECTION__ | __NOEDITSECTION__ | ||
Configstrings can be accessed with [[Lua_Mod_API#configstrings|et.trap_GetConfigstring and et.trap_SetConfigstring]] and the [[Lua_Mod_API#string_utility_functions|String utility functions]] | Configstrings can be accessed with <code>[[Lua_Mod_API#configstrings|et.trap_GetConfigstring]]</code> and <code>[[Lua_Mod_API#configstrings|et.trap_SetConfigstring]]</code> and the [[Lua_Mod_API#string_utility_functions|String utility functions]]. | ||
==What are Configstrings== | ==What are Configstrings== | ||
* Configstrings are strings that are set on the server, and automatically sent to each client. | * Configstrings are strings that are set on the server, and automatically sent to each client. | ||
| Line 13: | Line 14: | ||
A user Configstring gets written in the log file with a line starting with ''UserInfoChanged'' which mustn't be mistaken for one with ''Userinfo''. | A user Configstring gets written in the log file with a line starting with ''UserInfoChanged'' which mustn't be mistaken for one with ''Userinfo''. | ||
To access a user's Configstring you can't just use et.trap_GetConfigstring(slotNumber) but must use et.trap_GetConfigstring(et.CS_PLAYERS + slotNumber) | To access a user's Configstring you can't just use <code>et.trap_GetConfigstring(slotNumber)</code> but must use <code>et.trap_GetConfigstring(et.CS_PLAYERS + slotNumber)</code>. | ||
<pitatable columns=3 headlines="key;name;description" widths="40;220;450" headerfontcolor="#FFFFFF"> | <pitatable columns=3 headlines="key;name;description" widths="40;220;450" headerfontcolor="#FFFFFF"> | ||
| Line 33: | Line 34: | ||
</pitatable> | </pitatable> | ||
== Notes == | ==LUA Example== | ||
et.CS_PLAYERS = 689 for those of you that don't use etconst.lua | et.CS_PLAYERS = <span style="color: darkblue;">689</span> | ||
<span style="color: green;">-- get the name of client #3 using configstrings</span> | |||
<span style="color: darkred;">local</span> cs = et.trap_GetConfigstring(et.CS_PLAYERS + <span style="color: darkblue;">3</span>) | |||
<span style="color: darkred;">local</span> name = et.Info_ValueForKey(cs, <span style="color: darkblue;">"n"</span>) | |||
==Notes== | |||
<code>et.CS_PLAYERS = 689</code> for those of you that don't use [[User:ReyalP|etconst.lua]]. | |||
Source: http://bani.anime.net/banimod/forums/viewtopic.php?t=5412 | <small>Source: http://bani.anime.net/banimod/forums/viewtopic.php?t=5412</small> | ||
[[Category:ETPro]] | [[Category:ETPro]] | ||
[[Category:Lua]] | [[Category:Lua]] | ||
[[Category:ETPro:Mods]] | [[Category:ETPro:Mods]] | ||
Revision as of 13:51, 14 November 2006
Configstrings can be accessed with et.trap_GetConfigstring and et.trap_SetConfigstring and the String utility functions.
What are Configstrings
- Configstrings are strings that are set on the server, and automatically sent to each client.
- Configstrings are often, but not always, in the from of an infostring (a backslash delimited set of key\value pairs)
- Each configstring is identified by a number, which is usually given refered to by a name #defined in the ET gamecode.
- A group of related configstrings (such as CS_PLAYERS) usually only have a symbolic name for the first value, with a number (entity number in the case of CS_PLAYERS) added to to get a particular value.
- Most configstrings have a specific meaning to the gamecode. You can use the etmain SDK find out what they do, but beware that etpro does not do things exactly the same as etmain.
- A list of configstring numbers and names can be found in etconst.lua
User Configstring
A user Configstring gets written in the log file with a line starting with UserInfoChanged which mustn't be mistaken for one with Userinfo.
To access a user's Configstring you can't just use et.trap_GetConfigstring(slotNumber) but must use et.trap_GetConfigstring(et.CS_PLAYERS + slotNumber).
|
LUA Example
et.CS_PLAYERS = 689 -- get the name of client #3 using configstrings local cs = et.trap_GetConfigstring(et.CS_PLAYERS + 3) local name = et.Info_ValueForKey(cs, "n")
Notes
et.CS_PLAYERS = 689 for those of you that don't use etconst.lua.
Source: http://bani.anime.net/banimod/forums/viewtopic.php?t=5412