summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/atcommands.txt6
-rw-r--r--doc/constants.md1
-rw-r--r--doc/effect_list.md4
-rw-r--r--doc/item_bonus.md2
-rw-r--r--doc/mob_db.txt23
-rw-r--r--doc/mob_db_mode_list.md2
-rw-r--r--doc/permissions.md2
-rw-r--r--doc/quest_variables.md2
-rw-r--r--doc/script_commands.txt47
9 files changed, 74 insertions, 15 deletions
diff --git a/doc/atcommands.txt b/doc/atcommands.txt
index 0b4dce579..419cb0acd 100644
--- a/doc/atcommands.txt
+++ b/doc/atcommands.txt
@@ -892,6 +892,12 @@ Resets a Star Gladiator's marked maps.
---------------------------------------
+@hatereset
+
+Resets a Star Gladiator's hatred targets.
+
+---------------------------------------
+
@jobchange <job name/ID>
Changes your job.
diff --git a/doc/constants.md b/doc/constants.md
index bc2a16f52..257696c4e 100644
--- a/doc/constants.md
+++ b/doc/constants.md
@@ -5085,6 +5085,7 @@
- `PCBLOCK_IMMUNE`: 32
- `PCBLOCK_SITSTAND`: 64
- `PCBLOCK_COMMANDS`: 128
+- `PCBLOCK_NPC`: 256
### private airship responds
diff --git a/doc/effect_list.md b/doc/effect_list.md
index 8ba8d36c9..be749d070 100644
--- a/doc/effect_list.md
+++ b/doc/effect_list.md
@@ -5,7 +5,7 @@ A list of client-side effects sorted by ID in ascending order.
> This file is part of Hercules.
> http://herc.ws - http://github.com/HerculesWS/Hercules
>
-> Copyright (C) 2012-2018 Hercules Dev Team
+> Copyright (C) 2012-2020 Hercules Dev Team
> Copyright (C) Athena Dev Teams
>
> Hercules is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
@@ -21,7 +21,7 @@ The following is a compiled list of visual and sound effects which the client
can produce. Each list entry contains a number and a short description of the
effect. You can produce these effects ingame by using the `@effect` atcommand.
It's also possible to attach effects to item/npc scripts by using the
-`specialeffect()` script command.
+`specialeffect()` or `specialeffectnum()` script commands.
ID | Constant Name | Description
--: | :----------------------------- | :----------------------------------
diff --git a/doc/item_bonus.md b/doc/item_bonus.md
index 7c8547456..e39b7b51f 100644
--- a/doc/item_bonus.md
+++ b/doc/item_bonus.md
@@ -5,7 +5,7 @@
> This file is part of Hercules.
> http://herc.ws - http://github.com/HerculesWS/Hercules
>
-> Copyright (C) 2012-2018 Hercules Dev Team
+> Copyright (C) 2012-2020 Hercules Dev Team
> Copyright (C) Athena Dev Teams
>
> Hercules is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
diff --git a/doc/mob_db.txt b/doc/mob_db.txt
index d62181048..53d345255 100644
--- a/doc/mob_db.txt
+++ b/doc/mob_db.txt
@@ -73,6 +73,22 @@ mob_db: (
AegisName: (chance, "Option Drop Group")
// ...
}
+ DamageTakenRate: damage taken rate (int, defaults to 100)
+ ViewData: {
+ SpriteId: sprite id (int, defaults to Id)
+ WeaponId: weapon id (int, defaults to 0)
+ ShieldId: shield id (int, defaults to 0)
+ RobeId: garment id (int, defaults to 0)
+ HeadTopId: top headgear id (int, defaults to 0)
+ HeadMidId: middle headgear id (int, defaults to 0)
+ HeadLowId: lower headgear id (int, defaults to 0)
+ HairStyleId: hair style id (int, defaults to 0)
+ BodyStyleId: clothes id (int, defaults to 0)
+ HairColorId: hair color id (int, defaults to 0)
+ BodyColorId: clothes color id (int, defaults to 0)
+ Gender: gender (string, defaults to "SEX_FEMALE")
+ Options: options (int, defaults to 0)
+ }
},
...
)
@@ -255,3 +271,10 @@ Drops: Sets monster drops list.
}
When not specified, becomes false (no drops).
+
+DamageTakenRate:
+ Limit the total damage received by the monster to the given rate
+
+ViewData:
+ Overrides the default view data sent to the client with the given values for:
+ Sprite, Weapon, Shield, Robe, HeadTop, HeadMid, HeadLow, HairStyle, BodyStyle, HairColor, BodyColor, Gender, Options
diff --git a/doc/mob_db_mode_list.md b/doc/mob_db_mode_list.md
index a8ad4fa0a..618e07b19 100644
--- a/doc/mob_db_mode_list.md
+++ b/doc/mob_db_mode_list.md
@@ -5,7 +5,7 @@
> This file is part of Hercules.
> http://herc.ws - http://github.com/HerculesWS/Hercules
>
-> Copyright (C) 2012-2018 Hercules Dev Team
+> Copyright (C) 2012-2020 Hercules Dev Team
> Copyright (C) Athena Dev Teams
>
> Hercules is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
diff --git a/doc/permissions.md b/doc/permissions.md
index a8794ecae..db5c6fa4b 100644
--- a/doc/permissions.md
+++ b/doc/permissions.md
@@ -5,7 +5,7 @@ A list of player group permission, configured in `conf/groups.conf`.
> This file is part of Hercules.
> http://herc.ws - http://github.com/HerculesWS/Hercules
>
-> Copyright (C) 2012-2018 Hercules Dev Team
+> Copyright (C) 2012-2020 Hercules Dev Team
> Copyright (C) Athena Dev Teams
>
> Hercules is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
diff --git a/doc/quest_variables.md b/doc/quest_variables.md
index 2f8922c41..b568f0e9c 100644
--- a/doc/quest_variables.md
+++ b/doc/quest_variables.md
@@ -5,7 +5,7 @@
> This file is part of Hercules.
> http://herc.ws - http://github.com/HerculesWS/Hercules
>
-> Copyright (C) 2012-2018 Hercules Dev Team
+> Copyright (C) 2012-2020 Hercules Dev Team
> Copyright (C) Athena Dev Teams
>
> Hercules is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
diff --git a/doc/script_commands.txt b/doc/script_commands.txt
index 45636f23b..1d8ed786b 100644
--- a/doc/script_commands.txt
+++ b/doc/script_commands.txt
@@ -4684,13 +4684,13 @@ See also warp().
---------------------------------------
-*warpparty("<to_mapname>", <x>, <y>, <party_id>, "<from_mapname>", <include_leader>)
+*warpparty("<to map name>", <x>, <y>, <party id>{{, <ignore mapflags>}, "<from map name>"{, <include leader>}})
Warps a party to specified map and coordinate given the party ID, which
you can get with getcharid(CHAR_ID_PARTY). You can also request another party id given
a member's name with getcharid(CHAR_ID_PARTY, <player_name>).
-You can use the following "map names" for special warping behavior:
+You can use the following <to map name> for special warping behavior:
Random: All party members are randomly warped in their current map
(as if they all used a fly wing).
SavePointAll: All party members are warped to their respective save point.
@@ -4701,8 +4701,10 @@ Leader: All party members are warped to the leader's position. The
leader must be online and in the current map-server for
this to work.
-If you specify a from_mapname, warpparty() will only affect those on
-that map.
+If <ignore mapflags> is not 0, warpparty() ignores nowarp/noreturn restrictions
+of the warped character's current map. <ignore mapflags> defaults to 0.
+
+If you specify a <from map name>, warpparty() will only affect those on that map.
You can exclude Party leader from warping, by keeping include_leader option as false.
@@ -4730,13 +4732,13 @@ Example:
---------------------------------------
-*warpguild("<mapname>", <x>, <y>, <guild_id>, {"<from_mapname>"})
+*warpguild("<to map name>", <x>, <y>, <guild id>{{, <ignore mapflags>}, "<from map name>"})
Warps a guild to specified map and coordinate given the guild id, which
you can get with getcharid(CHAR_ID_GUILD). You can also request another guild id given
the member's name with getcharid(CHAR_ID_GUILD, <player_name>).
-You can use the following "map names" for special warping behavior:
+You can use the following <to map name> for special warping behavior:
Random: All guild members are randomly warped in their current map
(as if they all used a fly wing)
SavePointAll: All guild members are warped to their respective save point.
@@ -4744,12 +4746,19 @@ SavePoint: All guild members are warped to the save point of the
currently attached player (will fail if there's no player
attached).
-If you specify a from_mapname, warpguild() will only affect those on that map.
+If <ignore mapflags> is not 0, warpguild() ignores nowarp/noreturn restrictions
+of the warped character's current map. <ignore mapflags> defaults to 0.
+
+If you specify a <from map name>, warpguild() will only affect those on that map.
Example:
- warpguild("prontera", x, y, Guild_ID);
- warpguild("prontera", x, y, Guild_ID, "payon"); // warp member from Payon map only.
+ warpguild("prontera", x, y, Guild_ID); // Warp all guild members to Prontera,
+ // but check nowarp/noreturn restriction of their current map.
+ warpguild("prontera", x, y, Guild_ID, 1); // Warp all guild members to Prontera.
+ warpguild("prontera", x, y, Guild_ID, "payon"); // Warp guild members from Payon to Prontera,
+ // but check nowarp/noreturn restriction of Payon.
+ warpguild("prontera", x, y, Guild_ID, 1, "payon"); // Warp guild members from Payon to Prontera.
---------------------------------------
@@ -6081,6 +6090,16 @@ Used in reset NPC's (duh!).
---------------------------------------
+*resetfeel({<account id>})
+*resethate({<account id>})
+
+The first resets a character's 'Feeling' maps.
+The second resets a character's 'Hatred' targets.
+
+If no RID is given, will run with the current attached player.
+
+---------------------------------------
+
*sc_start(<effect type>, <ticks>, <value 1>{, <rate>, <flag>{, <GID>}})
*sc_start2(<effect type>, <ticks>, <value 1>, <value 2>{, <rate>, <flag>{, <GID>}})
*sc_start4(<effect type>, <ticks>, <value 1>, <value 2>, <value 3>, <value 4>{, <rate>, <flag>{, <GID>}})
@@ -6231,6 +6250,15 @@ Example usage:
---------------------------------------
+*specialeffectnum(<effect number>, <num1>, <num2>{, <send_target>{, <unit id>{, <account id>}}})
+*specialeffectnum(<effect number>, <num1>, <num2>{, <send_target>{, "<NPC Name>"{, <account id>}}})
+
+Works same as specialeffect but also send effect numbers to client.
+For PACKETVER >= 20191127 support two numbers (num1, num2).
+For older packet versions only num1 supported.
+
+---------------------------------------
+
*removespecialeffect(<effect number>{, <send_target>{, <unit id>{, <account id>}}})
*removespecialeffect(<effect number>{, <send_target>{, "<NPC Name>"{, <account id>}}})
@@ -6532,6 +6560,7 @@ The <type> listed are a bit mask of the following:
PCBLOCK_IMMUNE
PCBLOCK_SITSTAND
PCBLOCK_COMMANDS
+ PCBLOCK_NPC
Examples:
generated by cgit v1.2.3-60-g2f50 (git 2.42.0) at 2024-07-28 13:38:32 +0000