SimpleOverlay: multilayer system

じ☆ve冰风

Introduction

SimpleOverlay adds any number of image layers onto a map. Layers can be added based on both screen axis and map axis. Layers can move with screen or stay on map. Layers can contain image or tiling image. The position, opacity, and z-index of layer can be assigned. Tiling layers can be animated.

Layer settings are binding to a map and will be automatically saved. Only need to add once per map.

opacity setting: 0-255
z-index setting: -1-11 or greater. -1: below almost everything. 11 above almost everything.

SimpleOverlay AddLayer layerName imageFileName isBindToScreen zIndex opacity xPosition yPosition
eg. SimpleOverlay AddLayer layer1 Fog false 11 100 0 0


SimpleOverlay AddTilingLayer layerName imageFileName isBindToScreen zIndex opacity xPosition yPosition width height xMovement yMovement
eg. SimpleOverlay AddTilingLayer layer2 Fog true 11 100 0 0 800 800 1 0


SimpleOverlay Clear layerName


SimpleOverlay Clear


Terms of Use

Free for non-commercial and commerical use.

Download

See code below.


Known bugs

none

Compatibility

Should be compatible with everything.

                Code:       

1. /*:
2. * @plugindesc Display image layers on screen. Version: 1.0
3. * @author Rui
4. * @help
5. * ----------------------------------------
6. * SimpleOverlay AddLayer layerName imageFileName isBindToScreen zIndex opacity xPosition yPosition
7. * ----------------------------------------
8. * add image layer. layers are saved with map, only need to add once per map. place images in parallaxes folder.
9. * isBindToScreen: if set to "true", image will stay on screen.
10. * xPosition/yPosition: top-left position of layer.
11. * zIndex: if set to "-1", layer is below everything else. if set to 10 or above, layer is above everything else.
12. * opacity: 0-255
13. * eg. SimpleOverlay AddLayer layer1 Fog false 11 100 0 0
14. *
15. *
16. * ----------------------------------------
17. * SimpleOverlay AddTilingLayer layerName imageFileName isBindToScreen zIndex opacity xPosition yPosition width height xMovement yMovement
18. * ----------------------------------------
19. * add image layer. layers are saved with map, only need to add once per map. place images in parallaxes folder.
20. * isBindToScreen: if set to "true", image will stay in screen position.
21. * xPosition/yPosition: top-left position of layer.
22. * width/height: width and height of layer
23. * xMovement/yMovement: animating layer
24. * zIndex: if set to "-1", layer is below everything else. if set to 10 or above, layer is above everything else.
25. * opacity: 0-255
26. * eg. SimpleOverlay AddTilingLayer layer2 Fog true 11 100 0 0 800 800 1 0
27. *
28. *
29. * ----------------------------------------
30. * SimpleOverlay Clear
31. * ----------------------------------------
32. * clear all layers on this map
33. *
34. *
35. * ----------------------------------------
36. * SimpleOverlay Clear layerName
37. * ----------------------------------------
38. * clear layer with layerName
39. *
40. *
41. * License: Free for non-commercial and commercial use
42. */
45. (function() {
46.     //SimpleOverlayObj
47.     function SimpleOverlay() {
48.         this.simpleOverlayObjList = {};    //dictionary with mapID as key
49.     }
51.     SimpleOverlay.prototype.getSimpleOverlayObjListByMapID = function() {
52.         var mapID = $gameMap.mapId().toString();
53.         if (DataManager.___simpleOverlay___.simpleOverlayObjList.hasOwnProperty(mapID)) {
54.             return DataManager.___simpleOverlay___.simpleOverlayObjList[mapID];
55.         }
56.         else {
57.             DataManager.___simpleOverlay___.simpleOverlayObjList[mapID] = [];
58.             return DataManager.___simpleOverlay___.simpleOverlayObjList[mapID];
59.         }      
60.     };
62.     SimpleOverlay.prototype.hasLayer = function(layerName) {
63.         var simpleOverlayObjList = DataManager.___simpleOverlay___.getSimpleOverlayObjListByMapID();
64.         for (var i = simpleOverlayObjList.length - 1; i >= 0; i--) {
65.             if (simpleOverlayObjList[i].layerName === layerName)
66.                 return true;
67.         }
69.         return false;
70.     }
71.   
72.     //SimpleOverlayObj object
73.     function SimpleOverlayObj(layerName, imageFileName, isBindToScreen, zIndex, opacity, xPosition, yPosition, width, height, xMovement, yMovement, isTiling) {
74.         this.layerName = layerName;
75.         this.imageFileName = imageFileName;
76.         this.isBindToScreen = isBindToScreen.toUpperCase() === "TRUE";
77.         this.zIndex = parseInt(zIndex);
78.         this.opacity = parseInt(opacity);
79.         this.xPosition = parseInt(xPosition);
80.         this.yPosition = parseInt(yPosition);
81.         this.width = parseInt(width);
82.         this.height = parseInt(height);
83.         this.xMovement = parseInt(xMovement);
84.         this.xMovement *= -1;
85.         this.yMovement = parseInt(yMovement);
86.         this.isTiling = isTiling.toUpperCase() === "TRUE";
88.         this.delete = false;
90.         DataManager.___simpleOverlay___.getSimpleOverlayObjListByMapID().push(this);
91.     }
93.     //add sprite when creating text or starting scene
94.     SimpleOverlayObj.prototype.addSprite = function(spriteset_Map, x, y) {
95.         if (this.isTiling == false) {
96.             var sprite = new Sprite();
97.             sprite.anchor.x = 0;
98.             sprite.anchor.y = 0;
99.             sprite.z = this.zIndex;
100.             sprite.opacity = this.opacity;
101.             sprite.bitmap = ImageManager.loadParallax(this.imageFileName);
102.             sprite.___simpleOverlayObjRef___ = this;
104.             spriteset_Map._tilemap.addChild(sprite);
106.             sprite.x = x;
107.             sprite.y = y;
108.         }
109.         else {
110.             var sprite = new TilingSprite();
111.             sprite.anchor.x = 0;
112.             sprite.anchor.y = 0;
113.             sprite.z = this.zIndex;
114.             sprite.opacity = this.opacity;
115.             sprite.bitmap = ImageManager.loadParallax(this.imageFileName);
116.             sprite.___simpleOverlayObjRef___ = this;
118.             spriteset_Map._tilemap.addChild(sprite);
120.             sprite.move(x, y, this.width, this.height);
121.         }
122.     };
124.     //update function
125.     SimpleOverlayObj.prototype.update = function(index, spriteset_Map) {
126.         var foundSprite = false;
127.         var child = null;
129.         for (var i = spriteset_Map._tilemap.children.length - 1; i >= 0; i--) {
130.             child = spriteset_Map._tilemap.children[i];
132.             if (typeof(child.___simpleOverlayObjRef___)==='undefined') {
133.                 continue;
134.             }
135.             else {
136.                 if (child.___simpleOverlayObjRef___ == this) {
137.                     foundSprite = true;
138.                   
139.                     if (this.delete == true) {
140.                         child.bitmap = null;
141.                         spriteset_Map._tilemap.removeChildAt(i);
142.                     }
144.                     break;
145.                 }
146.             }
147.         }
149.         if (this.delete == true) {
150.             DataManager.___simpleOverlay___.getSimpleOverlayObjListByMapID().splice(index, 1);
151.             return;
152.         }
154.         //get center position
155.         var centerX = this.xPosition;
156.         var centerY = this.yPosition;
158.         if (this.isBindToScreen == false) {
159.             var tw = $gameMap.tileWidth();
160.             var th = $gameMap.tileHeight();
162.             var scrolledX = $gameMap.adjustX(this.xPosition / tw);
163.             var scrolledY = $gameMap.adjustY(this.yPosition / th);
165.             var screenX = Math.round(scrolledX * tw);
166.             var screenY = Math.round(scrolledY * th + th);
168.             centerX = screenX;
169.             centerY = screenY - $gameMap.tileHeight();
170.         }
172.         //update sprite position
173.         if (foundSprite == false) {
174.             child = this.addSprite(spriteset_Map, centerX, centerY);
175.         }
176.         else {
177.             if (this.isTiling == false) {
178.                 child.x = centerX;
179.                 child.y = centerY;
180.             }
181.             else {
182.                 child.move(centerX, centerY, this.width, this.height);
183.                 child.origin.x += this.xMovement;
184.                 child.origin.y += this.yMovement;
185.             }
186.         }
187.     };
189.     //create SimpleOverlay in DataManager
190.     var _DataManager_createGameObjects = DataManager.createGameObjects;
191.     DataManager.createGameObjects = function() {
192.         _DataManager_createGameObjects.call(this);
194.         if (typeof(DataManager.___simpleOverlay___)==='undefined')
195.             DataManager.___simpleOverlay___ = new SimpleOverlay();
196.     };
198.     //add sprites on createTilemap
199.     var _Spriteset_Map_prototype_createTilemap = Spriteset_Map.prototype.createTilemap;
200.     Spriteset_Map.prototype.createTilemap = function() {
201.         _Spriteset_Map_prototype_createTilemap.call(this);
203.         //remove all layer sprites if exits
204.         for (var i = this._tilemap.children.length - 1; i >= 0; i--) {
205.             var child = this._tilemap.children[i];
207.             if (typeof(child.___simpleOverlayObjRef___)==='undefined') {
208.                 continue;
209.             }
210.             else {
211.                 child.bitmap = null;
212.                 this._tilemap.removeChildAt(i);
213.             }
214.         }
215.     }
216.   
217.     //update SimpleOverlayObjList
218.     var _Spriteset_Map_prototype_updateTilemap = Spriteset_Map.prototype.updateTilemap;
219.     Spriteset_Map.prototype.updateTilemap = function() {
220.         _Spriteset_Map_prototype_updateTilemap.call(this);
222.         var simpleOverlayObjList = DataManager.___simpleOverlay___.getSimpleOverlayObjListByMapID();
223.         for (var i = simpleOverlayObjList.length - 1; i >= 0; i--)
224.             simpleOverlayObjList[i].update(i, this);
225.     };
227.     //read plugin command
228.     var _Game_Interpreter_prototype_pluginCommand = Game_Interpreter.prototype.pluginCommand;
229.     Game_Interpreter.prototype.pluginCommand = function(command, args) {
230.         _Game_Interpreter_prototype_pluginCommand.call(this, command, args);
231.       
232.         //only work with Scene_Map
233.         if (SceneManager._scene instanceof Scene_Map == false)
234.             return;
236.         var argsLength = args.length;
237.         var action = args[0].toUpperCase();
238.         if (action == "ADDLAYER") {
239.             if (argsLength == 8) {
240.                 var layerName = args[1];
241.                 if (DataManager.___simpleOverlay___.hasLayer(layerName) == true)
242.                     return;
244.                 var simpleOverlayObj = new SimpleOverlayObj(args[1], args[2], args[3], args[4], args[5], args[6], args[7], "0", "0", "0", "0", "FALSE");
245.             }
246.         }
247.         else if (action == "ADDTILINGLAYER") {
248.             if (argsLength == 12) {
249.                 var layerName = args[1];
250.                 if (DataManager.___simpleOverlay___.hasLayer(layerName) == true)
251.                     return;
253.                 var simpleOverlayObj = new SimpleOverlayObj(args[1], args[2], args[3], args[4], args[5], args[6], args[7], args[8], args[9], args[10], args[11], "TRUE");
254.             }
255.         }
256.         else if (action == "CLEAR") {
257.             if (argsLength == 2) {
258.                 var layerName = args[1];
259.                 var simpleOverlayObjList = DataManager.___simpleOverlay___.getSimpleOverlayObjListByMapID();
260.                 for (var i = simpleOverlayObjList.length - 1; i >= 0; i--) {
261.                     if (simpleOverlayObjList[i].layerName === layerName)
262.                         simpleOverlayObjList[i].delete = true;   
263.                 }
264.             }
265.             else if (argsLength == 1) {
266.                 var simpleOverlayObjList = DataManager.___simpleOverlay___.getSimpleOverlayObjListByMapID();
267.                 for (var i = simpleOverlayObjList.length - 1; i >= 0; i--) {
268.                     simpleOverlayObjList[i].delete = true;
269.                 }
270.             }
271.         }
272.     };
273. })();

复制代码

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