summaryrefslogtreecommitdiff
path: root/doc/script_commands.txt
AgeCommit message (Collapse)AuthorFilesLines
2014-05-13Partial cleanup of script_commands.txtHaru1-548/+529
- Updated examples to a more modern syntax - Corrected examples using the wrong case for script commands (fixes bugreport:8192 thanks to jaBote) http://hercules.ws/board/tracker/issue-8192-camelcase-in-scripting-documentation/ - Reworded or rewritten some misleading/no longer correct notes to match the current script engine behavior. - Marked some commands as deprecated and suggested alternatives, to discourage their use in new scripts (set, goto, jump_zero, menu) - Changed use of temporary character variables into scope variables in examples, where appropriate. Signed-off-by: Haru <haru@dotalux.com>
2014-05-10Small changes in npc loading/reloadingpanikon1-1/+2
Compartmentalized npc file processing Corrected event initalisation order in npc_reload Changed loading order, now item db constants are loaded before npc processing in order to avoid labels overwriting constants values, like Aegis Names Added information regarding reloading scripts in /doc/script_commands.txt
2014-05-09Added documentation regarding trader objects in script_commands.txtpanikon1-0/+38
Added enumered returns to npc_cashshop_buy and to npc_cashshop_buylist
2014-05-07#Fixed issue 8175panikon1-0/+10
*http://hercules.ws/board/tracker/issue-8175-missing-delequip/ *Documentation wrote by @emistry #Added return values for *delequip
2014-05-06Bug fixes and other changespanikon1-2/+3
#Fixed issue where a corrupted map cache would lead to a crash *Moved Big-endian compatibility functions to common/utils.h #Fixed issue 8162 *http://hercules.ws/board/tracker/issue-8162-loadnpc-doesnt-trigger-oninit-of-duplicate-npcs/ *Added options to npc_parse_duplicate #Fixed issue 8169 *http://hercules.ws/board/tracker/issue-8169-script-command-guildskill-skill-idlevel-not-working-as-intended/ *Changed *guildskill behavior, now it behaves exactly as depicted in the documentation *Updated *guildskill documentation #Added missing GBI types to mapif_parse_GuildBasicInfoChange now it's possible to change guild exp, lv, skill point and skill information #GeoIP revamp *GeoIP module was partially rewritten *Added several data checks to prevent corruption and crashes *Updated GeoIP database *See https://github.com/maxmind/geoip-api-c/blob/master/libGeoIP/GeoIP.c for more information #Added packetver checks regarding NST_MARKET *Now *tradertype warns if user is trying to use this feature with older clients
2014-05-05Removed global_reg_value leftovers.Streusel1-5/+2
2014-04-10Fixed issue: 8140panikon1-3/+5
http://hercules.ws/board/tracker/issue-8140-toucan-npc-error-message/ That error usually happens when the player clicked on a NPC that has the view id of a mob, to activate this kind of npc it's needed to be in a 2,2 range from it. If the OnTouch area of a npc, coincides with the 2,2 range of another it's expected that the OnTouch event be put first in stack, because unit_walktoxy_timer is executed before any other function in this case. So it's best practice to put an 'end;' before OnTouch events in npcs that have view ids of mobs to avoid this kind of error. Also updated script_commands.txt to add this recomendation.
2014-04-04Fixed issue: 8131panikon1-0/+4
http://hercules.ws/board/tracker/issue-8131-sc-chat/ -Documented SC_NOCHAT -Corrected the way that pc_setparam was handling SP_MANNER -Added documentation on *sc_status regarding SC_NOCHAT, to mute a user via script you should set Manner
2014-03-31Updated documentation for pc_statusup2 and pc_statusuppanikon1-3/+5
(fixed issue: 7916 http://hercules.ws/board/tracker/issue-7916-wrong-comment-in-pc-statusup2/) Now pc_statusup2 returns stat increase amount as stated in previous documentation Updated *statusup documentation it was wrong Added last update in upgrade index @console.c/.h Documented partially Now two different parsing categories can have functions with same name e.g. - server exit - sql exit
2014-03-21Fix hunting mission and clarify weight's unitAnnieRuru1-0/+7
Fix hunting mission not able to take mission after a character has deleted http://hercules.ws/board/tracker/issue-8104-hunting-missiontxt-delete-character/ Clarify Weight and MaxWeight unit as in 0.1 http://hercules.ws/board/tracker/issue-7836-weight-and-maxweight/
2014-03-20Fix various documentation bugsAnnieRuru1-4/+0
Fix certain type of bonus can actually trigger with weapon skills http://hercules.ws/board/tracker/issue-7897-bug-or-bad-description/ Fix duplicate sample typo http://hercules.ws/board/tracker/issue-4984-wrong-test-duplicate-npc-sample/ skill script command doesn't has type 4 http://hercules.ws/board/tracker/issue-7565-skill-script-command-invalid-flag/
2014-03-17Added regular expression matching script commands and operatorsHaru1-13/+53
- The script command pcre_match and the operator ~= will return the number of regular expression matches in a given string (roughly equivalent to the php function preg_match or the perl operator =~) - The operator ~! is the opposite of ~= (roughly equivalent to the perl operator !~) - See script_commands and npc/custom/test.txt for more information. Signed-off-by: Haru <haru@dotalux.com>
2014-03-14Follow up 1007d606645c16d5246761976b7648809edb8b1dshennetsind1-6/+4
A bonus. Fixed unitwalk's non-x/y possibility, NPCs can now be set to chase players around for as long as they keep walking, which opens a number of possibilities e.g. help npc y get thru z. Signed-off-by: shennetsind <ind@henn.et>
2014-03-13Corrected itemheal documentation, it was fairly wrong.panikon1-6/+15
Added simple overflow check in pc_heal to fix issue: 8082 http://hercules.ws/board/tracker/issue-8082-itemheal-kills-with-high-rand-value/
2014-03-06Clean up of script_commands.txtMysteries1-117/+171
- - Fixed some structuring of the file - - Cleaned up some sentences
2014-02-23Update script_commands.txtEmistry1-2/+3
2014-02-10Modified successrefitem script commandshennetsind1-8/+4
Added a new optional parameter to specify upgrade quantity, so its consistent with downrefitem which provides a optional parameter to specify downgrade quantity. As proposed by kyeme in http://hercules.ws/board/topic/2403-successrefitem/ Signed-off-by: shennetsind <ind@henn.et>
2014-02-10Fixed script docs to reflect actual arrays sizeshennetsind1-1/+1
Thanks to KeyWorld. Signed-off-by: shennetsind <ind@henn.et>
2014-02-08Improvements on the script commands sscanf, axtoi. Added strtol.Haru1-7/+18
- Added script command strtol (conforming to the ISO C90 function) - Modified script command axtoi to internally use strtol instead of an unnecessary own implementation. - Fixed sscanf behavior to conform to the C specifications in case the input string is empty. It now correctly returns -1, or 0 if the format string is also empty. Fixes bugreport:8009, thanks to AnnieRuru - http://hercules.ws/board/tracker/issue-8009-sscanf-should-return-1-if-the-string-field-is-an-empty-string/ Signed-off-by: Haru <haru@dotalux.com>
2014-01-12Follow up 20bdc01fa687b174a732be4483ddea4982d67ce9shennetsind1-0/+8
Fixed scripting deficiency of being unable to tell whether a user is assigned to a specific instance or not ( 20bdc01fa687b174a732be4483ddea4982d67ce9 removed that ability ), because users can be assigned to more than a single instance on hercules, the previous instance_id(<va>) isn't viable, so I'm introducing has_instance2("<map_name>"), returns the instance id of that map for the user (as long as the user is assigned to a instead with that map), -1 upon failure -- valid instance ids are >= 0. Signed-off-by: shennetsind <ind@henn.et>
2014-01-12Updated script_commands.txtshennetsind1-4/+9
- Updated array size info from 127 to the new +4billion - Improved trader type documentation, thanks to emistry for pointing out some deficiencies! Signed-off-by: shennetsind <ind@henn.et>
2013-12-24Christmas Patch - 2013-12-23 Supportshennetsind1-0/+64
Info: http://hercules.ws/board/topic/3614-christmas-patch-gifto/ Signed-off-by: shennetsind <ind@henn.et>
2013-11-28Corrected operator precedence table.Haru1-0/+91
- [ This commit is part of a larger script engine related update ] - Operator precedence rules now closely follow those of languages such as C and derivates/related (C++, Java, PHP, etc.) - Please note that if you had custom scripts with non parenthesized expressions containing bitwise |, &, ^ operators, they may behave incorrectly now (or perhaps they were already behaving incorrectly, since the previous behavior was undocumented). - Added an up to date operator precedence/associativity table in the script documentation. - Added an operator/keyword self-test script in the npc/custom folder, in case if may be of some use for future regression-testing.
2013-11-09Consolidated commands called in scripts to their lowercase versionHaru1-4/+11
- Added a note about variables and command scripts case sensitivity. Even though the engine still accepts variable, function and command names in a case insensitive way, it is discouraged to rely on such behavior. Please update your custom scripts as soon as possible. Signed-off-by: Haru <haru@dotalux.com>
2013-11-06Merge remote-tracking branch 'origin/master'shennetsind1-0/+46
Signed-off-by: shennetsind <ind@henn.et> Conflicts: conf/messages.conf src/common/mmo.h src/map/pc_groups.c src/map/pc_groups.h
2013-11-03Allow warp duplicates without a 'facing' valueHaru1-2/+2
- Warps don't require a facing, so their duplicates shouldn't either. - Credits to jaBote. Signed-off-by: Haru <haru@dotalux.com>
2013-11-02Fixed Shadow System Bonusesshennetsind1-0/+7
Item in shadow slots are now able to give bonuses properly, thanks to rosfus for pointing it out! Also added the missing constants for script handling. Signed-off-by: shennetsind <ind@henn.et>
2013-10-31No error after compilation, but when logging in at map server it will crash.sevenzz231-0/+46
Im pretty sure its on the clif.c Signed-off-by: sevenzz23 <sevenzz23@yahoo.com>
2013-10-25Quest Bubbles Updateshennetsind1-5/+20
- Introduced questinfo cache, memory & processing speed improvement - Fixed mini-map marker support Special Thanks to Haruna Signed-off-by: shennetsind <ind@henn.et>
2013-10-24Quest Bubbles (Actually Works Finally)Kisuka1-18/+52
2013-10-24replacestr documentation fixshennetsind1-1/+1
From c3cedcbf40a5408aafbac960363fe35f1909cbcf Closes #169 Signed-off-by: shennetsind <ind@henn.et>
2013-10-19Instance Dungeons Updateshennetsind1-0/+20
As requested by the community in http://hercules.ws/board/topic/1702-implement-rathena-npc/ we're merging in the latest of rAthena's dungeons, this includes the rewriting of all instance dungeons and the addition of 4 dungeons that were not present previously (BakonawaLake, BangungotHospital, BuwayaCave and OldGlastHeim). Update also includes the ability for instances to reset (or be destroyed if instance files were disabled/removed) upon @reloadscript, instance scripts are able to control to what stage the instances are to be reset via the instance_set_respawn (reload spawn) script command, OnInstanceInit labels are now triggered when the instance starts via instance_init (and upon reload), they may be used alongside instance variables (which are persistent to @reloadscript) to save players' progress. - NPC Changelog: -- npc/instances/EndlessTower.txt --- 2.2 Instance system rewrite. [Euphy] --- 2.3 Added some missing announcements. [Euphy] --- 2.4 Added GM management function. [Euphy] -- npc/instances/NydhoggsNest.txt --- 1.5 Instance system rewrite. [Euphy] --- 1.6 Added GM management NPCs. [Euphy] -- npc/instances/OrcsMemory.txt --- 1.7 Instance system rewrite. [Euphy] -- npc/instances/SealedShrine.txt --- 2.3 Instance system rewrite. [Euphy] -- npc/other/gm_npcs.txt --- 1.0 First version. [Euphy] -- npc/re/instances/BakonawaLake.txt --- 1.0 First version. [Euphy] --- 1.1 Added GM management NPC. [Euphy] -- npc/re/instances/BangungotHospital.txt --- 1.0 First version. [Euphy] --- 1.1 Added GM management function. [Euphy] -- npc/re/instances/BuwayaCave.txt --- 1.0 First version. [Euphy] -- npc/re/instances/HazyForest.txt --- 1.1 Instance system rewrite. [Euphy] -- npc/re/instances/MalangdoCulvert.txt --- 1.0b Fixed incorrect use of 'close'. [Joseph] --- 1.1 Instance system rewrite. [Euphy] -- npc/re/instances/OctopusCave.txt --- 1.1 Instance system rewrite. [Euphy] -- npc/re/instances/OldGlastHeim.txt --- 1.0 First version. [Euphy] Special Thanks to Haru, Uziel for their contributions to this update, and ossi0110 for helping us debug it. Signed-off-by: shennetsind <ind@henn.et>
2013-10-14Added documentation for addmonsterdrop/delmonsterdropHaru1-0/+33
Follow-up to 7ddcff9ae2c45659605c649a0af8bb25539ecade Resolves #191 Signed-off-by: Haru <haru@dotalux.com>
2013-10-11Added missing homun-s quest script command documentationshennetsind1-23/+36
Follow up a2e01e40c9e60b8b2d75e4faf41d80a7041e8f93 Signed-off-by: shennetsind <ind@henn.et>
2013-10-07Added 'consumeitem' as an alias of 'itemeffect'shennetsind1-2/+3
For compatibility purposes, Closes #148 Signed-off-by: shennetsind <ind@henn.et>
2013-10-04downrefitem script command updateshennetsind1-7/+4
Preparation for refiner/hd-ore update; Optional param added, this will allow for the officials 1/3 downgrades as well as for users to customise the value to their liking at script-level. Thanks To Haruna. Signed-off-by: shennetsind <ind@henn.et>
2013-09-16Corrected line endings and BOM issues with several filesHaru1-1/+1
- Ensured final end-of-line character in every file. - Corrected cases of mixed line endings (mostly CR and CRLF within the same file.) - Removed extra BOM from some scripts, since it causes a parsing error. Signed-off-by: Haru <haru@dotalux.com>
2013-08-26Added support for non-fatal error messages from the script parserHaru1-1/+1
- Changed overflow errors to be non-fatal. The value will now be capped to INT_MAX or INT_MIN. - Follow-up to 8351881 Signed-off-by: Haru <haru@dotalux.com>
2013-08-26Added an integer overflow check on literal values in the script parserHaru1-1/+3
- When attempting to use a value greater than INT_MAX or smaller than INT_MIN (about +/- 2 billions), an error message will be shown and script execution will be aborted. - Corrected some scripts that were attempting to use such values. - Fixed some possible issues when using literal negative values in scripts. Thanks to Ind for his help on this issue (figuring it out and fixing it) Signed-off-by: Haru <haru@dotalux.com>
2013-07-19Update script_commands.txtjaBote1-0/+13
Added some neat info Yommy gave us :D
2013-07-14Removed the now unused optional 3rd parameter from removemapflagHaru1-4/+1
- The parameter was only used in combination with MF_RESTRICTED, now superseded by MF_ZONE - Follow-up b08910e8, 90f117f6 Signed-off-by: Haru <haru@dotalux.com>
2013-07-05DB Queue Debug Updateshennetsind1-1/+1
Some documentation update on battlegrounds.conf Fixed Hercules Queue Option constants, they're 1-2-3 not 0-1-2. Some Bugfixes to the test script, special thanks to ossi0110 http://hercules.ws/board/topic/1302-bg-queue-debug Signed-off-by: shennetsind <ind@henn.et>
2013-07-04Implemented sitting set of script commands: sit(), stand(), issit() as per ↵Matheus Macabu1-1/+17
suggested in topic #1204. See documentation for more information on these commands. Also fixed leftover from db_use_sql split. Signed-off-by: Matheus Macabu <mkbu95@gmail.com>
2013-06-23UpdateMysteries1-17/+25
- Fixed some documentation - Fixed some alignment
2013-06-14Whitespace, TABs & SpellingsAkkarinage1-720/+718
Replaced indents using spaces with tabs, reducing file sizes and conforming to standards.
2013-06-13Hercules Renewal Phase : Renewalmalufett1-4/+3
Rename SC names to eagis standard. Implement SC Configuration.(see db/sc_config.txt) Skill updates and fixes. Some code optimization. Signed-off-by: malufett <malufett.eat.my.binaries@gmail.com>
2013-05-31Merge pull request #35 from Akkarinage/masterStreusel1-29/+62
Modified formatting in doc/script_commands.txt
2013-05-31Update script_commands.txtStreusel1-0/+2
Added missing index 11.- Queue commands
2013-05-31Modified formatting in doc/script_commands.txtAkkarinage1-29/+62
2013-05-30Merge pull request #34 from CairoLee/mastershennetsind1-1/+14
Merge checkhomcall Script Command from rAthena