TSR_MapOverlays

じ☆ve冰风

download:
TSR_MapOverlays
Author:
TSR​

This plugin let you add as many overlays you want on the map and battlefield.

There is no plugin parameters and no need for Game Switches, only map notetags and plugin commands.

Define the x and y position, set the scrolling speed, the max opacity and the z index of each overlays. You can also make animated overlays if needed.  Overlays can appear on the map, on the battlefield, or both.

Map notetags are used to initialize the overlays when the player first enter a map. Overlays data are retains in a game object afterward, and can be managed with plugin commands. Note that you can modify the overlays on any maps using plugin commands, even if the player hasn't visited the map yet.

See plugin instructions.
​
Spoiler: Instructions

                Code:       

1. * =======================================================================
2. * == About this Plugin ==================================================
3. * =======================================================================
4. * Overlay images are drawn from the /img/parallaxes folder of your game.
5. * You can add as many overlays as you want on a map using map notetags.
6. *
7. * 6 types of overlay can be defined by the notetags:
8. *
9. *       MAP OVERLAY: This overlay is always centered around the player
10. *                    or around an event. It can scroll horizontally
11. *                    and vertically at the speed defined by the x and
12. *                    y arguments of the notetag.
13. *                  
14. *    SCREEN OVERLAY: This overlay is always centered on the screen
15. *                    like default parallaxes. The horizontal and
16. *                    vertical scrolling speed are defined by the
17. *                    x and y arguments of the notetag.
18. *
19. *    BATTLE OVERLAY: This overlay appears only on the battlefield.
20. *                    It is centered on the screen like Screen over-
21. *                    lays. The horizontal and vertical scrolling
22. *                    speed are defined by the x and y arguments
23. *                    of the notetag.
24. *
25. *     FIXED OVERLAY: This overlay stay fixed on a map tile defined
26. *                    by the x and y arguments of the notetag.
27. *
28. *  ANIMATED OVERLAY: This overlay is a Fixed overlay that can loop
29. *                    through a number of frames set in the notetag.
30. *
31. *             COVER: This is a special overlay that doesn't use an
32. *                    image. It consist in a black rectangle shaped
33. *                    pixi graphics that can be placed on a map to
34. *                    cover some part of it. The notetag arguments
35. *                    define the position and dimension of the cover
36. *                    sprite. It behaves as a 'fixed overlay'.
37. *
38. *
39. * The map notetags are used to setup the overlays on a map the first
40. * time the player enter it. Overlays settings are retained in a game
41. * object afterward, and can be changed using plugin commands.
42. *
43. *      *note that you can modify an overlay using plugin commands
44. *       even if the player hasn't visit the map yet.
45. *
46. *
47. *
48. * MAP NOTETAGS:
49. *
50. *     <name MAP OVERLAY: filename, x, y, z, opacity, battle, hidden>
51. *
52. *     <name SCREEN OVERLAY: filename, x, y, z, opacity, battle, hidden>
53. *
54. *     <name BATTLE OVERLAY: filename, x, y, z, opacity, hidden>
55. *
56. *     <name FIXED OVERLAY: filename, x, y, z, opacity, hidden>
57. *
58. *     <name ANIMATED OVERLAY: filename, x, y, w, h, z, opacity, frame, rate, battle, hidden>
59. *
60. *     <name COVER: x, y, w, h, z, opacity, hidden>
61. *
62. *
63. *     LEGEND:
64. *             name: this is the name of the overlay. It is used for
65. *                   identifying the overlay in the plugin commands.
66. *                   You can name it as you want, but all overlays on
67. *                   a same map must have different names.
68. *
69. *         filename: enter the file name of the overlay image stored
70. *                   in the /img/parallaxes folder without extension.
71. *
72. *                x: this is the x value of the overlay. For 'covers'
73. *                   and 'fixed overlays', this value represent the
74. *                   x position on the map of the overlay. For 'map'
75. *                   and 'screen' overlays, this value will be the
76. *                   horizontal scrolling speed of the overlay.
77. *
78. *                y: this is the y value of the overlay. For 'covers'
79. *                   and 'fixed overlays', this value represent the
80. *                   y position on the map of the overlay. For 'map'
81. *                   and 'screen' overlays, this value will be the
82. *                   vertical scrolling speed of the overlay.
83. *
84. *                w: this argument is only used for the 'cover' and
85. *                   'animated' overlay notetag. It represent the
86. *                   width of the cover rectangle in pixels, or the
87. *                   width of one frame of the animated overlay.
88. *
89. *                h: this argument is only used for the 'cover' and
90. *                   'animated' overlay notetag. It represent the
91. *                   height of the cover rectangle in pixels, or the
92. *                   height of one frame of the animated overlay.
93. *
94. *                z: this is the z index of the overlay. Values bellow
95. *                   zero will appear bellow the tileset (the default
96. *                   parallax z index is -1). Overlays will stack up
97. *                   in their z index order, the highest z value being
98. *                   on top.
99. *
100. *          opacity: this is the maximum opacity of the overlay.
101. *
102. *           frame: this argument is only used for the 'animated' overlays.
103. *                  It represent the number of frames of the overlay.
104. *
105. *            rate: this argument is only used for the 'animated' overlays.
106. *                  It represent the frame rate at which the ovelay frames
107. *                  are updated.
108. *
109. *           battle: set this value to 0 to prevent the overlay to appear
110. *                   on the battlefield. To show the overlay in battle,
111. *                   set it to 1.
112. *
113. *                  *note that 'fixed overlays' and 'covers' doesn't have
114. *                   a battle argument because these are disabled during
115. *                   battles.
116. *
117. *                 **also note that 'animated' overlays are either displayed
118. *                   on the map OR in battle. When displayed in battle the
119. *                   x and y arguments are the position of the top-left
120. *                   corner of the overlay image on the battle screen. On
121. *                   the map, 'animated' overlays are similar to 'fixed'
122. *                   overlays, and the x and y arguments represent the tiles
123. *                   coordinates of the overlay on the map.
124. *
125. *           hidden: when set to true, the overlay will be invisible
126. *                   when the player first enter the map. This arguement
127. *                   can be omitted instead of setting it to false.
128. *
129. *     EXAMPLE:
130. *
131. *               <myoverlay1 map overlay: Example, 0, 0, 6, 0.5, 1>
132. *
133. *          A map having this notetag will display a 'map overlay' using
134. *          the 'Example.png' image stored in /img/parallaxes. The image
135. *          will have no scrolling speed and will be displayed at z index
136. *          6 with half opacity. The last argument, 'battle' is set to 1,
137. *          meaning that the overlay will appear in battle too. The argu-
138. *          ment 'hidden' is omitted so the overlay will be visible the
139. *          first time the player enter the map. The name 'myoverlay1' is
140. *          what will be used to identify the overlay in the plugin commands.
141. *          (see bellow)  
142. *
143. *
144. * ANIMATED OVERLAYS
145. *      To use the 'animated' overlay notetag, your overlay images must
146. *      be arrange in an horizontal strip of 3 or more frames. These
147. *      frames will be looped back and forth at a rate defined by the
148. *      frameRate argument of the notetag.
149. *
150. *      If the 'battle' argument is set to 1, the animated overlay will
151. *      appear only on the battlefield and not on the map. Its x and y
152. *      arguments will be the coordinates in pixels of the top-left corner
153. *      of the overlay.
154. *
155. *      If the 'battle' argument is set to 0, the animated overlay will
156. *      appear only on map and not on the battlefield. The overlay will
157. *      be centered around the map tile defined by the x and y arguments.
158. *
159. *
160. *
161. * BATTLE OVERLAYS
162. *      Battle overlays are overlays that appear on the battlefield. That
163. *      is overlays set with the 'battle overlay' notetag, OR 'map', 'screen'
164. *      and 'animated' overlays that have the 'battle' argument of their
165. *      notetag set to 1.
166. *
167. *      Battle overlays behaves a little different in regards of z index:
168. *
169. *          Z index < 1
170. *          ===========
171. *          Overlays appear under everything including battlebacks, but
172. *          above the blurred background of the battlescene.
173. *        
174. *          Z index >= 1 and Z index < 5
175. *          ============================
176. *          Overlays appear above battlebacks, but bellow battlers.
177. *
178. *          Z index >= 5
179. *          ============
180. *          Overlays appear above battlers, but bellow windows, of course.
181. *
182. *
183. *
184. * MAP VS SCREEN OVERLAY
185. *      Screen overlays are centered on the screen (default parallax), while
186. *      Map overlays are centered around the player (or an event). The main
187. *      difference between the two is when the player reach the border of
188. *      the map. The map stop scrolling when the player is near the map border,
189. *      and screen overlays will do the same, while map overlays will keep
190. *      following the player.
191. *
192. *      This is a matter of what effect you're trying to produce. For example,
193. *      an 'iris eye' overlay would need a map overlay so it would be always
194. *      centered on the player, even on map borders. But a simple 'fog' over-
195. *      lay would only need a screen overlay because it only need to be put
196. *      over the screen. The main drawback of map overlays is the fact that
197. *      they require an image bigger than your screen resolution, otherwise
198. *      part of the screen won't be covered up by the overlay when it slide
199. *      to follow the player on map borders (unless that's what you want).
200. *
201. *
202. *
203. * PLUGIN COMMANDS:
204. *      The plugin works in both RPG maker MZ and MV. The plugin commands
205. *      are the same no matter the engine you're using; only the way the
206. *      commands are entered is different.
207. *
208. *     -SHOW OVERLAY
209. *          This command fade the overlay in up to its max opacity in a
210. *          number of frames defined by the delay argument.
211. *
212. *              Name: select the overlay. Write the same name you used
213. *                    in the map notetag.                  
214. *             Delay: set the duration in frame of the overlay fade in
215. *            Map Id: set the map Id where the overlay is shown. Leaving
216. *                    it to 0 will select the current map.
217. *
218. *          MV format: showOverlay name delay mapId
219. *
220. *
221. *     -HIDE OVERLAY
222. *          This command fade the overlay out down to zero opacity in a
223. *          number of frames defined by the delay argument.
224. *
225. *              Name: select the overlay. Write the same name you used
226. *                    in the map notetag.
227. *             Delay: set the duration in frame of the overlay fade out
228. *            Map Id: set the map Id where the overlay is shown. Leaving
229. *                    it to 0 will select the current map.
230. *
231. *          MV format: hideOverlay name delay mapId
232. *
233. *
234. *     -CHANGE OVERLAY
235. *          This command allow to change some overlay settings.
236. *
237. *              Name: select the overlay. Write the same name you used
238. *                    in the map notetag.
239. *                 x: change the x (horizontal position or scroll speed
240. *                    of the overlay).
241. *                 y: change the y (vertical position or scroll speed
242. *                    of the overlay).
243. *                 z: change the z index value of the overlay.
244. *           opacity: change the max opacity of the overlay.
245. *            Map Id: set the map Id where the overlay is shown. Leaving
246. *                    it to 0 will select the current map.
247. *
248. *          MV format: changeOverlay name x y z opacity mapId
249. *
250. *
251. *     -CENTER OVERLAY (work only for 'MAP OVERLAY')
252. *          This command allow to change the event on which the overlay
253. *          is centered around. By default, map overlays are centered
254. *          around player. This command have no effect on 'SCREEN',
255. *          'FIXED and 'COVER' overlays.
256. *
257. *              Name: select the overlay. Write the same name you used
258. *                    in the map notetag.
259. *          Event Id: set the event Id of the event on which the overlay
260. *                    will be centered around (0 for the player).
261. *            Map Id: set the map Id where the overlay is shown. Leaving
262. *                    it to 0 will select the current map.
263. *
264. *          MV format: centerOverlay name eventId mapId
265. *

复制代码

Spoiler: Terms

                Code:       

1. * ==========================================================================
2. * == Term of Usage =========================================================
3. * ==========================================================================
4. *
5. * Use in any independant RPG Maker MZ or MV projects, including commercials.
6. *
7. * Credit is required for using this Plugin.
8. * For crediting, use 'TSR' along with one of
9. * the following terms:
10. *      'The Northern Frog' or 'A frog from the north'
11. *
12. * Do not change the Header or the Terms of usage.
13. *
14. * DO NOT REDISTRIBUTE!
15. * If you want to share it, share the link to my itch.io account:
16. * https://the-northern-frog.itch.io/
17. *

复制代码

Regards,
TSR



本贴来自国际rpgmaker官方论坛作者:TSR处,因国际论坛即将永久关站,为了存档多年珍贵资料,署名转载到本论坛存档,由于官方帖子为英文原帖，需要中文翻译请点击论坛顶部切换语言为中文就可以将帖子翻译成中文浏览,方便大家随时查看,原文地址：https://forums.rpgmakerweb.com/threads/tsr_mapoverlays.138311/