Configstring: Difference between revisions

From WolfWiki
Jump to navigation Jump to search
ref key
Techno (talk | contribs)
No edit summary
Line 9: Line 9:
* 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.
* 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.
* 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 [http://www.collectivecomputing.com/~reed/et/lua/etconst.lua etconst.lua]
* A list of configstring numbers and names can be found in [http://www.sonic.net/~rfm/et/lua/etconst.lua etconst.lua]


==User Configstring==
==User Configstring==
Line 17: Line 17:


<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">
n;Nick;
n;Nick;Player nickname
t;Team;1=Axis, 2=Allies, 3=Spectators
t;Team;1=Axis, 2=Allies, 3=Spectators
c;Class;0=Soldier, 1=Medic, 2=Engineer, 3=FieldOps, 4=CovertOps
c;Class;0=Soldier, 1=Medic, 2=Engineer, 3=FieldOps, 4=CovertOps
r;Rank;
r;Rank;0-10
m;Medals;
m;Medals;0-7
s;Skills;
s;Skills;0-4
dn;Disguised name;
dn;Disguised name;
dr;Disguised rank;
dr;Disguised rank;
w;Weapon
w;Weapon;3=MP40, 5=Panzerfaust, 6=Flamethrower, 8=Thomson 10=Sten, 23=Engineer K43, 24=Engineer M1 Garand, 25=Covert Ops M1 Garand, 31=Mobile MG42, 32=Covert Ops K43 33=FG42, 35=Mortar
lw;Latched weapon;Weapon on next spawn
lw;Latched weapon;Weapon on next spawn
sw;Latched secondary weapon;Secondary weapon on next spawn
sw;Latched secondary weapon;Secondary weapon on next spawn
ref;Referee;Referee status (0=not ref, 1=ref)
ref;Referee;Referee status (0=not ref, 1=ref)
p;Privilege level;0=Peon, referee (vote), referee (password), semiadmin, rconauth - etpro only
p;Privilege level;0=Peon, referee (vote), referee (password), semiadmin, rconauth - etpro only
ss;Stat Saver; Stats restored by stat saver;etpro only
ss;Stat Saver; Stats have been restored by stat saver, etpro only (0=No, 1=Yes)
sc;Shoutcaster;etpro only
sc;Shoutcaster;etpro only (0=No, 1=Yes)
tv;ETTV slave;etpro only
tv;ETTV slave;etpro only (0=No, 1=Yes)
</pitatable>
</pitatable>



Revision as of 08:26, 14 August 2009


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

keynamedescription
nNickPlayer nickname
tTeam1=Axis, 2=Allies, 3=Spectators
cClass0=Soldier, 1=Medic, 2=Engineer, 3=FieldOps, 4=CovertOps
rRank0-10
mMedals0-7
sSkills0-4
dnDisguised name 
drDisguised rank 
wWeapon3=MP40, 5=Panzerfaust, 6=Flamethrower, 8=Thomson 10=Sten, 23=Engineer K43, 24=Engineer M1 Garand, 25=Covert Ops M1 Garand, 31=Mobile MG42, 32=Covert Ops K43 33=FG42, 35=Mortar
lwLatched weaponWeapon on next spawn
swLatched secondary weaponSecondary weapon on next spawn
refRefereeReferee status (0=not ref, 1=ref)
pPrivilege level0=Peon, referee (vote), referee (password), semiadmin, rconauth - etpro only
ssStat Saver Stats have been restored by stat saver, etpro only (0=No, 1=Yes)
scShoutcasteretpro only (0=No, 1=Yes)
tvETTV slaveetpro only (0=No, 1=Yes)


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