mapflags.txt 13 KB

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