# 个性化 ?> 目前版本**v2.4**,上次更新时间:* {docsify-updated} * 有时候只靠样板本身可能是不够的。我们需要一些个性化、自定义的素材,道具效果,怪物属性,等等。 ## 图层的说明 HTML5魔塔是使用画布(canvas)来绘制,存在若干个图层,它们之间有一个覆盖关系,后面的图层将覆盖前面的图层。 所有图层从低往高依次如下: - bg:背景层;绘制地面素材,或者作为背景的图片素材 - event:事件层;所有事件(道具、墙壁、NPC、怪物等)都绘制在这一层进行处理 - hero:勇士层;主要用来绘制勇士 - event2:事件2层;本层主要用来绘制48x32的图片素材的上半部分(避免和勇士错位),也可以用来绘制该层的前景图片素材 - fg:显伤层;主要用来绘制怪物显伤和领域显伤 - animate:动画层;主要用来绘制动画。showImage事件绘制的图片也是在这一层。 - weather:天气层;主要用来绘制天气(雨/雪) - curtain:色调层;用来控制当前楼层的画面色调 - route:路线层;主要用来绘制勇士的行走路线图,也用来绘制图块的淡入/淡出效果,图块的移动等。 - ui:UI层;用来绘制一切UI窗口,如剧情文本、怪物手册、楼传器、系统菜单等等 - data:数据层;用来绘制一些顶层的或更新比较快的数据,如左上角的提示,战斗界面中数据的变化等等。 ## 自定义素材 所有素材的图片都在`images`目录下。 - `animates.png` 为所有动画效果。主要是星空熔岩,开门,毒网,传送门之类的效果。为四帧。 - `autotile.png` 为Autotile块。 - `enemys.png` 为所有怪物的图片。 - `enemy48.png` 为所有48x32怪物的图片。 - `heros.png` 为勇士行走图。 - `items.png` 为所有道具的图标。 - `npcs.png` 为所有NPC的图标。 - `npc48.png` 为所有48x32的NPC图标。 - `terrains.png` 为所有地形的图标。 系统会读取`icon.js`文件,并获取每个ID对应的图标所在的位置。 ### 使用预定义的素材 在images目录的“默认素材”下给定了若干预定义的自定义素材。 如果你需要某个素材已经存在,则可以直接将其覆盖images目录下的同名文件,就能看到效果。 ### 使用自己的图片作为某层楼的背景/前景素材 由于HTML5功能(素材)有限,导致了对很多比较复杂的素材(比如房子内)等无法有着较好的绘图方式。 为了解决这个问题,我们允许用户自己放置一张或多张图片作为某一层的背景素材。 要启用这个功能,我们首先需要在`data.js`中将可能的图片进行加载。 ``` js "images": [ // 在此存放所有可能使用的图片 // 图片可以被作为背景图(的一部分),也可以直接用自定义事件进行显示。 // 图片名不能使用中文,不能带空格或特殊字符;可以直接改名拼音就好 // 建议对于较大的图片,在网上使用在线的“图片压缩工具(http://compresspng.com/zh/)”来进行压缩,以节省流量 "bg.jpg", "house.png", "bed.png"// 依次向后添加 ]; ``` !> 请使用网上的一些[在线图片压缩工具](http://compresspng.com/zh/)对图片进行压缩,以节省流量。 之后,我们可以在每层剧本的`"images"`里来定义该层的默认背景图片素材。 ``` js "images": [[3,5,"bg.jpg",0]], // 背景图;你可以选择一张或多张图片来作为背景/前景素材。 "images": [], // 无任何背景图 "images": [[1,1,"house.png",0], [6,7,"bed.png",1]] // 在(1,1)放一个house.png在背景层,且(6,7)放bed.png在前景层 "images": [[3,5,"tree.png",2]] // 如果写2,则会自动调节遮挡效果 ``` images为一个数组,代表当前层所有作为背景素材的图片信息。 每一项为一个四元组,分别为该背景素材的x,y,图片名和遮挡方式。其中x和y分别为横纵坐标,在0-12之间;图片名则必须在上面的images中定义过。 第四项为遮挡方式,定义如下: - 0:该图片将全部画在背景层,被勇士所遮挡。举例:某些特殊地形等。 - 1:该图片将全部画在前景层,可以遮挡勇士。举例:云彩等效果。 - 2:该图片将上部分画在前景层,下部分画在背景层。从而可以达到一个“自动调节遮挡的效果”。举例:树、房子等等。 !> 如果写2的话,请确保图片高度是32的倍数! **如果你需要让某些点不可通行(比如你建了个房子,墙壁和家具等位置不让通行),则需在`events`中指定`{"noPass": false}`,参见[自定义事件](event#自定义事件)的写法。** ``` js "events": { "x,y": {"noPass": true} // (x,y)点不可通行 } ``` ### 使用便捷PS工具生成素材 如果我们有更多的素材要求,我们可以使用“便捷PS工具”进行处理。  我们可以打开有需求改变的素材,和我们需要被替换的素材,然后简单的Ctrl+C和Ctrl+V操作即可。 便捷PS工具同样支持图片色相的修改,和RMXP几乎完全相同。 用这种方式,我们能极快地替换或素材,包括需要新增的怪物。 ### 添加素材到游戏 在使用地图编辑器编辑的过程中,我们有可能会出现“该数字和ID未被定义”的错误提示。 这是因为,该素材没有被定义,无法被游戏所识别。 !> 在V2.0中,我们可以简单的在地图编辑器中新增素材,以及定义新增素材的ID和数字,但是仍然**强烈建议**对素材的机制进行了解。 #### 素材的机制 本塔所有的素材都拥有三个属性:**ID**,**索引**,**数字**。 - **ID** 为该素材的唯一标识符,任何两个素材的ID都不能相同。 - **索引** 为该素材的在对应图片上的图标索引,即该素材是图片上的第几个。 - **数字** 为该素材的对应数字,以方便地图的生成和存储。 **`ID-索引` 对应关系定义在icons.js文件中。该文件将唯一确定一个ID在图片上所在的位置。** **`ID-数字` 对应关系定义在maps.js文件中。该文件将唯一确定一个ID对应的数字是多少。** 在V2.0中,我们可以在地图编辑器中很方便查看每个图块的三个属性信息。 #### 注册素材 在V2.0的地图编辑器中,要注册新素材,我们只需要在图块属性一栏输入新素材的ID和数字。  ID必须由数字字母下划线组成,数字在1000以内,且均不能和已有的进行重复。 之后刷新编辑器即可。 对于怪物和道具,我们也可以进行自动注册,只需要点击“自动注册”按钮,将对该栏下所有未注册的素材进行自动注册(自动分配ID和数字)。 素材注册完毕后,即可在游戏中正常使用,也可以被地图生成器所识别(需要重开地图生成器)。 #### Autotile的注册 但是,通过上面这种方式,我们是没办法新增并注册Autotile的。 除了替换样板现有的几个外,如果我们还需要新添加Autotile,则: 1. 将新的Autotile图片复制到images目录下。文件名必须是字母数字和下划线组成。 2. 进入icons.js,在autotile分类下进行添加该文件的名称,索引简单的写0。 3. 指定一个数字,在maps.js中类似进行添加。 !> Autotile的ID和文件名应确保完全相同! ### 地图生成器使用自定义素材 地图生成器是直接从js文件中读取数字-图标对应关系的。 因此,在你修改了icons.js和maps.js两个文件,也就是将素材添加到游戏后,地图生成器的对应关系也将同步更新。 ## 自定义道具效果 本节中将继续介绍如何自己编辑一个道具的效果。 道具效果的具体实现都在`items.js`中。 ### 即捡即用类道具(cls: items) 对于即捡即用类道具,如宝石、血瓶、剑盾等,我们可以简单地修改`data.js`中的value一栏即可。 如果你想要同种宝石在不同层效果不同的话,可以进行如下操作: 1. 在楼层的item_ratio中定义宝石的比率(比如1-10的写1,11-20层写2等) 2. 修改获得道具的itemEffect函数(编辑器中双击进行编辑) ``` js // ratio为楼层的item_ratio值,可以进行翻倍宝石属性 core.status.hero.atk += core.values.redJewel * ratio ``` 这里我们可以直接写ratio来取用该楼层中定义的`item_ratio`的值。 如果不是倍数增加(比如线性增加)也可以类似来写 ``` js // 一个二倍线性增加的例子 core.status.hero.atk += core.values.redJewel + 2*ratio ``` ### 消耗类道具(cls: tools);永久类道具(cls: constants) 如果要自己实现消耗类道具或永久类道具的使用效果,则需修改`items.js`中的canUseItem和useItem两个函数。 具体过程比较复杂,需要一定的JS能力,在这里就不多说了,有需求可以找`艾之葵`进行了解。 但值得一提的是,我们可以使用`core.hasItem(name)` 来判断是否某个道具是否存在。例如下面是passNet(通过路障处理)的一部分: ``` js /****** 经过路障 ******/ events.prototype.passNet = function (data) { // 有鞋子 if (core.hasItem('shoes')) return; if (data.event.id=='lavaNet') { // 血网 // ... 下略 ``` 我们进行了一个简单的判断,如果拥有绿鞋,则不进行任何路障的处理。 ### 实战!拿到神圣盾后免疫吸血、领域、夹击效果 1. 在itemEffect中修改拿到神圣盾时的效果,标记一个自定义Flag。 ``` js core.status.hero.def += core.values.shield5 * ratio; core.setFlag("shield5", true); // 增加一个自定义Flag:已经拿到神圣盾 ``` 2. 免疫吸血效果:在`enemys.js`的伤害计算中,编辑成如果存在神圣盾标记,吸血伤害为0。 ``` js enemys.prototype.calDamage = function (monster, hero_hp, hero_atk, hero_def, hero_mdef) { // ... 上略 // 吸血 if (this.hasSpecial(mon_special, 11)) { var vampireDamage = hero_hp * monster.value; // 如果有神圣盾免疫吸血等可以在这里写 if (core.hasFlag("shield5")) vampireDamage = 0; // 存在神圣盾,吸血伤害为0 vampireDamage = Math.floor(vampireDamage) || 0; // 加到自身 if (monster.add) // 如果加到自身 mon_hp += vampireDamage; initDamage += vampireDamage; } // ... 下略 ``` 3. 免疫领域、夹击、阻击效果:在`control.js`中,找到checkBlock函数,并编辑成如果有神圣盾标记,则将伤害变成0。 ``` js // 检查领域、夹击、阻击事件 control.prototype.checkBlock = function () { var x=core.getHeroLoc('x'), y=core.getHeroLoc('y'); var damage = core.status.checkBlock.damage[x+core.bigmap.width*y]; if (damage>0) { if (core.hasFlag("shield5")) damage = 0; // 如果存在神圣盾,则将伤害变成0 core.status.hero.hp -= damage; // 检查阻击事件 var snipe = []; var scan = { 'up': {'x': 0, 'y': -1}, 'left': {'x': -1, 'y': 0}, 'down': {'x': 0, 'y': 1}, 'right': {'x': 1, 'y': 0} } // ... 下略 ``` 4. 如果有更高的需求,例如想让吸血效果变成一半,则还是在上面这些地方进行对应的修改即可。 ## 新增门和对应的钥匙 如果要新增一个门和对应的钥匙,需要进行如下几步: 1. 在terrains.png中添加新的门的素材,并在地图编辑器中注册门的ID。该ID必须是以`Door`结尾,例如`abcDoor`。 2. 在animates.png中添加开门的四格动画,然后直接打开icons.js文件,在animates下直接添加ID和索引信息,例如`'abcDoor': 34`。 3. 在items.png中添加钥匙的素材,并在地图编辑器中注册钥匙的ID。该ID必须是和门对应且以`Key`结尾,例如`abcKey`。 4. 该道具的cls应为`tools`,可以自行写道具描述,最下面几项均留`null`即可。 !> **请勿在animates中对门的动画素材进行注册!而是请直接打开icons.js文件并添加ID和索引信息!!!** !> terrains和animates的门ID必须完全一致,且以`Door`结尾;所对应的钥匙ID应当是把`Door`换成`Key`,这样才能对应的上! ## 覆盖楼传事件 对于特殊的塔,我们可以考虑修改楼传事件来完成一些特殊的要求,比如镜子可以按楼传来切换表里。 要修改楼传事件,需要进行如下几步: 1. 截获楼传的点击事件。在control.js中找到useFly函数,并将其替换成如下内容: ``` js ////// 点击楼层传送器时的打开操作 ////// control.prototype.useFly = function (need) { if (!core.status.heroStop) { core.drawTip("请先停止勇士行动"); return; } if (core.canUseItem('fly')) core.useItem('fly'); else core.drawTip("当前无法使用"+core.material.items.fly.name); } ``` 2. 让录像记下楼传的使用。在items.js的useItem函数中找到记录路线的那几行,修改为: ``` js // 记录路线 if (itemId!='book') { // 把 `&& itemId!='fly'` 给删除 core.status.route.push("item:"+itemId); } ``` 3. 修改楼传的使用事件。和其他永久道具一样,在地图编辑器的图块属性中修改楼传的useItemEffect和canUseItemEffect两个内容。例如: ``` js "useItemEffect": "core.insertAction([...])" // 执行某段自定义事件,或者其他脚本 "canUseItemEffect": "true" // 任何时候可用 ``` 修改时,请先把`null`改成空字符串`""`,然后再双击进行编辑。 ## 自定义装备 由于HTML5魔塔并不像RM那样存在一个装备界面可供我们对装备进行调整,但是我们也可以使用一个替代的方式实现这个目标。 ### 装备的实现原理 在HTML5中,装备将全部看成是永久道具(constants),同时对于每个装备位置,勇士都定义一个flag域表示正在装备的内容。 例如:当勇士获得银剑时,将获得一个永久道具“银剑”;当使用这个银剑,首先检查勇士当前是否装备了武器(比如铁剑),如果 装备了则先脱掉装备(减去已装备的铁剑所加的属性,并获得永久道具铁剑),然后再穿上新的银剑。 同时由于脱剑术和脱盾术的存在,我们还需要一个“脱掉装备”的永久道具(比如sword0),使用它可以脱掉对应位置的装备。 ### 装备加值的修改 要启用装备,首先需要在data.js(全塔属性)中设置`'equipment': true`。此时,游戏内将自动将剑盾变成装备的存在,其 所加的数值就是全塔属性中对应的数值(比如铁剑sword1就加的全塔属性中sword1的值)。 有时候,我们还会有一个装备加多种属性的需求,此时需要将对应的项从数值改变成一个对象。 ``` js "sword1": {"atk": 10, "def": 0, "mdef": 5}, // 铁剑加10攻和5魔防 "shield1": {"atk": 0, "def": 10, "mdef": 10}, // 铁盾加10防和10魔防 ``` 通过这种方式,当穿上装备时,将会给你的三围分别加上对应项的数值(支持负数,比如装剑减防御)。 ### 新增剑盾 样板默认提供了铁剑(盾),银剑(盾),骑士剑(盾),圣剑(盾)和神圣剑(盾)这五类装备。但有时候,五类是不够的, 我们可能还需要更多的剑盾。 要增加更多的剑盾,我们需要进行如下步骤:(以新增剑为例) 1. 新注册一个素材到游戏;**其ID必须是sword+数字的形式,比如sword6等。**(同理如果是盾就必须是shield+数字的形式比如shield6。) 2. 将其cls设置为`constants`,`useItemEffect`和`canUseItem`直接复制其他几个剑盾的内容。 (即:`useItemEffect`必须为`"core.plugin.useEquipment(itemId)"`,`canUseItemEffect`必须为`"true"`)。 3. 使用VSCode或其他文本编辑器直接打开`data.js`文件,并在`"values"`中仿照已有的内容添加剑盾的属性。 (例如:`"sword6": 100`,或者`"sword6": `{"atk": 100, "def": 0, "mdef": 50}`) !> 请注意:新的剑的ID必须是sword+数字,新的盾的ID必须是shield+数字的形式,不然装备将无效! ### 新增其他部位的装备 如果我们还需要新增更多部位的装备,比如戒指、首饰等等,也是可以的,只需要依次进行如下步骤:(以新建戒指为例) 1. 选择一个装备的部位的ID;比如假设我们的装备部位为戒指,那么我们可以选择"ring"作为装备的部位。 2. 定义一个空戒指,相当于脱掉戒指。注册一个素材到游戏,**其ID必须是ring0**(即部位ID+数字0)。 3. 同上述新建剑盾的方式来设置ring0这个空戒指的属性。请注意打开data.js后,设置的其值必须为0。 (即:必须是`"ring0": 0`) 3. 创建更多的戒指;每加一个新的戒指到游戏,其ID必须是**ring+数字**的形式,比如`ring1`, `ring2`,等等。 4. 对于每一个创建的戒指,按照上述新建剑盾的方式设置属性(图块属性,打开data.js直接编辑)。 (例如:`"ring2": {"atk": 3, "def": 5, "mdef": 8}`) 5. **切换到脚本编辑 - 自定义插件编写,在`this.useEquipment`中仿照着新增一行代表戒指的使用。** ``` js this.useEquipment = function (itemId) { // 使用装备 _useEquipment(itemId, "sword", "atk"); // 剑 _useEquipment(itemId, "shield", "def"); // 盾 _useEquipment(itemId, "ring", "mdef"); // 新增的戒指 } ``` 我们仿照着新增一行`_useEquipment(itemId, "ring", "mdef")`。 其中第二项为装备部位的ID,比如我们上述定义的是ring;第三项表示“如果values中该值为数字,则加到什么属性上”。 比如如果我们这里写mdef,那么我们假设在data.js的values中设置`"ring1": 20`,则使用该戒指会增加20点魔防。 如果你定义的是对象`{"atk": xxx, "def": xxx, "mdef": xxx}`的形式,则不会受到第三项的影响。 !> 必须对于每一个装备部位定义唯一一个不同的ID;脱掉装备(空装备)必须是该ID加数字0的形式,其他有效装备必须是 该ID+正整数的形式,不然会出错! ## 自定义怪物属性 如果你对现有的怪物不满意,想自行添加怪物属性也是可以的。具体参见脚本编辑-getSpecials。 你需自己指定一个special数字,修改属性名和属性提示文字。后两者可以直接写字符串,或写个函数传入怪物。 如果要修改伤害计算公式,请修改下面的getDamageInfo函数。请注意,如果无法战斗,该函数必须返回`null`。 !> 如果改动了伤害计算公式,可能导致临界计算崩掉,因此建议将全塔属性中的`useLoop`置为true。 对于毒衰弱怪物的战斗后结算在脚本编辑中的afterBattle函数中。 对于领域、夹击、阻击怪物的检查在`control.js`中的checkBlock函数中。 ## 自定义快捷键 如果需要绑定某个快捷键为处理一段事件,也是可行的。 要修改按键,我们可以在`actions.js`的`keyUp`进行处理: 比如,我们设置一个快捷键进行绑定,比如`W`,其keycode是87。(有关每个键的keycode搜一下就能得到) 然后在`actions.js`的`keyUp`函数的`switch`中进行处理。 ``` js case 87: // W if (core.status.heroStop) { // ... 在这里写你要执行脚本 // 请使用同步脚本,请勿执行任何异步代码,否则可能导致游戏过程或录像出现问题。 core.insertAction([...]) // 例如,插入一段自定义事件并执行。 core.status.route.push("key:"+keyCode); // 录像的支持!这句话必须要加,不然录像回放会出错! } break; ``` 在勇士处于停止的条件下,按下W键时,将执行你写的脚本代码。请只使用同步脚本而不要使用异步代码,不然可能导致游戏出现问题。 `core.status.route.push("key:"+keyCode);` 这句话是对录像的支持,一定要加(这样录像播放时也会模拟该按键)。 !> H5不支持组合快捷键,所以不存在`W+1`这种组合快捷键的说法! !> 手机端可以通过长按任何位置调出虚拟键盘,再进行按键,和键盘按键是等价的效果! ## 公共事件 在RM中,存在公共事件的说法;也就是通过某个指令来调用一系列事件的触发。 在H5中,我们可以使用“插件”的形式来达成这个效果。具体参见“脚本编辑 - 插件编写”。  当我们在这上面定义了自己需要的函数(插件后),就可以通过任何方式进行调用。 在这个插件编写的过程中,我们可以使用任何[常见API](api)里面的代码调用;也可以通过`core.insertAction`来插入自定义事件执行。 下面是一个很简单的例子,我编写一个公共事件(插件),其效果是让勇士生命值变成原来的x倍,并令面前的图块消失。 ``` js this.myfunc = function(x) { core.status.hero.hp *= x; // 勇士生命翻若干倍 core.insertAction([ // 自定义事件:令面前的图块消失。 {"type": "setValue", "name": "flag:x", "value": "core.nextX()"}, {"type": "setValue", "name": "flag:y", "value": "core.nextY()"}, {"type": "hide", "loc": ["flag:x", "flag:y"]} ]); } ``` 然后比如我们在某个道具的使用效果 `useItemEffect` 中写 `core.plugin.myfunc(2)` 即可调用此公共事件(插件)。也可以在战后事件或自定义脚本等位置来写。 通过这种,将脚本和自定义事件混用的方式,可以达到和RM中公共事件类似的效果,即一个调用触发一系列事件。 ## 自定义状态栏(新增显示项) 在V2.2以后,我们可以自定义状态栏背景图(全塔属性 - statusLeftBackground)等等。 但是,如果我们还想新增其他项目的显示,比如技能塔所需要的魔力值(气息),该怎么办? 需要进行如下几个操作: 1. 定义图标ID;比如魔力我就定义mana,气息可以简单的定义qixi;你也可以定义其他的ID,但是不能和已有的重复。这里以mana为例。 2. 在index.html的statusBar中(44行起),进行该状态栏项的定义。仿照其他几项,插在其应当显示的位置,注意替换掉相应的ID。 ``` html