mapflags.txt 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482
  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. Disables chatroom creation on a map.
  103. ---------------------------------------
  104. *novending
  105. Disables shop creation on a map from the MC_VENDING skill.
  106. ---------------------------------------
  107. *nobuyingstore
  108. Disables shop creation on a map from the ALL_BUYING_STORE skill.
  109. ---------------------------------------
  110. *nousecart
  111. Disables cart usage on a map.
  112. ---------------------------------------
  113. *noskill
  114. Disables skill usage on a map.
  115. ---------------------------------------
  116. *restricted <zone>
  117. Disables certain items and skills on a map through a specified zone number. The zone databases are
  118. located in 'db/(pre-)re/item_noequip.txt' and 'db/(pre-)re/skill_nocast_db.txt', both of which
  119. contain explanations and examples of how this mapflag is used.
  120. Restricted Zones:
  121. 1 - Aldebaran Turbo Track
  122. 2 - Jail
  123. 3 - Izlude Battle Arena
  124. 4 - WoE:SE Maps
  125. 5 - Sealed Shrine
  126. 6 - Instances: Endless Tower, Orc's Memory, Nidhoggr's Instance
  127. 7 - Towns
  128. 8 - WOE:TE Dungeons
  129. ---------------------------------------
  130. *monster_noteleport
  131. Prevents monsters from teleporting on a map, including through the skill RG_INTIMIDATE.
  132. ---------------------------------------
  133. *nobranch
  134. Disables usage of monster-spawning items on a map:
  135. - Dead Branch (ID 604)
  136. - Bloody Branch (ID 12103)
  137. - Poring Box (ID 12109)
  138. - Red Pouch (ID 12024)
  139. Items listed above can be modified under db/(pre-)re/item_flag.txt
  140. Note that when 'mob_warp' is enabled in '/conf/battle/monster.conf' and flag 4 is set, this will
  141. also prevent mobs from being warped onto the map (except slave mobs).
  142. ---------------------------------------
  143. *noicewall
  144. Disables skill WZ_ICEWALL on a map.
  145. ---------------------------------------
  146. *nosunmoonstarmiracle
  147. Disables Star Gladiator's "Solar, Lunar, and Stellar Miracle" from occurring on a map.
  148. ---------------------------------------
  149. *forcemineffect
  150. Forces simpler skill effects, just like the command /mineffect.
  151. ---------------------------------------
  152. *nolockon
  153. Disables attacking another player without holding shift or using /ns on a map.
  154. ---------------------------------------
  155. *nocommand <group level>
  156. Disables everyone to use command on a map. If group level is specified, only disables
  157. player who has group level below it.
  158. ---------------------------------------
  159. *nomapchannelautojoin
  160. Stops players from automatically joining the #map channel on a map.
  161. This only applies if map channels are enabled and 'map_local_channel_autojoin' is true
  162. in '/conf/channels.conf'.
  163. ---------------------------------------
  164. *notomb
  165. Disables MVP tombs from appearing on a map.
  166. ---------------------------------------
  167. *nocostume
  168. Disables costume sprites on a map.
  169. This only disables the sprites and not the effect of the items.
  170. If a player logs out on a nocostume map the costume sprites will also not be shown in the
  171. character server.
  172. ---------------------------------------
  173. *norenewaldroppenalty
  174. Disable renewal drop rate penalty due to level difference on a map.
  175. ---------------------------------------
  176. *norenewalexppenalty
  177. Disable renewal experience penalty due to level difference on a map.
  178. ---------------------------------------
  179. *nopetcapture
  180. Disable the ability to capture pets on a map.
  181. ---------------------------------------
  182. *nobank
  183. Disable Bank on a map.
  184. ---------------------------------------
  185. *norodex
  186. Disable RODex on a map.
  187. ---------------------------------------
  188. =====================
  189. | 2. Battle-related |
  190. =====================
  191. ---------------------------------------
  192. *pvp
  193. *pvp_noparty
  194. *pvp_noguild
  195. *pvp_nocalcrank
  196. Enables Player vs. Player mode on a map and applies the corresponding damage adjustments.
  197. 'pvp_noparty' will ignore party alliances.
  198. 'pvp_noguild' will ignore guild alliances.
  199. 'pvp_nocalcrank' will disable calculation of PvP rankings.
  200. ---------------------------------------
  201. *pvp_nightmaredrop <id>,<type>,<rate>
  202. Causes players to drop items upon death. This is not grouped with the other PvP mapflags
  203. because it does not necessarily require PvP mode to be set.
  204. <id> determines what will drop. It can be either a specific item ID or "random".
  205. <type> specifies where items are dropped from. It can be "inventory", "equip", or "all".
  206. <rate> is the chance that an item will drop (10000 = 100%).
  207. ---------------------------------------
  208. *gvg
  209. *gvg_noparty
  210. *gvg_castle
  211. *gvg_dungeon
  212. *gvg_te
  213. *gvg_te_castle
  214. Enables Guild vs. Guild mode on a map and applies the corresponding damage adjustments.
  215. 'gvg_noparty' will ignore party alliances.
  216. 'gvg_castle' marks a guild castle. GvG mode will be active only during the War of Emperium.
  217. 'gvg_dungeon' marks a guild dungeon. Players will be warped out after two deaths.
  218. 'gvg_te' and 'gvg_te_castle' marks a WOE:TE area and special restrictions are applied.
  219. ---------------------------------------
  220. *battleground {<type>}
  221. Enables Battlegrounds on a map and applies the corresponding damage adjustments.
  222. If <type> is 2, a scoreboard will be shown. The default is 1 (nothing).
  223. ---------------------------------------
  224. *partylock
  225. *guildlock
  226. Prevents alteration of parties and guilds on a map. This includes creating, leaving,
  227. inviting, expelling, breaking, and changing leaders.
  228. Notes:
  229. 'partylock' will still allow party options to be changed.
  230. 'guildlock' will also block changes to guild alliances.
  231. ---------------------------------------
  232. *skill_damage {<skill_name>,<caster>,<SKILLDMG_PC>,{<SKILLDMG_MOB>,{<SKILLDMG_BOSS>,{<SKILLDMG_OTHER>}}}}
  233. Enables skill damage adjustment on a map. All adjustments in 'db/skill_damage_db.txt'
  234. for 'Map' type 16 will be applied.
  235. This mapflag can also be used to adjust the damage of one skill by a percentage:
  236. - skill_name:
  237. Name of the skill in 'db/(pre-)re/skill_db.yml' (ex. SM_BASH).
  238. To adjust all skill damage, write "all" (without quotes).
  239. - caster: the groups for which the adjustment takes effect. (bitmask)
  240. BL_PC = Player
  241. BL_MOB = Monster
  242. BL_PET = Pet
  243. BL_HOM = Homunculus
  244. BL_MER = Mercenary
  245. BL_ELEM = Elemental
  246. - damage: percent adjustment rate (between -100 and 100000).
  247. SKILLDMG_PC = against player
  248. SKILLDMG_MOB = against normal monster
  249. SKILLDMG_BOSS = against boss monster
  250. SKILLDMG_OTHER = against other (homunculus, mercenary, pet, elemental)
  251. ---------------------------------------
  252. *skill_duration skill_name,percentage
  253. Sets skill (trap-type) time limit to n% of original duration.
  254. // Example:
  255. // Makes HT_ANKLESNARE's lifetime in the castle 4x longer than other maps.
  256. prtg_cas01 mapflag skill_duration HT_ANKLESNARE,400
  257. ---------------------------------------
  258. ==================
  259. | 3. Map Effects |
  260. ==================
  261. ---------------------------------------
  262. *clouds
  263. *clouds2
  264. *fireworks
  265. *fog
  266. *leaves
  267. *sakura
  268. *snow
  269. Displays a weather effect on a map.
  270. ---------------------------------------
  271. *nightenabled
  272. Displays night mode effects on a map. This is used on most outdoor maps.
  273. ---------------------------------------
  274. ====================
  275. | 4. Miscellaneous |
  276. ====================
  277. ---------------------------------------
  278. *town
  279. Marks a map as a town. This allows players to access their mail and disables kill stealing.
  280. ---------------------------------------
  281. *reset
  282. Allows usage of item Neuralizer (ID 12213).
  283. ---------------------------------------
  284. *bexp <rate>
  285. *jexp <rate>
  286. Changes the base and job experience rates on a map. Supports negative values to reduce EXP
  287. rates as well.
  288. <rate> is given as a percentage (i.e. 100 = 1x EXP). This takes into account the modifiers
  289. 'base_exp_rate' and 'job_exp_rate' in '/conf/battle/exp.conf'.
  290. ---------------------------------------
  291. *loadevent
  292. Triggers the label "OnPCLoadMapEvent" when players enter a map (this also includes
  293. teleporting within the map). More details can be found in '/doc/script_commands.txt'.
  294. ---------------------------------------
  295. *allowks
  296. Allows kill stealing on a map (rendering the @noks command useless).
  297. ---------------------------------------
  298. *autotrade
  299. Allows the @autotrade command on a map.
  300. This only applies if 'at_mapflag' is enabled in '/conf/battle/misc.conf'. Otherwise, the
  301. atcommand is enabled on all maps by default.
  302. ---------------------------------------
  303. *hidemobhpbar
  304. Hides monster's HP bar on a map.
  305. Ignores config value of 'monster_hp_bars_info'.
  306. ---------------------------------------
  307. *specialpopup <popup ID>
  308. Displays a special popup when a player enters the map. See script command "specialpopup" for details on different popup types.
  309. ---------------------------------------