summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAndrei Karas <akaras@inbox.ru>2014-11-05 01:11:04 +0300
committerAndrei Karas <akaras@inbox.ru>2014-11-05 01:11:04 +0300
commit13cf1b274ab9c18e5e080e9f2e3c10533fd38bad (patch)
tree95bcb6c10dd5fd6ffdb3e7b555a5a3db44342250 /doc
parentd6b5551bff867250edcdc36455ef32844ee2b935 (diff)
downloadserverdata-13cf1b274ab9c18e5e080e9f2e3c10533fd38bad.tar.gz
serverdata-13cf1b274ab9c18e5e080e9f2e3c10533fd38bad.tar.bz2
serverdata-13cf1b274ab9c18e5e080e9f2e3c10533fd38bad.tar.xz
serverdata-13cf1b274ab9c18e5e080e9f2e3c10533fd38bad.zip
update docs from hercules.
Diffstat (limited to 'doc')
-rw-r--r--doc/permissions.txt4
-rw-r--r--doc/script_commands.txt68
2 files changed, 66 insertions, 6 deletions
diff --git a/doc/permissions.txt b/doc/permissions.txt
index 7280395d..a656f8bc 100644
--- a/doc/permissions.txt
+++ b/doc/permissions.txt
@@ -33,3 +33,7 @@ disable_pvp : Ability to disable Player vs. Player.
disable_commands_when_dead : Ability to disable @command usage when dead.
can_trade_bound: Ability to trade or otherwise distribute bound items (drop, storage, vending etc...).
hchsys_admin : Hercules Chat System Admin (Ability to modify channel settings regardless of ownership and join password-protected channels without requiring a password.)
+disable_pickup: Ability to disable the player from picking up any item from ground, they can still receive items picked up by others means like party share píck.
+disable_exp: Ability to disable the player from gaining any experience point.
+disable_store: Ability to disable the player from using/openning npc and player stores.
+disable_skill_usage: Ability to disable the player from using any skill.
diff --git a/doc/script_commands.txt b/doc/script_commands.txt
index 7e00e50d..ec827471 100644
--- a/doc/script_commands.txt
+++ b/doc/script_commands.txt
@@ -3879,7 +3879,13 @@ regardless of color.
*setriding {<flag>};
*checkriding()
-[ DEPRECATED - Please use setmount / checkmount]
+ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+ @ /!\ This command is deprecated @
+ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+
+This command is deprecated and it should not be used in new scripts, as it
+is scheduled to be removed on or after November 30th, 2014. Please consider
+using setmount and checkmount() instead.
If <flag> is 0 this command will remove the mount from the character.
Otherwise it gives the invoking character a PecoPeco (if they are a Knight
@@ -3898,7 +3904,13 @@ riding a bird and 0 if they aren't.
*setdragon {<color>};
*checkdragon()
-[ DEPRECATED - Please use setmount / checkmount]
+ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+ @ /!\ This command is deprecated @
+ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+
+This command is deprecated and it should not be used in new scripts, as it
+is scheduled to be removed on or after November 30th, 2014. Please consider
+using setmount and checkmount() instead.
The 'setdragon' function toggles mounting a dragon for the invoking
character. It will return 1 if successful, 0 otherwise.
@@ -3921,7 +3933,13 @@ riding a dragon and 0 if they aren't.
*setmadogear {<flag>};
*checkmadogear()
-[ DEPRECATED - Please use setmount / checkmount]
+ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+ @ /!\ This command is deprecated @
+ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+
+This command is deprecated and it should not be used in new scripts, as it
+is scheduled to be removed on or after November 30th, 2014. Please consider
+using setmount and checkmount() instead.
If <flag> is 0 this command will remove the mount from the character.
Otherwise it gives the invoking character a Mado (if they are a Mechanic).
@@ -4257,7 +4275,6 @@ character is not married, or if there's no invoking character (no RID).
---------------------------------------
*savepoint "<map name>",<x>,<y>;
-*save "<map name>",<x>,<y>;
This command saves where the invoking character will return to upon
'return to save point', if dead or in some other cases. The two versions
@@ -4267,6 +4284,16 @@ character respawn where no teleportation is otherwise possible.
savepoint "place",350,75;
+*save "<map name>",<x>,<y>;
+
+ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+ @ /!\ This command is deprecated @
+ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+
+This command is deprecated and it should not be used in new scripts, as it
+is scheduled to be removed on or after December 2nd, 2014. Please consider
+using savepoint() instead.
+
---------------------------------------
*heal <hp>,<sp>;
@@ -6249,6 +6276,14 @@ A debug message also shows on the console when no events are triggered.
*cmdothernpc "<npc name>","<command>";
+ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+ @ /!\ This command is deprecated @
+ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+
+This command is deprecated and it should not be used in new scripts, as it
+is scheduled to be removed on or after December 2nd, 2014. Please consider
+using donpcevent() instead.
+
This is simply "donpcevent <npc name>::OnCommand<command>".
It is an approximation of official server script language's 'cmdothernpc'.
@@ -6724,8 +6759,6 @@ It's not clear what happens to a waiting room if the NPC is disabled with
*enablewaitingroomevent {"<NPC object name>"};
*disablewaitingroomevent {"<NPC object name>"};
-*enablearena;
-*disablearena;
This will enable and disable triggering the waiting room event (see
'waitingroom') respectively. Optionally giving an NPC object name will do
@@ -6739,6 +6772,17 @@ Normally, whenever a waiting room was created to make sure that only one
character is, for example, trying to pass a job quest trial, and no other
characters are present in the room to mess up the script.
+*enablearena;
+*disablearena;
+
+ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+ @ /!\ This command is deprecated @
+ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+
+This command is deprecated and it should not be used in new scripts, as it
+is scheduled to be removed on or after December 2nd, 2014. Please consider
+using enablewaitingroomevent and disablewaitingroomevent instead.
+
The 'enablearena'/'disablearena' commands are just aliases with no
parameter. These are supposedly left here for compatibility with official
server scripts, but no Hercules script uses these at the moment.
@@ -7568,6 +7612,18 @@ Example:
---------------------------------------
+*min(<number>{,<number>...<number>})
+*max(<number>{,<number>...<number>})
+
+Returns the smallest (or biggest) from the set of given numbers.
+
+Example:
+ .@minimum = min(1, -6, -2, 8, 2); // .@minimum will be equal to -6
+ .@maximum = max(0, 5, 10, 4); // .@maximum will be equal to 10
+ .@level = min(BaseLevel, 70); // .@level will be the character's base level, capped to 70
+
+---------------------------------------
+
*md5("<string>")
Returns the md5 checksum of a number or string.