WolfWiki - User contributions [en]

User:Vetinari

2007-02-24T16:47:43Z

Vetinari: /* ETPub / NoQuarter style say substitutions */ forgot player class

== Reviving Spree Lua ==

"reviving sprees" in the style of etadmin_mod's killing sprees: [http://ankh-morp.org/~vetinari/projects/rspree/ rspree_mod]

(I know this page is broken with IE, I'm not going to fix it ;-))

== Serverside dynamite timer ==
[http://svn.ankh-morp.org:8080/etpro_mods/dynatimer/dynamite.lua dynamite.lua]

This is a server side dynamite timer script. The messages will be sent to all clients who enabled the messages. The default of sending / not sending the timer messages are set by the server admin, see the ''cl_default'' setting in the script.

A client can set it's default (on/off) by setting ''+setu v_dynatimer 1'' or ''+setu v_dynatimer 0'' as command line argument for et ... or with the ''\setu v_dynatimer 1/0'' command... but that will not (de-)activate immediately

Timers can be enabled for the current connection with the client command ''\dynatimer 1'' or disabled with ''\dynatimer 0''.

== ETPub / NoQuarter style say substitutions ==
[http://svn.ankh-morp.org:8080/etpro_mods/shortcuts/etpub_printf.lua etpub_printf.lua]

The etpub and NoQuarter mods have a shortcuts replacement feature. Some keys inside square brackets ("[]") are replaced by values. This script does the same for etpro. Supported commands are ''say'', ''say_team'', ''say_buddy'', ''say_teamnl'', ''vsay'' and ''vsay_team''. See below for some examples.

Known keys in etpub/nq are:

* '''[a]''' last player who gave you ammo, currently not working, just returns '''*unknown*'''
* '''[d]''' last player who killed you
* '''[h]''' last player who gave you health currently not working, just returns '''*unknown*'''
* '''[k]''' last player you killed
* '''[l]''' your location (letter,number) currently not really working, [[Talk:Lua_Mod_API#Locations|feature request]] for etpro filed :-)
Currently it just returns the world coords in map units
* '''[n]''' your name
* '''[r]''' last player who revived you
* '''[p]''' last player you looked at, not working, probably never will ...
* '''[s]''' health remaining
* '''[w]''' name of current weapon
* '''[t]''' ammo for current weapon

We added the following keys:

* '''[m]''' name of the last player who was revived by you
* '''[c]''' your current player class
* '''[x]''' health of last killer (don't ask me why "x"... I just took this from the first version of this script :-))

Both health replacements ("s" and "x") will return "0" if your the health value is below that, i.e. you will not know if a player is gibbed or just waiting for a revive.

=== Examples: ===

To test this simply do a say on the server:

\vsay_team Medic "Need a medic, ^1[s]^5 health left!"
result: Global voice sound: I need a medic and a custom text: "Need a medic, 15 health left!"

bind x "vsay negative Stop killing me, [d]"
result: Global voice sound: Negative/No, and a custom text: "Stop killing me, [!!!]Harlekin"

bind x "vsay_team thanks Thanks for the Team-Kill, [d]!"
result: Team voice sound: Thanks, and a custom text: "Thanks for the Team-Kill, [!!!]Harlekin!"

Thanks to [!!!]Harlekin and bennz. [[User:Bennz|Bennz]] did the first version of this script, which I rewrote completely ;-). He also helped debugging.

[[Category:ETPro:Mods]]

User:Vetinari

2007-02-24T11:23:44Z

Vetinari: /* ETPub / NoQuarter style say substitutions */ correct internal link

== Reviving Spree Lua ==

"reviving sprees" in the style of etadmin_mod's killing sprees: [http://ankh-morp.org/~vetinari/projects/rspree/ rspree_mod]

(I know this page is broken with IE, I'm not going to fix it ;-))

== Serverside dynamite timer ==
[http://svn.ankh-morp.org:8080/etpro_mods/dynatimer/dynamite.lua dynamite.lua]

This is a server side dynamite timer script. The messages will be sent to all clients who enabled the messages. The default of sending / not sending the timer messages are set by the server admin, see the ''cl_default'' setting in the script.

A client can set it's default (on/off) by setting ''+setu v_dynatimer 1'' or ''+setu v_dynatimer 0'' as command line argument for et ... or with the ''\setu v_dynatimer 1/0'' command... but that will not (de-)activate immediately

Timers can be enabled for the current connection with the client command ''\dynatimer 1'' or disabled with ''\dynatimer 0''.

== ETPub / NoQuarter style say substitutions ==
[http://svn.ankh-morp.org:8080/etpro_mods/shortcuts/etpub_printf.lua etpub_printf.lua]

The etpub and NoQuarter mods have a shortcuts replacement feature. Some keys inside square brackets ("[]") are replaced by values. This script does the same for etpro. Supported commands are ''say'', ''say_team'', ''say_buddy'', ''say_teamnl'', ''vsay'' and ''vsay_team''. See below for some examples.

Known keys in etpub/nq are:

* '''[a]''' last player who gave you ammo, currently not working, just returns '''*unknown*'''
* '''[d]''' last player who killed you
* '''[h]''' last player who gave you health currently not working, just returns '''*unknown*'''
* '''[k]''' last player you killed
* '''[l]''' your location (letter,number) currently not really working, [[Talk:Lua_Mod_API#Locations|feature request]] for etpro filed :-)
Currently it just returns the world coords in map units
* '''[n]''' your name
* '''[r]''' last player who revived you
* '''[p]''' last player you looked at, not working, probably never will ...
* '''[s]''' health remaining
* '''[w]''' name of current weapon
* '''[t]''' ammo for current weapon

We added the following keys:

* '''[m]''' name of the last player who was revived by you
* '''[x]''' health of last killer (don't ask me why "x"... I just took this from the first version of this script :-))

Both health replacements ("s" and "x") will return "0" if your the health value is below that, i.e. you will not know if a player is gibbed or just waiting for a revive.

=== Examples: ===

To test this simply do a say on the server:

\vsay_team Medic "Need a medic, ^1[s]^5 health left!"
result: Global voice sound: I need a medic and a custom text: "Need a medic, 15 health left!"

bind x "vsay negative Stop killing me, [d]"
result: Global voice sound: Negative/No, and a custom text: "Stop killing me, [!!!]Harlekin"

bind x "vsay_team thanks Thanks for the Team-Kill, [d]!"
result: Team voice sound: Thanks, and a custom text: "Thanks for the Team-Kill, [!!!]Harlekin!"

Thanks to [!!!]Harlekin and bennz. [[User:Bennz|Bennz]] did the first version of this script, which I rewrote completely ;-). He also helped debugging.

[[Category:ETPro:Mods]]

User:Vetinari

2007-02-24T11:22:18Z

Vetinari: "readme" for dynatimer, added etpub_printf.lua w/ readme

== Reviving Spree Lua ==

"reviving sprees" in the style of etadmin_mod's killing sprees: [http://ankh-morp.org/~vetinari/projects/rspree/ rspree_mod]

(I know this page is broken with IE, I'm not going to fix it ;-))

== Serverside dynamite timer ==
[http://svn.ankh-morp.org:8080/etpro_mods/dynatimer/dynamite.lua dynamite.lua]

This is a server side dynamite timer script. The messages will be sent to all clients who enabled the messages. The default of sending / not sending the timer messages are set by the server admin, see the ''cl_default'' setting in the script.

A client can set it's default (on/off) by setting ''+setu v_dynatimer 1'' or ''+setu v_dynatimer 0'' as command line argument for et ... or with the ''\setu v_dynatimer 1/0'' command... but that will not (de-)activate immediately

Timers can be enabled for the current connection with the client command ''\dynatimer 1'' or disabled with ''\dynatimer 0''.

== ETPub / NoQuarter style say substitutions ==
[http://svn.ankh-morp.org:8080/etpro_mods/shortcuts/etpub_printf.lua etpub_printf.lua]

The etpub and NoQuarter mods have a shortcuts replacement feature. Some keys inside square brackets ("[]") are replaced by values. This script does the same for etpro. Supported commands are ''say'', ''say_team'', ''say_buddy'', ''say_teamnl'', ''vsay'' and ''vsay_team''. See below for some examples.

Known keys in etpub/nq are:

* '''[a]''' last player who gave you ammo, currently not working, just returns '''*unknown*'''
* '''[d]''' last player who killed you
* '''[h]''' last player who gave you health currently not working, just returns '''*unknown*'''
* '''[k]''' last player you killed
* '''[l]''' your location (letter,number) currently not really working, [[http://wolfwiki.anime.net/index.php/Talk:Lua_Mod_API#Locations feature request]] for etpro filed :-)
Currently it just returns the world coords in map units
* '''[n]''' your name
* '''[r]''' last player who revived you
* '''[p]''' last player you looked at, not working, probably never will ...
* '''[s]''' health remaining
* '''[w]''' name of current weapon
* '''[t]''' ammo for current weapon

We added the following keys:

* '''[m]''' name of the last player who was revived by you
* '''[x]''' health of last killer (don't ask me why "x"... I just took this from the first version of this script :-))

Both health replacements ("s" and "x") will return "0" if your the health value is below that, i.e. you will not know if a player is gibbed or just waiting for a revive.

=== Examples: ===

To test this simply do a say on the server:

\vsay_team Medic "Need a medic, ^1[s]^5 health left!"
result: Global voice sound: I need a medic and a custom text: "Need a medic, 15 health left!"

bind x "vsay negative Stop killing me, [d]"
result: Global voice sound: Negative/No, and a custom text: "Stop killing me, [!!!]Harlekin"

bind x "vsay_team thanks Thanks for the Team-Kill, [d]!"
result: Team voice sound: Thanks, and a custom text: "Thanks for the Team-Kill, [!!!]Harlekin!"

Thanks to [!!!]Harlekin and bennz. [[User:Bennz|Bennz]] did the first version of this script, which I rewrote completely ;-). He also helped debugging.

[[Category:ETPro:Mods]]

Talk:Lua Mod API

2007-02-23T17:57:24Z

Vetinari: Q about et_ClientSay() -> et.G_Say()

please call et_Obituary() and et_Print() at the end of the engine function because we can do better output then. example: the engine output (ETPlayer killed himself.) is after the lua output (Hahaha! ETPlayer seems to be a selfkill noob!). thx!! --[[User:Pdi|pdi]] 09:13, 26 December 2006 (PST)
:It is called at the beginning of the function so lua mods can override obituary and print entirely if they want. I can make a separate lua hook which is called at the end of the function, eg et_ObituaryPost and et_PrintPost. [[User:Bani|Bani]] 11:52, 3 January 2007 (PST)
::Ok, this sounds good to me! Big THX!! :) Please have also a look at field section of this page! ;) --[[User:Pdi|pdi]] 05:41, 4 January 2007 (PST)

Can we have a intercepted version of '''et_ClientUserinfoChanged()''' to return '''1''' to intercept it with a mod and return '''0''' to pass it through to the server? THX!! --[[User:Pdi|pdi]] 00:54, 7 February 2007 (PST)
:I don't understand what you want here. You should already be able to call trap_SetUserinfo from et_ClientUserinfoChanged if you want to modify the values. --[[User:ReyalP|ReyalP]] 19:00, 8 February 2007 (PST)
::I found another way to do that. Sorry, but didn't need that anymore. --[[User:Pdi|pdi]] 12:16, 9 February 2007 (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)

== Fields for the next release ==
I think Kotoko wants the '''ps.velocity''' field here. It would be a good idea, I think. --[[User:FARMICEUDICAL|FARMICEUDICAL]] 20:23, 5 December 2006 (PST)

bani: RW access to all "sess.*" fields (sess.skillpoints, sess.startskillpoints, sess.startxptotal, ...) would be great. thanx! --[[User:Pdi|pdi]] 05:55, 2 August 2006 (PDT)

bani: please make all "pers.*" fields (pers.clientTimeNudge, pers.clientMaxPackets, ...) available. thanx! --[[User:Pdi|pdi]] 01:04, 17 August 2006 (PDT)
:you can get timenudge and maxpackets from the userinfo --[[User:ReyalP|ReyalP]] 20:19, 18 August 2006 (PDT)
::i know, but i ask for all pers.* fields. pers.clientTimeNudge and pers.clientMaxPackets are only examples. :) --[[User:Pdi|pdi]] 01:56, 21 August 2006 (PDT)

bani: will we have rw access to those fields (all sess.* and all pers.*) with next update? please!! --[[User:Pdi|pdi]] 07:02, 19 October 2006 (PDT)
: we are not going to add all the fields. A lot of them don't make sense for lua mods. Explain which ones you need --[[User:ReyalP|ReyalP]] 20:57, 5 February 2007 (PST)
::Ok, didn't know why i'm asking for (long time ago) but fields for xp/skill (sess.skillpoints array - if i remember) control would be great. THX!! --[[User:Pdi|pdi]] 00:54, 7 February 2007 (PST)

'''ps.weapon''', so arbitrary weapons can be added to or removed from arbitrary classes. For example, trickjump servers don't like Field Ops spamming airstrikes or artillery, but they do appreciate the ammo they give out. --[[User:FARMICEUDICAL|FARMICEUDICAL]] 21:09, 5 December 2006 (PST)
: ps.weapon won't do that for you. ps.weapon'''s''' might :) --[[User:ReyalP|ReyalP]] 17:14, 6 December 2006 (PST)

Okay then, '''ps.weapon''' so that medics can be set to spawn with the adrenaline needle out instead of the smg. --[[User:FARMICEUDICAL|FARMICEUDICAL]] 03:23, 11 December 2006 (PST)

Please give read access to '''g_campaignInfo_t''' in a field like '''campaignInfo'''. Thx!! --[[User:Pdi|pdi]] 08:57, 7 January 2007 (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 control not just skill ==

I would like to request RW access to the "sess.skillpoints" array

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

== Locations ==
[22:08:57] <Vetinari> [NW]reyalP: if you're exposing map coords, it would
be nice to have something like et.PostitionName( et.gentity_get(id, "r.currentOrigin"))
<-- location name or map coords "(B, 3)", so I don't have to parse the _loc.dat ;->

== et_ClientSay ? ==
err.. what's this:
-- 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))

This should be
return et.G_Say( clientNum, et.SAY_ALL, et.ConcatArgs(1))
?

Talk:Lua Mod API

2007-02-19T21:13:17Z

Vetinari: Location withlist ;)

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)

please call et_Obituary() and et_Print() at the end of the engine function because we can do better output then. example: the engine output (ETPlayer killed himself.) is after the lua output (Hahaha! ETPlayer seems to be a selfkill noob!). thx!! --[[User:Pdi|pdi]] 09:13, 26 December 2006 (PST)
:It is called at the beginning of the function so lua mods can override obituary and print entirely if they want. I can make a separate lua hook which is called at the end of the function, eg et_ObituaryPost and et_PrintPost. [[User:Bani|Bani]] 11:52, 3 January 2007 (PST)
::Ok, this sounds good to me! Big THX!! :) Please have also a look at field section of this page! ;) --[[User:Pdi|pdi]] 05:41, 4 January 2007 (PST)

Can we have a intercepted version of '''et_ClientUserinfoChanged()''' to return '''1''' to intercept it with a mod and return '''0''' to pass it through to the server? THX!! --[[User:Pdi|pdi]] 00:54, 7 February 2007 (PST)
:I don't understand what you want here. You should already be able to call trap_SetUserinfo from et_ClientUserinfoChanged if you want to modify the values. --[[User:ReyalP|ReyalP]] 19:00, 8 February 2007 (PST)
::I found another way to do that. Sorry, but didn't need that anymore. --[[User:Pdi|pdi]] 12:16, 9 February 2007 (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)

== Fields for the next release ==
I think Kotoko wants the '''ps.velocity''' field here. It would be a good idea, I think. --[[User:FARMICEUDICAL|FARMICEUDICAL]] 20:23, 5 December 2006 (PST)

bani: RW access to all "sess.*" fields (sess.skillpoints, sess.startskillpoints, sess.startxptotal, ...) would be great. thanx! --[[User:Pdi|pdi]] 05:55, 2 August 2006 (PDT)

bani: please make all "pers.*" fields (pers.clientTimeNudge, pers.clientMaxPackets, ...) available. thanx! --[[User:Pdi|pdi]] 01:04, 17 August 2006 (PDT)
:you can get timenudge and maxpackets from the userinfo --[[User:ReyalP|ReyalP]] 20:19, 18 August 2006 (PDT)
::i know, but i ask for all pers.* fields. pers.clientTimeNudge and pers.clientMaxPackets are only examples. :) --[[User:Pdi|pdi]] 01:56, 21 August 2006 (PDT)

bani: will we have rw access to those fields (all sess.* and all pers.*) with next update? please!! --[[User:Pdi|pdi]] 07:02, 19 October 2006 (PDT)
: we are not going to add all the fields. A lot of them don't make sense for lua mods. Explain which ones you need --[[User:ReyalP|ReyalP]] 20:57, 5 February 2007 (PST)
::Ok, didn't know why i'm asking for (long time ago) but fields for xp/skill (sess.skillpoints array - if i remember) control would be great. THX!! --[[User:Pdi|pdi]] 00:54, 7 February 2007 (PST)

'''ps.weapon''', so arbitrary weapons can be added to or removed from arbitrary classes. For example, trickjump servers don't like Field Ops spamming airstrikes or artillery, but they do appreciate the ammo they give out. --[[User:FARMICEUDICAL|FARMICEUDICAL]] 21:09, 5 December 2006 (PST)
: ps.weapon won't do that for you. ps.weapon'''s''' might :) --[[User:ReyalP|ReyalP]] 17:14, 6 December 2006 (PST)

Okay then, '''ps.weapon''' so that medics can be set to spawn with the adrenaline needle out instead of the smg. --[[User:FARMICEUDICAL|FARMICEUDICAL]] 03:23, 11 December 2006 (PST)

Please give read access to '''g_campaignInfo_t''' in a field like '''campaignInfo'''. Thx!! --[[User:Pdi|pdi]] 08:57, 7 January 2007 (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 control not just skill ==

I would like to request RW access to the "sess.skillpoints" array

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

== Locations ==
[22:08:57] <Vetinari> [NW]reyalP: if you're exposing map coords, it would
be nice to have something like et.PostitionName( et.gentity_get(id, "r.currentOrigin"))
<-- location name or map coords "(B, 3)", so I don't have to parse the _loc.dat ;->

Lua Mod API

2007-02-13T08:13:48Z

Vetinari: added link to Lua:IPC

__NOEDITSECTION__
[[ETPro]] now supports server-side 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. It also provides an "et" library of function calls for Lua that allow access to the server engine, and provides callbacks so a server side 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.7 os] (available features vary depending on your OS), [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 tutorial about ETPro Lua scripting can be found [[Lua Tutorials|here]].

API requests can be discussed at the [[Talk:Lua_Mod_API|Lua Mod API talk page]].

==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. See the [[Lua:IPC|Lua IPC]] page for a simple example.
 

===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 an 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_SetPlayerSkill( '''cno''', '''skill''' )
:Called when clients (on slot '''cno''') skill level '''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 reload my lua file without restarting the whole server? 
A: Use ''map_restart'', ''reset_match'' or simply change the map.

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

Q: Is there a list of [[ETPro]] Lua 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: That's 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:Lua]]

ETPro:Lua IPC

2007-02-13T08:07:24Z

Vetinari: ETPro:Lua IPC moved to Lua:IPC: Lua:IPC is a better place

#redirect [[Lua:IPC]]

Lua:IPC

2007-02-13T08:07:24Z

Vetinari: ETPro:Lua IPC moved to Lua:IPC

= Lua: IPC - Communication between Scripts =
If you have several scripts, which access the same data, you can have one script, which manages this data and one or more scripts reading (or writing) this data.

For communication between these scripts, use the [[Lua_Mod_API#modules|et.IPCSend()]] and [[Lua_Mod_API#miscellaneous_2|et_IPCReceive( )]] functions. You cannot receive some data and send it back in the same (server) frame. These example scripts illustrate how to pass requests and the answers back and forth.

The '''ipcdemo-admin.lua''' script must be loaded first (i.e. earlier in the [[Lua_Mod_API#lua_modules|lua_modules]] cvar) otherwise the '''ipcdemo-cmd.lua''' cannot find it.

== ipcdemo-admin.lua ==
-- ipcdemo-admin.lua
local IPCQueue = {}
local AdminGUIDs = {
-- name, guid, level
{ "Vetinari", "ABCDEF1234567890ABCDEF1234567890", 5 },
{ "Havelock", "1234567890ABCDEF1234567890ABCDEF", 3 }
}
 
function et_InitGame(levelTime, randomSeed, restart)
et.RegisterModname("ipcdemo-admin.lua")
end
 
function et_IPCReceive(vm, msg)
local level
local junk1, junk2, id = string.find(msg, "IsAdmin:%s+(%d+)")
if id ~= nil then
id = tonumber(id)
guid = et.Info_ValueForKey(et.trap_GetUserinfo(id), "cl_guid")
level = table.foreach(AdminGUIDs,
function(i, admin)
if admin[2] == guid then
return(admin[3])
end
end
)
if level == nil then
level = 0
end
table.insert(IPCQueue, { vm, level, id })
end
end
 
function et_RunFrame(lvltime)
table.foreach(IPCQueue,
function(i, queue)
local ok = et.IPCSend(queue[1],
string.format("IsAdmin: %d %d", queue[2], queue[3]))
if ok ~= 1 then
local mod, cksum = et.FindMod(queue[1])
et.G_Print(string.format("ipcdemo-admin: IPCSend to %s (vm: %d) failed", mod, queue[1]))
end
end
)
IPCQueue = {}
end

== ipcdemo-cmd.lua ==
-- ipcdemo-cmd.lua
local admin_vm = -1
local CommandQueue = {}
 
function et_InitGame(levelTime, randomSeed, restart)
local mod = ""
local sig = ""
local i = 1
while mod ~= nil do
mod, sig = et.FindMod(i)
if string.find(mod, "^ipcdemo-admin.lua") == 1 then
admin_vm = i
mod = nil
end
i = i + 1
end
if admin_vm == -1 then
et.G_Print("ipcdemo-cmd.lua: Could not find vm number for ipcdemo-admin.lua")
end
et.RegisterModname("ipcdemo-cmd.lua")
end
 
function et_IPCReceive(vm, msg)
if vm == admin_vm then
local junk1,junk2,level,id = string.find(msg, "IsAdmin:%s+(%d+)%s+(%d)")
if level ~= nil and id ~= nil then
runAction(tonumber(id), tonumber(level))
end
end
end
 
function runAction(id, level)
local done = table.foreach(CommandQueue,
function(i, queue)
if id == queue[1] then
if queue[2] <= level then
if queue[4] == nil then
et.trap_SendConsoleCommand(et.EXEC_INSERT, queue[3])
else
et.trap_SendConsoleCommand(et.EXEC_INSERT,
string.format("%s %s", queue[3], queue[4]))
end
end
return(i)
end
end
)
if done ~= nil then
table.remove(CommandQueue, done)
end
end
 
function et_ClientCommand(id, command)
local arg0 = et.trap_Argv(0)
local arg1 = et.trap_Argv(1)
if arg0 == "say" then
if arg1 == "!axis" then
-- id, lvl, cmd, argument
queueCommand(id, 4, "forceteam r", id)
elseif arg1 == "!allies" then
queueCommand(id, 4, "forceteam b", id)
elseif arg1 == "!shuffle" then
queueCommand(id, 3, "shuffleteamsxp_norestart", nil)
end
end
return(0)
end
 
function queueCommand(id, level, cmd, argument)
if admin_vm ~= -1 then
local ok = et.IPCSend(admin_vm, string.format("IsAdmin: %d", id))
if ok ~= 1 then
et.G_Print("ipcdemo-cmd: IPCSend to ipcdemo-admin failed")
else
table.insert(CommandQueue, { id, level, cmd, argument })
end
end
end

Lua:IPC

2007-02-11T12:01:20Z

Vetinari: new page, IPC demos

= Lua: IPC - Communication between Scripts =
If you have several scripts, which access the same data, you can have one script, which manages this data and one or more scripts reading (or writing) this data.

For communication between these scripts, use the [[Lua_Mod_API#modules|et.IPCSend()]] and [[Lua_Mod_API#miscellaneous_2|et_IPCReceive( )]] functions. You cannot receive some data and send it back in the same (server) frame. These example scripts illustrate how to pass requests and the answers back and forth.

The '''ipcdemo-admin.lua''' script must be loaded first (i.e. earlier in the [[Lua_Mod_API#lua_modules|lua_modules]] cvar, else the '''ipcdemo-cmd.lua''' cannot find it.

== ipcdemo-admin.lua ==
-- ipcdemo-admin.lua
local IPCQueue = {}
local AdminGUIDs = {
-- name, guid, level
{ "Vetinari", "ABCDEF1234567890ABCDEF1234567890", 5 },
{ "Havelock", "1234567890ABCDEF1234567890ABCDEF", 3 }
}
 
function et_InitGame(levelTime, randomSeed, restart)
et.RegisterModname("ipcdemo-admin.lua")
end
 
function et_IPCReceive(vm, msg)
local level
local junk1, junk2, id = string.find(msg, "IsAdmin:%s+(%d+)")
if id ~= nil then
id = tonumber(id)
guid = et.Info_ValueForKey(et.trap_GetUserinfo(id), "cl_guid")
level = table.foreach(AdminGUIDs,
function(i, admin)
if admin[2] == guid then
return(admin[3])
end
end
)
if level == nil then
level = 0
end
table.insert(IPCQueue, { vm, level, id })
end
end
 
function et_RunFrame(lvltime)
table.foreach(IPCQueue,
function(i, queue)
local ok = et.IPCSend(queue[1],
string.format("IsAdmin: %d %d", queue[2], queue[3]))
if ok ~= 1 then
local mod, cksum = et.FindMod(queue[1])
et.G_Print(string.format("ipcdemo-admin: IPCSend to %s (vm: %d) failed", mod, queue[1]))
end
end
)
IPCQueue = {}
end

== ipcdemo-cmd.lua ==
-- ipcdemo-cmd.lua
local admin_vm = -1
local CommandQueue = {}
 
function et_InitGame(levelTime, randomSeed, restart)
local mod = ""
local sig = ""
local i = 1
while mod ~= nil do
mod, sig = et.FindMod(i)
if string.find(mod, "^ipcdemo-admin.lua") == 1 then
admin_vm = i
mod = nil
end
i = i + 1
end
if admin_vm == -1 then
et.G_Print("ipcdemo-cmd.lua: Could not find vm number for ipcdemo-admin.lua")
end
et.RegisterModname("ipcdemo-cmd.lua")
end
 
function et_IPCReceive(vm, msg)
if vm == admin_vm then
local junk1,junk2,level,id = string.find(msg, "IsAdmin:%s+(%d+)%s+(%d)")
if level ~= nil and id ~= nil then
runAction(tonumber(id), tonumber(level))
end
end
end
 
function runAction(id, level)
local done = table.foreach(CommandQueue,
function(i, queue)
if id == queue[1] then
if queue[2] <= level then
if queue[4] == nil then
et.trap_SendConsoleCommand(et.EXEC_INSERT, queue[3])
else
et.trap_SendConsoleCommand(et.EXEC_INSERT,
string.format("%s %s", queue[3], queue[4]))
end
end
return(i)
end
end
)
if done ~= nil then
table.remove(CommandQueue, done)
end
end
 
function et_ClientCommand(id, command)
local arg0 = et.trap_Argv(0)
local arg1 = et.trap_Argv(1)
if arg0 == "say" then
if arg1 == "!axis" then
-- id, lvl, cmd, argument
queueCommand(id, 4, "forceteam r", id)
elseif arg1 == "!allies" then
queueCommand(id, 4, "forceteam b", id)
elseif arg1 == "!shuffle" then
queueCommand(id, 3, "shuffleteamsxp_norestart", nil)
end
end
return(0)
end
 
function queueCommand(id, level, cmd, argument)
if admin_vm ~= -1 then
local ok = et.IPCSend(admin_vm, string.format("IsAdmin: %d", id))
if ok ~= 1 then
et.G_Print("ipcdemo-cmd: IPCSend to ipcdemo-admin failed")
else
table.insert(CommandQueue, { id, level, cmd, argument })
end
end
end

User:Vetinari

2007-02-10T21:33:38Z

Vetinari: added dynamite.lua

SendServerCommand

2007-02-09T20:40:05Z

Vetinari: Vsay-Number moved to right position in vtchat

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

==Printing==
===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'' ''X-Location'' ''Y-Location'' ''Z-Location'' ''Vsay-Number'' \"''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'' ''X-Location'' ''Y-Location'' ''Z-Location'' ''Vsay-Number'' \"''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 optional 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''\" ''#''" 
: '''remapShader''' replaces any texture ''OldShader'' with ''NewShader'' 
: ''#'' is the Timeoffset, which currently should be left as ''0''.

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

User:Vetinari

2007-02-04T16:04:03Z

Vetinari:

User:Vetinari

2007-02-04T10:20:28Z

Vetinari: