mapflags.txt 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398
  1. //===== rAthena Documentation ================================
  2. //= Mapflag List
  3. //===== By: ==================================================
  4. //= rAthena Dev Team
  5. //===== Last Updated: ========================================
  6. //= 20130830
  7. //===== Description: =========================================
  8. //= List of available mapflags and their functions.
  9. //============================================================
  10. This file describes the functions of mapflags, which determine the behavior of a
  11. map in various situations. For instructions on setting a mapflag, refer to the
  12. documentation in '/doc/script_commands.txt'.
  13. To search for a mapflag, write "*" before its name.
  14. The format of this file is as follows:
  15. 1. Restrictions
  16. 2. Battle-related
  17. 3. Map Effects
  18. 4. Miscellaneous
  19. ===================
  20. | 1. Restrictions |
  21. ===================
  22. ---------------------------------------
  23. *noreturn
  24. Disables usage of map-warping items on a map:
  25. - Butterfly Wing (ID 602)
  26. - Yellow/Green/Red/Blue Butterfly Wing (IDs 14582-14585)
  27. - Siege Teleport Scroll (ID 14591)
  28. - Dungeon Teleport Scroll 1/2/3 (IDs 14527, 14581, 12352)
  29. The 'warpparty' and 'warpguild' script commands are also blocked for destinations outside the
  30. player's current map.
  31. ---------------------------------------
  32. *noteleport
  33. Disables all means of teleportation within a map:
  34. - Items Fly Wing (ID 601) and Giant Fly Wing (ID 12212) are disabled.
  35. - Skills AL_TELEPORT, TK_HIGHJUMP, and SC_DIMENSIONDOOR are disabled.
  36. - Skills RG_INTIMIDATE, NPC_EXPULSION, and CG_TAROTCARD will not teleport their intended targets.
  37. - Script commands using "Random" as the destination will fail.
  38. - Script command 'warpwaitingpc' will fail with "SavePoint" as the destination.
  39. - Script command 'unitwarp' will fail for players.
  40. - Atcommand @jump is disabled.
  41. ---------------------------------------
  42. *nowarp
  43. Disables warping from a map:
  44. - Script commands 'warpparty' and 'warpguild' will not warp players on 'nowarp' maps.
  45. - Atcommands @warp, @go, @load, and @jump are disabled.
  46. - Atcommands @partyrecall, @guildrecall, and @recallall will not warp players on 'nowarp' maps.
  47. - Skill GD_EMERGENCYCALL will not warp players on 'nowarp' maps.
  48. - Unit UNT_CALLFAMILY will not warp players on 'nowarp' maps.
  49. ---------------------------------------
  50. *nowarpto
  51. Disables warping to a map:
  52. - Atcommands @warp, @go, @load, and @jump are disabled to the 'nowarpto' map.
  53. - Atcommands @partyrecall, @guildrecall, and @recallall are disabled.
  54. - Command /memo is disabled.
  55. - Skill GD_EMERGENCYCALL is disabled if flag 16 of 'emergency_call' is set in
  56. '/conf/battle/skill.conf'. This will not work for 'gvg_castle' maps.
  57. ---------------------------------------
  58. *nogo
  59. Disables usage of command @go on a map.
  60. ---------------------------------------
  61. *nosave <map name>
  62. Disables auto-saving on a map. Players who log off on the map will be warped to <map name> when
  63. they next log in. "SavePoint", without quotes, is also valid for this field.
  64. ---------------------------------------
  65. *nomemo
  66. Disables the /memo command to save a warp point on a map, and also disables usage of marriage
  67. skills WE_CALLPARTNER, WE_CALLPARENT, and WE_CALLBABY.
  68. ---------------------------------------
  69. *noitemconsumption
  70. Disables usage of items on a map.
  71. ---------------------------------------
  72. *notrade
  73. Disables trading on a map.
  74. ---------------------------------------
  75. *nodrop
  76. Disables dropping items on a map.
  77. Note that items may still be dropped if a player's inventory is full and 'item_flooritem_check'
  78. is disabled in '/conf/battle/items.conf'.
  79. ---------------------------------------
  80. *noloot
  81. *nomobloot
  82. *nomvploot
  83. Disables normal monsters and MVPs from dropping items on a map. Looted items will always drop.
  84. 'noloot' is the same as 'nomobloot' and 'nomvploot' combined.
  85. ---------------------------------------
  86. *noexp
  87. *nobaseexp
  88. *nojobexp
  89. Disables gaining base and job experience from monsters, including MVP bonuses, on a map.
  90. 'noexp' is the same as 'nobaseexp' and 'nojobexp' combined.
  91. ---------------------------------------
  92. *nopenalty
  93. *noexppenalty
  94. *nozenypenalty
  95. Disables the loss of experience and Zeny upon death on a map.
  96. 'nopenalty' is the same as 'noexppenalty' and 'nozenypenalty' combined.
  97. Notes:
  98. 'noexppenalty' also affects pets, and skills PR_REDEMPTIO and LG_INSPIRATION will not deduct EXP.
  99. 'nozenypenalty' only applies if 'zeny_penalty' is enabled in '/conf/battle/exp.conf'.
  100. ---------------------------------------
  101. *nochat
  102. *novending
  103. Disables chatroom and shop creation on a map.
  104. ---------------------------------------
  105. *nousecart
  106. Disables cart usage on a map.
  107. [Not fully implemented.]
  108. ---------------------------------------
  109. *noskill
  110. Disables skill usage on a map.
  111. ---------------------------------------
  112. *restricted <zone>
  113. Disables certain items and skills on a map through a specified zone number. The zone databases are
  114. located in 'db/(pre-)re/item_noequip.txt' and 'db/(pre-)re/skill_nocast_db.txt', both of which
  115. contain explanations and examples of how this mapflag is used.
  116. ---------------------------------------
  117. *monster_noteleport
  118. Prevents monsters from teleporting on a map, including through the skill RG_INTIMIDATE.
  119. ---------------------------------------
  120. *nobranch
  121. Disables usage of monster-spawning items on a map:
  122. - Dead Branch (ID 604)
  123. - Bloody Branch (ID 12103)
  124. - Poring Box (ID 12109)
  125. - Red Pouch (ID 12024)
  126. Note that when 'mob_warp' is enabled in '/conf/battle/monster.conf' and flag 4 is set, this will
  127. also prevent mobs from being warped onto the map (except slave mobs).
  128. ---------------------------------------
  129. *noicewall
  130. Disables skill WZ_ICEWALL on a map.
  131. ---------------------------------------
  132. *nosumstarmiracle
  133. Disables Star Gladiator's "Solar, Lunar, and Stellar Miracle" from occurring on a map.
  134. ---------------------------------------
  135. *nomineeffect
  136. Disables mine effects on a map.
  137. [More information needed.]
  138. ---------------------------------------
  139. *nolockon
  140. Disables locking on a map.
  141. [More information needed.]
  142. ---------------------------------------
  143. *nocommand <group level>
  144. Disables everyone to use command on a map. If group level is specified, only disables
  145. player who has group level below it.
  146. ---------------------------------------
  147. =====================
  148. | 2. Battle-related |
  149. =====================
  150. ---------------------------------------
  151. *pvp
  152. *pvp_noparty
  153. *pvp_noguild
  154. *pvp_nocalcrank
  155. Enables Player vs. Player mode on a map and applies the corresponding damage adjustments.
  156. 'pvp_noparty' will ignore party alliances.
  157. 'pvp_noguild' will ignore guild alliances.
  158. 'pvp_nocalcrank' will disable calculation of PvP rankings.
  159. ---------------------------------------
  160. *pvp_nightmaredrop <id>,<type>,<rate>
  161. Causes players to drop items upon death. This is not grouped with the other PvP mapflags
  162. because it does not necessarily require PvP mode to be set.
  163. <id> determines what will drop. It can be either a specific item ID or "random".
  164. <type> specifies where items are dropped from. It can be "inventory", "equip", or "all".
  165. <rate> is the chance that an item will drop (10000 = 100%).
  166. ---------------------------------------
  167. *gvg
  168. *gvg_noparty
  169. *gvg_castle
  170. *gvg_dungeon
  171. Enables Guild vs. Guild mode on a map and applies the corresponding damage adjustments.
  172. 'gvg_noparty' will ignore party alliances.
  173. 'gvg_castle' marks a guild castle. GvG mode will be active only during the War of Emperium.
  174. 'gvg_dungeon' marks a guild dungeon. Players will be warped out after two deaths.
  175. ---------------------------------------
  176. *battleground {<type>}
  177. Enables Battlegrounds on a map and applies the corresponding damage adjustments.
  178. If <type> is 2, a scoreboard will be shown. The default is 1 (nothing).
  179. ---------------------------------------
  180. *partylock
  181. *guildlock
  182. Prevents alteration of parties and guilds on a map. This includes creating, leaving,
  183. inviting, expelling, breaking, and changing leaders.
  184. Notes:
  185. 'partylock' will still allow party options to be changed.
  186. 'guildlock' will also block changes to guild alliances.
  187. ---------------------------------------
  188. *skill_damage {<skill_name>,<caster>,<damage1>,{<damage2>,{<damage3>,{<damage4>}}}}
  189. Enables skill damage adjustment on a map. All adjustments in 'db/skill_damage_db.txt'
  190. for 'Map' type 16 will be applied.
  191. This mapflag can also be used to adjust the damage of one skill by a percentage:
  192. - skill_name:
  193. Name of the skill in 'db/(pre-)re/skill_db.txt' (ex. SM_BASH).
  194. To adjust all skill damage, write "all" (without quotes).
  195. - caster: the groups for which the adjustment takes effect. (bitmask)
  196. 1 = Player
  197. 2 = Monster
  198. 4 = Pet
  199. 8 = Homunculus
  200. 16 = Mercenary
  201. 32 = Elemental
  202. - damage: percent adjustment rate (between -100 and 100000).
  203. 1 = against player
  204. 2 = against normal monster
  205. 3 = against boss monster
  206. 4 = against other (homunculus, mercenary, pet, elemental)
  207. Notes:
  208. - You MUST enable ADJUST_SKILL_DAMAGE in 'src/config/core.h' for this mapflag to take effect.
  209. - Each map can contain up to 5 adjustments (MAX_MAP_SKILL_MODIFIER in 'src/map/map.h').
  210. ---------------------------------------
  211. ==================
  212. | 3. Map Effects |
  213. ==================
  214. ---------------------------------------
  215. *clouds
  216. *clouds2
  217. *fireworks
  218. *fog
  219. *leaves
  220. *sakura
  221. *snow
  222. Displays a weather effect on a map.
  223. ---------------------------------------
  224. *nightenabled
  225. Displays night mode effects on a map. This is used on most outdoor maps.
  226. ---------------------------------------
  227. ====================
  228. | 4. Miscellaneous |
  229. ====================
  230. ---------------------------------------
  231. *town
  232. Marks a map as a town. This allows players to access their mail and disables kill stealing.
  233. ---------------------------------------
  234. *reset
  235. Allows usage of item Neuralizer (ID 12213).
  236. ---------------------------------------
  237. *bexp <rate>
  238. *jexp <rate>
  239. Changes the base and job experience rates on a map.
  240. <rate> is given as a percentage (i.e. 100 = 1x EXP). This takes into account the modifiers
  241. 'base_exp_rate' and 'job_exp_rate' in '/conf/battle/exp.conf'.
  242. ---------------------------------------
  243. *loadevent
  244. Triggers the label "OnPCLoadMapEvent" when players enter a map (this also includes
  245. teleporting within the map). More details can be found in '/doc/script_commands.txt'.
  246. ---------------------------------------
  247. *allowks
  248. Allows kill stealing on a map (rendering the @noks command useless).
  249. ---------------------------------------
  250. *autotrade
  251. Allows the @autotrade command on a map.
  252. This only applies if 'at_mapflag' is enabled in '/conf/battle/misc.conf'. Otherwise, the
  253. atcommand is enabled on all maps by default.
  254. ---------------------------------------
  255. *nomapchannelautojoin
  256. Stops players from automatically joining the #map channel on a map.
  257. This only applies if map channels are enabled and 'map_local_channel_autojoin' is true
  258. in '/conf/channels.conf'.
  259. ---------------------------------------
  260. *notomb
  261. Disables MVP tombs from appearing on a map.
  262. ---------------------------------------