Updated the documentation to match the agitcheck() behavior

git-svn-id: https://svn.code.sf.net/p/rathena/svn/trunk@9628 54d463be-8e91-2dee-dedb-b68131a5f0ec
This commit is contained in:
ultramage 2007-01-07 17:42:41 +00:00
parent fbe23f27a2
commit 3433d36c12
2 changed files with 5 additions and 10 deletions

View File

@ -4,6 +4,7 @@ AS OF SVN REV. 5091, WE ARE NOW USING TRUNK. ALL UNTESTED BUGFIXES/FEATURES GO
IF YOU HAVE A WORKING AND TESTED BUGFIX PUT IT INTO STABLE AS WELL AS TRUNK. IF YOU HAVE A WORKING AND TESTED BUGFIX PUT IT INTO STABLE AS WELL AS TRUNK.
2007/01/07 2007/01/07
* Updated the documentation to match the agitcheck() behavior
* Undid the memset->malloc_set replacement * Undid the memset->malloc_set replacement
(let's be compatible and leave such optimizations to system devs, ok?) (let's be compatible and leave such optimizations to system devs, ok?)
* Small reformatting of conf-tmpl * Small reformatting of conf-tmpl

View File

@ -3939,22 +3939,16 @@ These two commands will start and end War of Emperium.
This is a bit more complex than it sounds, since the commands themselves won't This is a bit more complex than it sounds, since the commands themselves won't
actually do anything interesting, except causing all 'OnAgitStart:' and actually do anything interesting, except causing all 'OnAgitStart:' and
'OnAgitEnd:' events to run everywhere, respectively, and setting a so-called 'OnAgitEnd:' events to run everywhere, respectively. They are used as
'agit_flag' which also doesn't do much interesting itself. They are used as
simple triggers to run a lot of complex scripts all across the server, and they, simple triggers to run a lot of complex scripts all across the server, and they,
in turn, are triggered by clock with an 'OnClock<time>:' time-triggering label. in turn, are triggered by clock with an 'OnClock<time>:' time-triggering label.
--------------------------------------- ---------------------------------------
*agitcheck(0) *agitcheck()
*agitcheck 1;
These function and command will let you check whether the server is currently in These function and command will let you check whether the server is currently
the War of Emperium mode. (that is, if 'agit_flag' is set. Even if it is set, in the War of Emperium mode. It will return 1 if WoE is on and 0 if it isn't.
doesn't mean that there's even one map in GVG mode somewhere) Calling
'agitcheck' as a function (the argument must be zero) will return 1 if WoE is on
and 0 if it isn't. Running 'agitcheck' as a command will instead set a local
variable @agit_flag to 1 if the server is in WoE mode and 0 if it isn't.
--------------------------------------- ---------------------------------------