角色命令详解

深林孤鹰2024/8/14...大约 13 分钟约 3784 字

一、说明

创建地图主角

功能：创建地图主角。

参数：

role 为角色资源名或标准创建格式的对象。
- 参数对象属性：$id、$name、$showName、$scale、$speed、$penetrate、$realSize、$avatar、$avatarSize、$x、$y、$bx、$by、$direction、$action、$targetBx、$targetBy、$targetX、$targetY、$targetBlocks、$targetPositions、$targetBlockAuto；
- RID 为要创建的角色资源名；
- $id 为角色对象id（默认为 $name 值），id存在则会复用组件；$name 为游戏显示名（默认为RID值）；
- $showName 为是否头顶显示名字；$scale 为缩放倍率数组（横竖坐标轴方向）；$speed 为移动速度；$penetrate 为是否可穿透；$realSize 为影子大小；$avatar 为头像文件名；$avatarSize 为头像大小；这几个属性会替换已设置好的角色资源的属性；
- $x、$y 是像素坐标；$bx、$by 是地图块坐标（像素坐标和块坐标设置二选一）；
- $direction表示面向方向（0、1、2、3分别表示上右下左）；
- $action：
  - 为 0 表示暂时静止；为 1 表示随机移动；为 -1 表示禁止移动和操作；
  - 为 2 表示定向移动；此时（用其中一个即可）：
    - $targetBx、$targetBy 为定向的地图块坐标
    - $targetX、$targetY 为定向的像素坐标；
    - $targetBlocks 为定向的地图块坐标数组;
    - $targetPositions 为定向的像素坐标数组;
    - $targetBlockAuto 为定向的地图块自动寻路坐标数组；
- $start 表示角色是否自动动作（true 或 false)；

返回：成功为组件对象，失败为false。

示例：

let h = game.createhero({RID: '角色资源名', /*。。。其他属性*/});

let h = game.createhero('角色资源名');   //全部使用默认属性；

game.createhero(role={});

返回/修改地图主角组件对象

功能：返回/修改地图主角组件对象。

参数：

hero 可以是下标，或字符串（主角的 $id），或主角组件对象，-1表示返回所有主角组件对象数组；
props：hero 不是-1时，为修改单个主角的属性，同 createhero 的第二个参数对象；

返回：经过 props 修改的主角或所有主角的列表；如果没有则返回 null；出错返回 false；

示例：

let h = game.hero('主角名');

let h = game.hero(0, {$bx: 10, $by: 10, $showName: 0,/*。。。其他属性*/});

game.hero(hero=-1, props={});

删除地图主角

功能：删除地图主角；

参数：hero 可以是下标，或主角的 $id，或主角组件对象，-1 表示所有主角；

返回：删除成功返回 true；没有或错误返回 false；

示例：

game.delhero('地图主角名');

game.delhero(hero=-1);

移动主角

功能：将主角移动到地图 bx、by 位置。

参数：

bx、by 为目标地图块；如果超出地图，则自动调整；

示例：

game.movehero(6,6);

game.movehero(bx, by);

创建地图NPC

功能：创建地图NPC。

参数：

role 为角色资源名或标准创建格式的对象（RID为角色资源名）；
- 参数对象属性：同 createhero 参数；

返回：成功为组件对象，失败为 false。

示例：

game.createrole(role={});

返回/修改地图NPC组件对象

功能：返回/修改地图NPC组件对象。

参数：

role 可以是字符串（NPC的 $id），或NPC组件对象，-1 表示返回所有NPC组件对象数组；
props：role 不是-1时，为修改单个NPC的属性，同 createhero 的第二个参数对象；

返回：经过 props 修改的 NPC 或所有NPC的列表；如果没有则返回 null；出错返回 false；

示例：

let h = game.role('NPC的$id');

let h = game.role('NPC的$id', {$bx: 10, $by: 10, $showName: 0, /*。。。其他属性*/});

game.role(role=-1, props={});

删除地图NPC

功能：删除地图NPC；

参数：

role 可以是NPC的 $id，或NPC组件对象，-1 表示当前地图所有NPC；

返回：删除成功返回 true；没有或错误返回 false；

示例：

game.delrole('地图NPC的$id');

game.delrole(role=-1);

移动NPC

功能：将NPC移动到地图 bx、by 位置。

参数：

bx、by 为目标地图块；如果超出地图，则自动调整；

示例：

game.moverole('NPC的$id',6,6);

game.moverole(bx, by, role);

返回角色坐标

功能：返回角色的各种坐标，或判断是否在某个地图块坐标上；

参数：

role 为角色组件（可用 hero 和 role 命令返回的组件）；
- 如果为数字或空，则是主角；如果是字符串表示 $id，会在主角和NPC 中查找；
pos 为 [bx,by]，返回角色是否在这个地图块坐标上；如果为空则表示返回角色中心所在各种坐标；

返回：如果是判断，返回 true 或 false；如果返回是坐标，则包括 x、y（实际坐标）、bx、by（地图块坐标）、cx、cy（中心坐标）、rx1、ry2、rx2、ry2（影子的左上和右下坐标）、sx、sy（视窗中的坐标）；出错返回 false；

示例：

game.rolepos(role, pos=null);

创建战斗主角

功能：创建一个战斗主角，并放入我方战斗队伍。

参数：

fightrole 为战斗主角资源名或标准创建格式的参数对象（具有 RID、Params 和其他属性）。

返回：战斗主角对象。

示例：

game.createfighthero('战斗角色1');

game.createfighthero({RID: '战斗角色2', Params: {级别: 6}, $name: '鹰战士'});

game.createfighthero(fightrole);

删除我方战斗主角

功能：删除我方战斗队伍中的一个战斗主角。

参数：

fighthero 为下标，或战斗角色的 $name，或战斗角色对象，或 -1（删除所有战斗主角）。

返回：成功返回 true；错误或没找到返回 false。

示例：

game.delfighthero(0);

game.delfighthero('鹰战士');

game.delfighthero(fighthero);

返回我方战斗主角

功能：返回我方战斗队伍中的战斗主角；

参数：

fighthero 为下标，或战斗角色的 name，或战斗角色对象，或 -1（返回所有战斗主角）；
type 为 0 表示返回对象，为 1 表示只返回名字（可用作选择组件）；

返回：战斗角色对象、名字字符串或数组；false 表示没找到或出错；

示例：

let h = game.fighthero('鹰战士');

let h = game.fighthero(0);

let arrNames = game.fighthero(-1, 1);

game.fighthero(fighthero=-1, type=1);

添加技能

功能：添加技能；

参数：

fighthero 为下标，或战斗角色的 name，或战斗角色对象；
skill 为技能资源名，或标准创建格式的对象（带有 RID、Params 和其他属性），或技能本身（带有 $rid）；
skillIndex 为替换到第几个（如果为-1或大于已有技能数，则追加）；
copyedNewProps 是从 skills 复制的创建的新技能的属性（skills 为技能对象才有效，复制一个新技能同时再复制 copyedNewProps 属性）；

返回：成功返回 true；

示例：

game.getskill(fighthero, skill, skillIndex=-1, copyedNewProps={});

移除技能

功能：移除技能；

参数：

fighthero为下标，或战斗角色的 name，或战斗角色对象；
skill：技能下标（-1 为删除所有符合 filters 的技能），或技能资源名（符合 filters 的技能）；
filters：技能条件筛选；

返回：成功返回 skill 对象的数组；失败返回 false；

示例：

game.removeskill(fighthero, skill=-1, filters={});

返回技能信息

功能：返回技能信息；

参数：

fighthero 为下标，或战斗角色的 name，或战斗角色对象；
skill：技能下标（-1 为所有符合 filters 的技能），或技能资源名（符合 filters 的技能）；
filters：技能条件筛选；

返回：成功返回技能数组；

示例：

game.skill(fighthero, skill=-1, filters={});

战斗角色修改属性

功能：战斗角色修改属性

参数：

fighthero 为下标，或战斗角色的name，或战斗角色对象；
props：对象；Key 可以为属性或属性,下标，Value 可以为数字（字符串属性或n段属性都修改）或数组（针对n段属性，对应修改）；
- 支持格式：{HP: 6, HP: [6,6,6], 'HP,2': 6}
type 为 1 表示加，为 2 表示乘，为 3 表示赋值，为 0 表示将n段值被n+1段值赋值；
- type 如果为数组，第一个值为上面的含义，第二个表示乘的时候参考属性（0 为 properties，1 为 propertiesWithExtra）；
flags：从左到右：是否检测升级，是否调用刷新函数（如果修改一些不用刷新的属性，就不用刷新）；

返回：成功返回战斗角色对象；失败返回 false；

示例：

game.addprops(fighthero, props={}, type=[1,1], flags=0b11);

升级

功能：直接升一级。

参数：

fighthero：为下标，或战斗角色的 name，或战斗角色对象；

示例：

game.levelup('鹰战士');

game.levelup(fighthero);

添加道具

功能：背包内获得 count 个道具；

参数：

goods 可以为道具资源名、或标准创建格式的对象（带有 RID、Params 和其他属性），或道具本身（带有 $rid），或下标；
count 为 0 表示使用 goods 内的 $count；

返回：返回背包中改变后道具个数，返回 false 表示错误。

示例：

game.getgoods(goods, count=0);

减少道具

功能：背包内减去 count 个道具；

参数：

goods 可以为道具资源名、道具对象和下标；
count 为个数，如果为 true 则表示道具的所有；
- 如果装备数量不够，则返回<0（相差数），原道具数量不变化；

返回：返回背包中改变后道具个数，返回 false 表示错误；

示例：

game.removegoods(goods, count=1);

获得道具信息

功能：获得道具列表中某项道具信息；

参数：

goods 为 -1 表示返回所有道具的数组（此时 filters 是道具属性的过滤条件）；
- goods 为数字（下标），则返回单个道具信息的数组；
- goods 为字符串（道具资源名），返回所有符合道具信息的数组（此时 filters 是道具属性的过滤条件）；

返回：道具数组。

示例：

game.goods(goods=-1, filters={});

使用道具

功能：使用道具（会执行道具use脚本）；

参数：

fighthero 为下标，或战斗角色的 name，或战斗角色对象，也可以为 null 或 undefined；
goods 可以为道具资源名、道具对象和下标。

示例：

game.goods(goodsFilter=-1);

yield game.usegoods(goods, fighthero, params);

直接装备道具

功能：直接装备一个道具（不是从背包中）；

参数：

fighthero为下标，或战斗角色的 name，或战斗角色对象；
goods可以为道具资源名、或标准创建格式的对象（带有 RID、Params 和其他属性），或道具本身（带有 $rid），或下标；
newPosition：如果为空，则使用 goods 的 position 属性来装备；
copyedNewProps是从 goods 复制的创建的新道具的属性（goods 为道具对象才有效，复制一个新道具同时再复制（覆盖）copyedNewProps 属性，比如 $count、$position）；

返回：返回 null 表示错误；

注意：会将目标装备移除，需要保存则先 unload 到 getgoods；

示例：

yield game.equip(fighthero, goods, newPosition=undefined, copyedNewProps={$count: 1});

卸下装备

功能：卸下某装备（所有个数）；

参数：

fighthero 为下标，或战斗角色的 name，或战斗角色对象；

返回：返回旧装备对象，没有返回undefined；

示例：

game.unload(fighthero, positionName);

返回战斗角色的装备

功能：返回某 fighthero 的装备；如果 positionName 为 null，则返回所有装备的数组；

参数：

fighthero 为下标，或战斗角色的 name，或战斗角色对象；

返回：全部装备的数组或某一个位置的装备。错误返回false；

示例：

game.equipment(fighthero, positionName=null);

进入战斗

功能：载入 fightScript 脚本并进入战斗；

参数：

fightScript：可以为战斗脚本资源名、标准创建格式的对象（带有 RID、Params 和其他属性），或战斗脚本对象本身（带有 $rid）；
params：是给战斗脚本 $createData 的参数。

示例：

fight.fighting(fightScript);

开启随机战斗

功能：载入 fightScript 脚本并开启随机战斗；

fightScript：可以为战斗脚本资源名、标准创建格式的对象（带有 RID、Params 和其他属性），或战斗脚本对象本身（带有 $rid）；
interval：每过 interval 毫秒执行一次；
probability：百分之 probability 的概率是否进入随机战斗；
flag：0b1 为行动时遇敌，0b10 为静止时遇敌；
params：是给战斗脚本 $createData 的参数。

注意：会覆盖之前的fighton；

示例：

fight.fighton(fightScript, probability=5, flag=3, interval=1000);

关闭随机战斗

功能：关闭随机战斗；

示例：

fight.fightoff();

商店

功能：进入交易界面；

参数：

goods：为买的物品 RID 列表；
mygoodsinclude：为 true 表示可卖背包内所有物品，为数组则为数组中可交易的物品列表；
callback：为交易结束后的脚本。
pauseGame：为是否暂停游戏；值为 true、false 或字符串。如果为 true 或字符串则表示需要暂停等待结束，命令建议用 yield 关键字修饰；如果为 false，则尽量不要用 yield 关键字；

示例：

[yield]
game.trade(goods=[], mygoodsinclude=true, pauseGame=true, callback=true);

获得金钱

功能：获得金钱；

返回：返回金钱数目；

示例：

game.money(m=0);

结束战斗

功能：结束战斗并调用战斗结束脚本，可以使用 game 属性；

参数：

r：-1为失败并调用战斗结束脚本，1为胜利并调用战斗结束脚本，0为平局并调用战斗结束脚本；

示例：

fight.over(r=0);

战斗提示框

功能：弹出提示框；

参数：

msg：为提示文字，支持 HTML 标签；
interval：为文字显示间隔，为 0 则不使用；
pretext：为预显示的文字；
pauseGame：为显示时是否暂停游戏（游戏主循环暂停，并暂停产生游戏事件）；值为 true 、 false 或字符串。如果为 true 或字符串则游戏会暂停（字符串表示暂停值，不同的暂停值互不影响，只要有暂停值游戏就会暂停；true 表示给个随机暂停值）；

示例：

[yield]
fight.msg(msg, interval=60, pretext='', type=2, pauseGame=true)

获得Buff

功能：combatant 获得 Buff；

参数：

buffCode：12345分别表示毒乱封眠属性，params 是参数，override 表示是否覆盖（如果不覆盖，则属性名后加时间戳来防止重复）；
- 1 毒：params有 buffName、round、harmType（1 为直接减 harmValue，2 为剩余 HP 的 harmValue 倍）、harmValue、flags；
- 2 乱、3 封、4 眠：buffName、round、flags；
- 5 属性：buffName、round、properties、flags；
  - properties：[属性名, 值, type]：type 为 0 表示相加，type 为 1 表示与属性相乘；
    - flags：表示毒乱封眠属性类型，也可以表示 buff类型，实质就是决定什么时候运行脚本（见 commonBuffScript）；

示例：

fight.getbuff(combatant, buffCode, params={}, override=true);

切换战斗背景图片

功能：切换战斗背景图片；

参数：

image：为图片名

示例：

fight.background(image);

战斗执行脚本命令

功能：执行脚本命令；

注意：此命令会将脚本放入fight系统脚本引擎中等候执行，一般用来在Maker中载入外部脚本文件

示例：

fight.run(vScript, scriptProps=-1, ...params);

获取战斗角色的所有技能

功能：得到某个战斗角色的所有普通技能和技能；

参数：

types：技能的 type，系统默认 0 为普通攻击，1 为技能；
flags：0b1，战斗人物自身拥有的技能：所有道具所有的普通攻击；0b10：战斗人物拥有的所有装备上附带的所有的技能；

返回：数组：[技能名数组, 技能数组]；

示例：

fight.$sys.getCombatantSkills(combatant, types=[0, 1], flags=0b11);

更新日志

2025/11/9 16:47

查看所有更新日志

0fa1b-docs: 从docs文件夹移动到根目录于 2025/11/9
23de6-从引擎同步完成于 2025/6/17
6a729-refactor: 拆分游戏命令于 2025/6/14

贡献者

德二吹风机