summaryrefslogtreecommitdiff
path: root/doc/script_commands.txt
AgeCommit message (Collapse)AuthorFilesLines
2016-08-29*strnpcinfo now uses constantsAsheraf1-8/+8
- NPC_NAME for the whole npc name including hidden part - NPC_NAME_VISIBLE for the visible part of the npc name - NPC_NAME_HIDDEN for the hidden part of the npc name - NPC_NAME_UNIQUE for the npc unique name - NPC_MAP for npc map
2016-08-21Syntax clean up in the script documentationHaru1-1652/+1680
- Changed all function calls to encourage parenthesized calls - Replaced numbers with constants where appropriate - Removed some incorrect remarks Signed-off-by: Haru <haru@dotalux.com>
2016-08-20Updated references to the old config in the documentationHaru1-32/+37
Signed-off-by: Haru <haru@dotalux.com>
2016-07-21Remove duplicate entry for getnameditem function on script commands ↵Reid1-19/+0
documentation.
2016-06-25Added mesf() command (combination of mes() and sprintf())Haru1-0/+17
Signed-off-by: Haru <haru@dotalux.com>
2016-06-25Removed the uncommon (and useless) multi-argument variant of mes()Haru1-9/+1
Signed-off-by: Haru <haru@dotalux.com>
2016-06-25Re-implemented BUILDIN(sprintf)Haru1-4/+69
- The function now checks its arguments, rather than passing them to the system implementation (safer against arbitrary memory access or wrong variable type) - Implemented positional ('%1$d') specifiers (POSIX style) - See script_commands.txt for details about the supported format specifiers. Signed-off-by: Haru <haru@dotalux.com>
2016-04-11Fix a typo in script_commands.txt,Reid1-1/+1
getskillv -> getskilllv.
2016-02-29Added gender-related constants SEX_MALE/SEX_FEMALEEmistry1-3/+6
2016-01-16Remove VAR_ constantsAnnieRuru1-2/+2
- there are 2 same constants for setlook script command, remove the wrong one - VAR_ constant added by lone_wolf is invalid https://github.com/HerculesWS/Hercules/commit/f4278f36db32f35e535a0ea8feb1cf83ca95019e, so use the LOOK_ constant
2016-01-13Converted const.txt to libconfig formatHaru1-40/+43
- This is necessary for upcoming improvements Signed-off-by: Haru <haru@dotalux.com>
2016-01-05Add *swap script commandAnnieRuru1-0/+13
- extremely useful when writing algorithm functions Closes #1012 as merged Signed-off-by: Haru <haru@dotalux.com>
2015-12-31Replaced leftover -1 view IDs with FAKE_NPCHaru1-8/+8
Signed-off-by: Haru <haru@dotalux.com>
2015-12-26Add *setgroupid script commands.Emistry1-0/+8
Useful for scripts that temporary adjust the group id of players.
2015-12-22Throw error when variable name length too longAnnieRuru1-1/+2
2015-12-22Update *dispbottom script command to allow 0xRRGGBB colorAnnieRuru1-3/+4
Closes #858 as merged Signed-off-by: Haru <haru@dotalux.com>
2015-12-22Update *message script command to allow to use account IDAnnieRuru1-2/+3
Signed-off-by: Haru <haru@dotalux.com>
2015-12-20*explode return array size.Emistry1-2/+4
http://herc.ws/board/topic/7489-explode-to-push-arraysize/ Closes #700 as merged Signed-off-by: Haru <haru@dotalux.com>
2015-12-20Add color constants for announcement and mesAnnieRuru1-6/+13
Added F_MesColor helper function Closes #897 as merged Signed-off-by: Haru <haru@dotalux.com>
2015-12-18Add *getunittype and update *getmapxyAnnieRuru1-20/+38
- unlike rathena, hercules' getunittype use the value from getmapxy - getmapxy now can search object position using GID Closes #871 as merged Signed-off-by: Haru <haru@dotalux.com>
2015-12-18*Fix the misleading label name lengthAnnieRuru1-6/+4
2015-12-18*Correct the wrong example for *queueoptAnnieRuru1-1/+1
2015-12-18Fix documentation error for autobonus trigger rateAnnieRuru1-1/+1
- closes #883 - closes #886 as merged
2015-12-06Fix some documentations on doc/script_commands.txtAnnieRuru1-5/+10
- fix bg_monster_set_team example broken - fix bg_monster show twice - getpetinfo/gethominfo can return 0 or null if the player doesn't own them - summon command cannot summon dead branch style, since its using mob->spawn, not mob->once_spawn like *monster script command did
2015-11-17Add some FAQ documentation that some script command can return valueAnnieRuru1-0/+3
- getitemname can return "null" - getmapusers can return -1 and fix the bad ... misleading global function example
2015-11-15Fixed too-generic constant names of gettime() typesHaru1-20/+18
- Follow-up to 3bd77ffc0daca508352834add828766490075aee - The names were too generic (not namespaced), and were easily clashing with custom (and potential future official) constants or variables. - Constants are now prefixed with a 'GETTIME_' namespace: - GETTIME_SECOND - GETTIME_MINUTE - GETTIME_HOUR - GETTIME_WEEKDAY - GETTIME_DAYOFMONTH - GETTIME_MONTH - GETTIME_YEAR - GETTIME_DAYOFYEAR - Fixed some excessive (and some times incorrect) parentheses in various scripts using gettime(). - Updated documentation. Signed-off-by: Haru <haru@dotalux.com>
2015-11-14Standardized script-queue related commandsHaru1-16/+24
- The commands queueadd, queueremove, queueopt, queuedel and qiclear now all return true (success) or false (failure). - Taken/extended from AnnieRuru's PR #847. - The constants HQO_OnDeath, HQO_OnLogOut, HQO_OnMapChange were renamed to QUEUEOPT_DEATH, QUEUEOPT_LOGOUT, QUEUEOPT_MAPCHANGE respectively. - The name of the variable @QMapChangeTo$ used during the QUEUEOPT_MAPCHANGE event has been renamed to @Queue_Destination_Map$. Signed-off-by: Haru <haru@dotalux.com>
2015-11-14Fix @QMapChangeTo$ not usable when HQO_OnMapChange triggeredAnnieRuru1-0/+3
- also add documentation for it
2015-11-14Corrected an issue causing queue iterators not to return their last valueHaru1-2/+4
- Follow-up to 918b1123963ac2f91a4d074b092ceef1db71b4e8, a9042bf0bee2d2453058b22973bea8f335c5a201 - Thanks to Dastgir Signed-off-by: Haru <haru@dotalux.com>
2015-10-27Replaced parameter type with constant.Emistry1-49/+52
constant for gettime( <type> ) constant for Weekday and Month.
2015-10-26Merge branch 'master' of https://github.com/HerculesWS/HerculesDastgir1-7/+45
2015-10-26Updated script documentationDastgir1-0/+15
2015-09-28Added Missing ScriptCommands in the doc.Dastgir1-7/+45
Corrected sleep/sleep2 parameter list. Changed bg_join_team return values.
2015-09-06Revert "Revert "Updated getwaitingroomstate() script command.""Emistry1-1/+6
This reverts commit c3ce0fb9b04d4c51d632c21f24f7a348c2681bf2.
2015-09-06Revert "Updated getwaitingroomstate() script command."Emistry1-6/+1
This reverts commit 1bd8e9d50ed6de9433c3d6ccb842491cdafcd0a1.
2015-09-06Updated getwaitingroomstate() script command.Emistry1-1/+6
type 0 - return number of users in the waiting room and account_id list stored in $@chatmembers[] type 34 - Minimum Base Level to enter waiting room. type 35 - Maximum Base Level to enter waiting room. type 36 - Minimum Zeny to enter waiting room.
2015-08-31npctalk support extra npc name parameter.Emistry1-1/+2
The command will display the message on the NPC that name specified in the parameter. Useful in quest script that required a lot of different NPC to talk at the same time. Especially instances script.
2015-08-31Updated doc/script_commands.txtEmistry1-4/+7
isequipped() and isequippedcnt() support not only card id, but also support any item id.
2015-08-09Deprecated use of numeric NPC view IDs. Use constants instead.Haru1-15/+16
Signed-off-by: Haru <haru@dotalux.com>
2015-08-09Removed deprecated script command checkreHaru1-24/+0
- Follow-up to ca877ecbef0d3fe8df1b69fcaa9e72693c104f02 Signed-off-by: Haru <haru@dotalux.com>
2015-08-05Add optional parameter to warp script command for prevent stoping npc ↵Andrei Karas1-1/+5
scripts after warp.
2015-07-20Fix typo in script_commands.txtDastgir1-1/+1
2015-07-05Added script command `showscript "<message>"{,<GID>};`Emistry1-0/+7
Makes attached player or GID says a message like shouting a skill name, the message will be seen to everyone around but not in chat window.
2015-06-24Charset fix in script_commands.txtDastgir1-1/+1
2015-06-14Updated documentation for the look type of changelook script commandAngelmelody1-10/+13
2015-06-04Implemented strcmp Function.Dastgir1-1/+20
2015-05-16Added charid2rid script commandHaru1-0/+8
- Returns the account ID (RID) for the given character ID. - As per Streusel's request. Signed-off-by: Haru <haru@dotalux.com>
2015-05-16Follow-up to c9f845f4518fc3626d9bc2f7166db5a2ac620a57Haru1-21/+10
- Removed documentation for floor and ceil. - Updated documentation for log10 to the new command's name. - Updated documentation for the math commands to mention that their return value is truncated to int. - Updated documentation for the distance() command to mention what type of distance it returns. Signed-off-by: Haru <haru@dotalux.com>
2015-05-15Added floor(), ceil() and log() functions for usage in scripts.Streusel1-0/+28
2015-05-08Deprecated command checkre().Haru1-0/+8
- The command is deprecated and it will be removed in about a month. Please use the constants RENEWAL, RENEWAL_CAST, RENEWAL_DROP, RENEWAL_EXP, RENEWAL_LVDMG, RENEWAL_EDP, RENEWAL_ASPD instead. Signed-off-by: Haru <haru@dotalux.com>