summaryrefslogtreecommitdiff
path: root/doc/script_commands.txt
AgeCommit message (Collapse)AuthorFilesLines
2014-10-30Deprecated checkdragon and setdragon commandsHaru1-1/+7
Replaced their use in scripts with checkmount and setmount, respectively. Signed-off-by: Haru <haru@dotalux.com>
2014-10-30Deprecated checkmadogear and setmadogear commandsHaru1-1/+7
Replaced their use in scripts with checkmount and setmount, respectively. Signed-off-by: Haru <haru@dotalux.com>
2014-10-28Marked command 'checkquest' as deprecatedHaru1-1/+7
Use questprogress instead. - Note: The command will be completely removed after about a month. Custom, third party scripts will require updates, in case they were using this command. It is recommended to use questprogress instead. Please see the checkquest documentation for more information. Signed-off-by: Haru <haru@dotalux.com>
2014-10-27Marked the petheal command as deprecatedHaru1-3/+10
- The command should be replaced by petskillsupport in any custom scripts. - Updated the custom SOHEE pet skill script to use petskillsupport with level 10 AL_HEAL. Signed-off-by: Haru <haru@dotalux.com>
2014-10-27Marked command jump_zero as deprecated.Haru1-8/+16
- Added prefixed version for internal use. - Note: The command will be completely removed after about a month. Custom, third party scripts will require updates, in case they were using this command. Please see the jump_zero documentation. Signed-off-by: Haru <haru@dotalux.com>
2014-10-24Re-commit of 4ac673941714032ada6d26fb60936ec510bbe496 (part 3)Taylor Locke1-0/+55
Some Quality of Life Changes - setdragon, setmadogear and setriding deprecated; use setmount instead. - checkdragon, checkmadogear, checkriding deprecated; use checkmount instead. Signed-off-by: Haru <haru@dotalux.com>
2014-10-24Renamed ismounting, setmounting, @mount2Haru1-3/+3
To avoid ambiguity: - The script command ismounting is now hascashmount - The script command setmounting is now setcashmount - The at-command @mount2 is now @cashmount Signed-off-by: Haru <haru@dotalux.com>
2014-10-24Restored ability to differentiate between active and inactive questsHaru1-0/+9
- Added the questactive script command. - While this information may not be needed by official scripts, it was offered by the now deprecated checkquest, and as such it is made available again. Signed-off-by: Haru <haru@dotalux.com>
2014-10-24Re-commit of 4ac673941714032ada6d26fb60936ec510bbe496 (part 2)Taylor Locke1-2/+29
Some Quality of Life Changes - checkquest deprecated; Use questprogress instead for a more logical quest log checking command. Signed-off-by: Haru <haru@dotalux.com>
2014-10-24Re-commit of 4ac673941714032ada6d26fb60936ec510bbe496 (part 1)Taylor Locke1-0/+7
Some Quality of Life Changes - getbrokencount command added to get amount of broken equipment. Signed-off-by: Haru <haru@dotalux.com>
2014-10-23Improved bindatcmd handling of spaces in parameters.Haru1-5/+53
- Parameters passed to bindatcmd-invoked labels are now properly space-delimited. - This is in order to support strings containing multiple spaces or containing a trailing space. Previously it was impossible to create a bindatcmd command that could accept a player name such as 'This name has two spaces' or 'Sir Trailingspace '. - Added documentation and usage examples, especially wrt space handling. See doc/script_commands.txt for details. - NOTE: Your custom atcommand labels may need edits, as we're no longer trimming multiple sequantial spaces or trailing spaces, in order to gain more flexibility. It is your care to do that. - Special thanks to Dastgir, jaBote. Signed-off-by: Haru <haru@dotalux.com>
2014-10-18Revert "Some Quality of Life Changes"Haru1-70/+9
- This reverts commit 4ac673941714032ada6d26fb60936ec510bbe496. - The commit breaks some legacy code. It'll be pushed again once some things are fixed. Signed-off-by: Haru <haru@dotalux.com>
2014-10-18Some Quality of Life ChangesTaylor Locke1-9/+70
checkquest deprecated; Use questprogress instead for a more logical quest log checking command. getbrokencount command added to get amount of broken equipment. setdragon and setmadogear deprecated; use setriding instead. setriding now handles all combat mounts.
2014-09-20Replaced hardcoded values with constants for status_change_start's flagHaru1-4/+6
- Please use the values from enum scstart_flag when calling status_change_start or related functions. - This also applies to the sc_start script commands. Signed-off-by: Haru <haru@dotalux.com>
2014-09-03Add *getguildmember script commandAnnieRuru1-0/+32
its so frustrating that rathena already having this for month, but we don't have =/ https://github.com/rathena/rathena/commit/eba1539
2014-09-01Add MAX_REFINE as hard-coded constantAnnieRuru1-0/+1
MAX_REFINE has different value for renewal(20) and non-renewal(10) and some server even adjust this value so its better to add this constant so there's no need to add a configuration when making custom refiner scripts
2014-08-31follow upAnnieRuru1-37/+44
https://github.com/HerculesWS/Hercules/commit/a06e53479131c25ce2343c431c688c57b3bfa2c0 to mimic the *sc_start documentation to rathena and fixed return 0; into return true; thx to Litro for bringing up http://hercules.ws/board/topic/6997-debug-whats-wrong/
2014-08-29Fix status def calculation (bug:8306)Michieru1-3/+3
Updated script command 'sc_start' to allow for more variables and options rAthena 17326 (bug:8217) Fix Cart Tornado damage to official elemental crashing/memory error (thanks to Ind)
2014-07-11Fixed issue with quest exp and bonuses, issue: 8247 ↵panikon1-6/+4
http://hercules.ws/board/index.php?app=tracker&showissue=8247 Corrected *getexp documentation Documented and changed pc_gainexp type
2014-07-08Added documentation regarding hard coded constants.panikon1-17/+36
Updated *strcharinfo documentation in order to follow 1a477c4a628decb330b8083bbd4625ffae26c709
2014-06-07Fixed Bug Report 8226jaBote1-1/+1
Just reflecting correct behavior of addtimercount script command, which expects the parameters in the reverse order the documentation formerly said.
2014-06-01Update script_commands.txtjaBote1-5/+5
Fixed documentation errors: -> Strings are always delimited by double quotes ("), not single qotes('); -> Errors on optional parameters of monster and areamonster script commands; -> Also fixed curlies for optional parameters in sprintf and sscanf.
2014-05-19Fixed issue 8182panikon1-1/+1
http://hercules.ws/board/tracker/issue-8182-cloaking-on-ice-wall/ Fixed minor typo on script_commands
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>