Resource:Webstats: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
No edit summary |
||
Line 1: | Line 1: | ||
Webstats provides Interesting and Exciting™ statistics about your game server! | Webstats provides Interesting and Exciting™ statistics about your game server! | ||
==How to use== | |||
Webstats is accessible via HTTP only. Just start webstats and visit ''<nowiki>http://yourserver:port/</nowiki>'' and click Statistics in the resource browser's side bar. | |||
==Scripters== | |||
Scripts can register your own stats with the resource, just do something like the following: | |||
<syntaxhighlight lang="lua"> | |||
call(getThisResource(), "registerStat", getThisResource(), "getBlipCount", "Blips", "The number of blips") | |||
function getBlipCount() | |||
return #getElementsByType("blip"); | |||
end | |||
</syntaxhighlight> | |||
The syntax for calling ''registerStat'' is: | |||
<syntaxhighlight lang="lua"> | |||
call(getThisResource(), "registerStat", getThisResource(), "yourFunctionName", "Stat name", "Stat description") | |||
</syntaxhighlight> | |||
The function specified will be called every time the stats are updated (by default once a minute). You should return an number value. | |||
Another example. This example counts the amount of damage done between each call to getDamageCount. | |||
<syntaxhighlight lang="lua"> | |||
call(getThisResource(), "registerStat", getThisResource(), "getDamageCount", "Damage Given", "The amount of damage players have taken") | |||
damagecount = 0 | |||
addEventHandler ( "onPlayerDamage", getRootElement(), | |||
function( attacker, attackerweapon, bodypart, loss ) | |||
damagecount = damagecount + loss | |||
end | |||
) | |||
function getDamageCount() | |||
local ret = damagecount; | |||
damagecount = 0; | |||
return ret; | |||
end | |||
</syntaxhighlight> |
Revision as of 19:00, 19 December 2007
Webstats provides Interesting and Exciting™ statistics about your game server!
How to use
Webstats is accessible via HTTP only. Just start webstats and visit http://yourserver:port/ and click Statistics in the resource browser's side bar.
Scripters
Scripts can register your own stats with the resource, just do something like the following:
call(getThisResource(), "registerStat", getThisResource(), "getBlipCount", "Blips", "The number of blips") function getBlipCount() return #getElementsByType("blip"); end
The syntax for calling registerStat is:
call(getThisResource(), "registerStat", getThisResource(), "yourFunctionName", "Stat name", "Stat description")
The function specified will be called every time the stats are updated (by default once a minute). You should return an number value.
Another example. This example counts the amount of damage done between each call to getDamageCount.
call(getThisResource(), "registerStat", getThisResource(), "getDamageCount", "Damage Given", "The amount of damage players have taken") damagecount = 0 addEventHandler ( "onPlayerDamage", getRootElement(), function( attacker, attackerweapon, bodypart, loss ) damagecount = damagecount + loss end ) function getDamageCount() local ret = damagecount; damagecount = 0; return ret; end