by yoyokity
这个手册编写的最初目的就是为了自用参考，正好分享给需要的人。
收集，总结了cactbot文档以及源码中的能用到的东西，进行排版。有些我个人认为没什么用的东西会被我忽略，如果要用请自行去cactbot的github源码中找。
1、所有的cactbot模块都会从 user 文件夹加载用户设置。
2、 raidboss 模块会加载 user/raidboss.js 与 user/raidboss.css，以及所有 user/raidboss/ 目录及子目录下的任意 .js 和 .css 文件。
(时间轴.txt 文件必须与引用它们的 .js文件放在同一个文件夹中。)
3、这些用户自定义文件将在cactbot自身加载完毕后加载，并可以覆盖对应的官方模块的设置。
js触发器example：https://github.com/quisquous/cactbot/tree/triggers
大致结构一览
完整一个触发器文件{
该文件的各种属性定义（地区限定，对应时间轴，语言限定），
时间轴触发器[
//以战斗时间为匹配目标的触发器，比如130秒的时候报AOE
{时间轴触发器},
{时间轴触发器},
...
],
触发器[
{常规触发器}，
{常规触发器}，
{常规触发器}，
...
],
本地化语言替换[
//用于不同语言的时间轴显示
{替换方案}，
{替换方案}，
{替换方案}，
],
}
要详细点看：
Options.Triggers.push({
zoneId: ZoneId.TheWeaponsRefrainUltimate,
overrideTimelineFile: false,
timelineFile: 'filename.txt',
timeline: `hideall`,
timelineReplace: [
{
locale: 'en',
replaceText: {
'regexSearch': 'strReplace',
},
replaceSync: {
'regexSearch': 'strReplace',
},
},
],
resetWhenOutOfCombat: true,
triggers: [
{ /* ..trigger 1.. */ },
{ /* ..trigger 2.. */ },
{ /* ..trigger 3.. */ },
]
},
{
zoneRegex: /Eureka Hydatos/,
triggers: [
{ /* ..trigger 1.. */ },
{ /* ..trigger 2.. */ },
{ /* ..trigger 3.. */ },
]
});必须二选一填一个
zoneId ：区域名id。 这些区域名id可以在 zone_info.ts 文件中找到。如果没有地域限制，属性值填ZoneId.MatchAll。
zoneRegex ：用于匹配区域名称的正则表达式(匹配ACT读取的区域名)。
overrideTimelineFile ：可选属性，布尔值。该值设定为true时，任何先前被读取的同区域的触发器文件将被该触发器集合中指定的 timelineFile 和 timeline 属性覆盖。（如果你改变了txt文件，务必开启这个属性）
timelineFile ： 可选属性，指定当前区域对应的时间轴文件。 这些文件与触发器文件存放在同一文件夹中。 (例如 raidboss/data/04-sb/raid/)
timeline ： 可选属性，时间轴的补充行。
在触发器使用过程中，你除了使用在js文件中声明的全局变量，也可以使用data变量
data变量不仅可以在每个触发器中访问，同时团灭后data变量会自动初始化重置
添加data变量：添加方法有两种，一种是initData: () => {}在触发器开头添加初始值，一种则是在使用的过程中data.xxx，如果data变量中没有xxx属性则会自动创建
initData: () => {} 向data里加入“全局变量”
//这是绝欧触发器中创建初始data变量的例子 变量为 'inLine' '塔次数' '一运'
Options.Triggers.push({
zoneId: 1122,
overrideTimelineFile: true,
timelineFile: '绝欧.txt',
initData: () => {
return {
inLine: {},
塔次数: 0,
一运: false,
};
}，
xxxxxxx
//调用例子
run: (data, matches) => data.塔次数 ++,resetWhenOutOfCombat 布尔值，默认为true。 该值为true时，时间轴和触发器均在脱战时自动重置。 否则，需要手动调用data.StopCombat()使其重置。
**triggers： **触发器
**timelineTriggers： **时间轴触发器
timelineReplace：本地化文本替换
这 三个属性下面详细解析。
**触发器id： id：（字符串）**若当前触发器的id与某一已定义的触发器完全一致，后者的定义将会完全失效，并由前者覆盖并替代其位置。 这个机制让用户可以方便地复制触发器代码并粘贴到用户文件中，以修改为他们自己喜欢的方式。 没有id的触发器无法被覆盖。
**触发器开关：disabled: （布尔值）**若该值为true，则该触发器将被完全禁用/忽略。 默认为false。
触发器激活条件：condition: function(data, matches) 当函数返回 true 时激活该触发器， 若返回的不是 true，则当前触发器不会有任何响应。 不管触发器对象里定义了多少函数，该函数总是第一个执行。
**触发器冷却时间：suppressSeconds：（数字）**再次触发该触发器的冷却时间，单位为秒， 其值也可以是数字或返回数字的 function(data, matches)。 该时间从正则表达式匹配之时开始计算，并且不受 delaySeconds 设置与否的影响。 当设置了此元素的触发器被激活后，它在这段时间内无法再次被激活。
正则匹配：netRegex / regex ：（正则表达式） cactbot会将该正则表达式与每一条日志行做比对， 并在匹配成功时触发当前触发器。 netRegex 版本用于匹配网络日志行， 而 regex 版本用于匹配普通的ACT日志行。
正则匹配（语言端）：netRegexFr / regexFr：（正则表达式） 语言特定正则表达式（以fr为示例）。 若设置了 Options.ParserLanguage == 'fr'，则 regexFr (如果存在的话) 优先于 regex 对日志行进行匹配。 否则，该值将会被忽略。 这里虽然只有法语的例子，但其他语言也是可用的。例如：regexEn, regexKo。
立即执行动作：preRun: function(data, matches) 当触发器被激活时，该函数会在条件判定成功后立刻执行。不受 delaySeconds 设置与否的影响。
异步：promise: function(data, matches) 设置该属性为返回Promise的函数，则触发器会在其resolve之前等待。 这个函数会在 preRun 之后，delaySeconds 之前执行。通常用来获取战斗数据
**等待时间：delaySeconds ：（数字）**规定从正则表达式匹配上到触发器激活之间的等待时间，单位为秒。 其值可以是数字或返回数字的 function(data, matches)。
最后执行动作：run: function(data, matches) 当触发器被激活时，该函数会作为触发器最末尾的步骤执行。
提示：response：（键值对） 用于返回 infoText/alertText/alarmText/tts 的快捷方法。 这些函数定义于 resources/responses.ts。 Response 的优先级比直接指定的文字或TTS低，因此可以被覆盖。如果设置了多个键值但是没有设置tts，那么tts会报危险程度最高那个。
response: {'alertText': '123'} //一个例子，高危文本显示123**输出文本：outputStrings：（键值对）**对输出文本通过键值对进行条件分类，搭配output类使用。（说实话，这个如果不是做多语言端真的用不太到，反而拐弯抹角）
三种文本的值可以是字符串或返回字符串的 function(data, matches)。
实际上，文本也会报 tts
**高危文本：alarmText：（字符串）**当触发器激活时显示“警报”级别的文本。 该属性一般用于高危事件，如处理失败必死无疑的机制、会导致团灭的机制，或处理失败会导致通关变得更加困难的机制等。
**中危文本：alertText ：（字符串）**当触发器激活时显示“警告”级别的文本。 该属性一般用于中危事件，如处理失败可能会致死的机制、会造成全队伤害或全队Debuff的机制等等。(例如，针对坦克的死刑预告，或针对全队的击退预告等)
**低危文本：infoText： （字符串）**当触发器激活时显示“信息”级别的文本。 该属性一般用于低危事件，不需要玩家立即做出反应。 (例如，小怪出现时的警告，或针对治疗职业的全体伤害预告等等)
**文本显示时间：durationSeconds ：（数字）**显示触发器文本的时长，单位为秒。 其值可以是数字或返回数字的 function(data, matches)。 若该值未设置，默认为3。
音频文件：sound：（字符串） 用于播放声音的音频文件，也可以是 'Info'，'Alert'，'Alarm' 或者 'Long'。 文件路径是对于 ui/raidboss/ 文件夹的相对路径。
**语音：tts： （字符串）**用于输出TTS的另一种方式。 该值可以是包含本地化字符串的对象，与触发器文本类似。
无声音tts:null
**音量：soundVolume： （数字）**从0到1的音量数值，触发器激活时播放的音量大小。
{
id: 'id string',
disabled: false,
type: 'StartsUsing',
netRegex: /trigger-regex-for-network-log-lines/,
netRegexFr: /trigger-regex-for-network-log-lines-but-in-French/
regex: /trigger-regex-for-act-log-lines/,
regexFr: /trigger-regex-for-act-log-lines-but-in-French/,
condition: function(data, matches) { return true if it should run },
preRun: function(data, matches) { do stuff.. },
delaySeconds: 0,
durationSeconds: 3,
suppressSeconds: 0,
promise: function(data, matches) { return promise to wait for resolution of },
sound: '',
soundVolume: 1,
response: Responses.doSomething(severity),
alarmText: {en: 'Alarm Popup'},
alertText: {en: 'Alert Popup'},
infoText: {en: 'Info Popup'},
tts: {en: 'TTS text'},
run: function(data, matches) { do stuff.. },
},**提示时间修正：beforeSeconds：（数字）**指定触发器相对于技能提前提示的时间，如果延后提示，则使用负数。
其余属性与普通时间轴均相同。
但是，他们之间仍然有一些区别：例如 regex 部分不能翻译，而且必须与时间轴文件中的某个条目完全一致。也就是说，它需要匹配时间轴的某一行中用双引号括起来的技能名。函数中的 matches 参数也返回此名字。
本地语言：locale ： 可选属性，限定触发器仅在特定语言的客户端上生效。如 'en'、'ko'、'fr'、‘cn’、'ja'。 若该属性未设置，则应用于所有语言。
**替换技能名：replaceText ： （键值对）**用于在时间轴中搜索并替换技能名。 显示的技能名会被替换，但 hideall、infotext、alerttext、alarmtext 等依旧指向其原名称。 这一属性使我们可以对时间轴文件进行翻译/本地化，而不需要直接编辑时间轴文件。
**替换匹配正则：replaceSync ： （键值对）**用于在时间轴中搜索并替换同步正则表达式。 当同步正则表达式包含了本地化名称时，该属性是必要的。
Conditions = {
targetIsYou(): (data: Data, matches: TargetedMatches) => boolean
targetIsNotYou(): (data: Data, matches: TargetedMatches) => boolean
caresAboutAOE(): (data: Data) => boolean
caresAboutMagical(): (data: Data) => boolean
caresAboutPhysical(): (data: Data) => boolean
}NetRegexes = {
startsUsing():
ability():
abilityFull():
headMarker():
addedCombatant():
addedCombatantFull():
removingCombatant():
gainsEffect():
statusEffectExplicit():
losesEffect():
tether():
wasDefeated():
gameLog():
statChange():
changeZone():
network6d():
nameToggle():
map():
systemLogMessage():
}data = {
"me":
"job"：
"role":
"party"：{
partyNames: string[],
partyIds: string[],
allianceNames: string[]
tankNames: string[]
healerNames: string[]
dpsNames: string[]
isRole(name: string, role: string): boolean
isTank(name: string): boolean
isHealer(name: string): boolean
isDPS(name: string): boolean
inParty(name: string): boolean
inAlliance(name: string): boolean
otherTank(name: string): string | undefined
otherHealer(name: string): string | undefined
jobName(name: string): Job | undefined
nameFromId(id: string): string | undefined
nameToRole_: object {name:role}
idToName_: object {id:name}
},
"lang":
"parserLang":
"displayLang":
"currentHP":
StopCombat() //手动重置战斗
}；通常用法如下
promise: async (data) => {
let entities = await callOverlayHandler({
call: 'getCombatants',
ids:['1234567','6543321'],
});
entities = entities.combatants; //此时的entities是一个包含各种实体对象的数组
//下面添加自己的代码
console.log(entities[0]);
},promise异步方法基本绑定用来使用callOverlayHandler回调函数
call键必须有，ids键返回符合id数组的战斗实体；也可以使用names键，返回符合name数组的战斗实体
如果只有call键则返回所有实体
一个实体对象包含如下数据
{
AggressionStatus: 0
BNpcID: 0
BNpcNameID: 0
CastBuffID: 0
CastDurationCurrent: 0
CastDurationMax: -36893490000000000000
CastTargetID: 0
CurrentCP: 0
CurrentGP: 0
CurrentHP: 68861
CurrentMP: 10000
CurrentWorldID: 23
Distance: null
EffectiveDistance: null
Effects: [
{BuffID: 360, Stack: 10, Timer: 30, ActorID: 3758096384, isOwner: false}
{BuffID: 362, Stack: 20, Timer: 30, ActorID: 3758096384, isOwner: false}
]
Heading: 3.052429
ID: 123456789
IsCasting1: 0
IsCasting2: 0
IsTargetable: false
Job: 21
Level: 90
MaxCP: 0
MaxGP: 0
MaxHP: 68861
MaxMP: 10000
ModelStatus: 585
MonsterType: 0
NPCTargetID: 3758096384
Name: "XXXX"
OwnerID: 0
PCTargetID: 0
PartyType: 0
PosX: 1.004711
PosY: -1.83687568
PosZ: -2.70719252e-14
Radius: 0.5
Status: 0
TargetID: 0
TransformationId: 0
Type: 1
WeaponId: 0
WorldID: 23
WorldName: "Asura"
}下面代码加载js文件头部，用的时候调用camera就可以了
let camera;
addOverlayListener("onPlayerControl", (e) => {
camera = e.detail;
});camera：包含了标点信息和镜头信息
{
A: {X: 0, Y: 0, Z: 0, ID: 0, Active: false},
B: {X: 0, Y: 0, Z: 0, ID: 1, Active: false},
C: {X: 0, Y: 0, Z: 0, ID: 2, Active: false},
D: {X: 0, Y: 0, Z: 0, ID: 3, Active: false},
FOUR: {X: 0, Y: 0, Z: 0, ID: 7, Active: false},
ONE: {X: 0, Y: 0, Z: 0, ID: 4, Active: false},
THREE: {X: 0, Y: 0, Z: 0, ID: 6, Active: false},
TWO: {X: 0, Y: 0, Z: 0, ID: 5, Active: false},
camera: {currentHRotation: -0.076598756, currentVRotation: -0.3909539}
}promise: async (data) => {
let config = await callOverlayHandler({
call: 'getConfig',
});
},config:包含了以下数据
{
isOpen: false,
shunxu: [
{order: 0, job: '黑骑'},
{order: 1, job: '枪刃'},
{order: 2, job: '战士'},
{order: 3, job: '骑士'},
{order: 4, job: '白魔'},
{order: 5, job: '占星'},
{order: 6, job: '贤者'},
{order: 7, job: '学者'},
{order: 8, job: '武士'},
{order: 9, job: '武僧'},
{order: 10, job: '镰刀'},
{order: 11, job: '龙骑'},
{order: 12, job: '忍者'},
{order: 13, job: '机工'},
{order: 14, job: '舞者'},
{order: 15, job: '诗人'},
{order: 16, job: '黑魔'},
{order: 17, job: '召唤'},
{order: 18, job: '赤魔'}
]
}Options.Triggers.push({
zoneId: ZoneId.MatchAll,
triggers: [
{
id: "PostNamazu Callback Test",
netRegex: NetRegexes.gameNameLog({ line: "test", capture: false }),
run: () => {
// command 文本指令
callOverlayHandler({ call: "PostNamazu", c: "command", p: "/e 123" });
// place 本地标点
callOverlayHandler({
call: "PostNamazu",
c: "place",
p: JSON.stringify({ A: { Active: false }, B: { X: -63.199, Y: 18.0, Z: -3.915, Active: true } }),
});
// mark 标记
callOverlayHandler({
call: "PostNamazu",
c: "mark",
p: JSON.stringify({ ActorID: 0xe000000, Name: "王小明", MarkType: "attack2", LocalOnly: false }),
});
// preset 写入预设标点
callOverlayHandler({
call: "PostNamazu",
c: "preset",
p: JSON.stringify({
Name: "Slot5",
MapID: 676,
A: { X: -170.684, Y: -0.204, Z: 464.994, Active: true },
C: { X: -171.698, Y: 0.022, Z: 470.941, Active: true },
}),
});
// queue 队列执行指令
callOverlayHandler({
call: "PostNamazu",
c: "queue",
p: JSON.stringify([
{ c: "qid", p: "test" },
{ c: "command", p: "/e 111" },
{ c: "command", p: "/e 222", d: 1000 },
{ c: "stop", p: "test", d: 1000 },
{ c: "command", p: "/e 333", d: 1000 },
]),
});
},
alarmText: "发送指令",
},
],
});把下面代码放在文件开头
const portOfSplatoon = 47774;
function Splatoon(namespace, time, data) {
fetch(`http://127.0.0.1:${portOfSplatoon}/?namespace=${namespace}&destroyAt=${time}`, {
method: "POST",
mode: "no-cors",
headers: {
"Content-Type": "application/json"
},
body: data
});
}使用例子
run: () => {
let namespace = '投盾男';
let time = '15000';
let json = `{
"Name": "二运M位置",
"type": 1,
"radius": 3.0,
"color": 4278190335,
"overlayBGColor": 3355443200,
"overlayTextColor": 4290903808,
"overlayVOffset": 2.0,
"overlayFScale": 3.0,
"thicc": 5.0,
"refActorDataID": 15714,
"refActorPlaceholder": [],
"refActorComparisonAnd": true,
"FillStep": 0.1,
"refActorComparisonType": 7,
"onlyVisible": true,
"tether": true,
"DistanceSourceX": 100.11486,
"DistanceSourceY": 88.17513,
"DistanceSourceZ": -5.456968E-12,
"DistanceMax": 5.0,
"refActorVFXPath": "vfx/common/eff/mon_eisyo03t.avfx",
"refActorVFXMax": 999000
}`;
Splatoon(namespace, time, json);
},把下面代码放在文件开头
const FFD = {
颜色 : 'enemy',
Send: (json) => {
fetch(`http://127.0.0.1:8001/rpc`, {
method: "POST",
mode: "no-cors",
headers: {
"Content-Type": "application/json"
},
body: JSON.stringify(json)
});
},
PosTranslation: (x, y, z, angle, distance) => {
// 点平移函数
// x,y为原始pos
// angle为平移弧度（南为0，北为3.14，顺时针为负，逆时针为正）
// distance为平移距离
// 返回最终点的[x,z,y]
if (typeof (x) != Number) x = Number(x)
if (typeof (y) != Number) y = Number(y)
if (typeof (z) != Number) z = Number(z)
if (typeof (angle) != Number) angle = Number(angle)
if (typeof (distance) != Number) distance = Number(distance)
let a = distance * Math.sin(angle);
let b = distance * Math.cos(angle);
return [x + a, z, y + b]
},
GetAng: (heading, where) => {
//用于获取以单位面向为标准的方向弧度（南为0，北为3.14，顺时针为负，逆时针为正）
//heading为当前面向弧度
//where为方位，填“下”“左”“右”
if (typeof (heading) != Number) heading = Number(heading)
let a = (heading >= 0) ? -Math.PI / 2 : Math.PI / 2;
let b = (heading >= 0) ? -Math.PI : Math.PI;
if (where == "下") return heading + b
if (where == "左") return heading + a
if (where == "右") return heading - a
},
Rad_Ang: (x, how) => {
//角度弧度转换函数
//how不填默认弧度转角度，填1角度转弧度
if (typeof (x) != Number) x = Number(x)
if (how == undefined) {
x = x * 180.0 / Math.PI
} else {
x = x * Math.PI / 180.0;
}
return x
},
send_feetfighter: (data, width, _width, length1, length2, duration) => {
//发送辣翅画图
//data为实体对象
//总宽度，中间留空宽度，向前长度，向后长度
let len = (width + _width) / 4;
let angle = FFD.GetAng(data.Heading, '左');
let temp = FFD.PosTranslation(data.PosX, data.PosY, data.PosZ, angle, len);
angle = FFD.GetAng(data.Heading, '下');
temp = FFD.PosTranslation(temp[0], temp[2], data.PosZ, angle, length2);
let angle2 = FFD.GetAng(data.Heading, '右');
let temp2 = FFD.PosTranslation(data.PosX, data.PosY, data.PosZ, angle2, len);
angle2 = FFD.GetAng(data.Heading, '下');
temp2 = FFD.PosTranslation(temp2[0], temp2[2], data.PosZ, angle2, length2);
let 辣翅1 = {
cmd: 'add_omen',
color: FFD.颜色,
shape_scale: {
key: "rect",
range: length1 + length2,
width: (width - _width) / 2,
},
pos: temp,
facing: data.Heading,
'duration': duration,
};
let 辣翅2 = {
cmd: 'add_omen',
color: FFD.颜色,
shape_scale: {
key: "rect",
range: length1 + length2,
width: (width - _width) / 2,
},
pos: temp2,
facing: data.Heading,
'duration': duration,
};
FFD.Send(辣翅1);
FFD.Send(辣翅2);
}
};使用例子：
{
id: 'P2 一运画图眼睛激光',
type: 'ability',
netRegex: NetRegexes.ability({
id: '7B3E',
}),
delaySeconds: 10,
run: () => {
let json = {
cmd: 'foreach',
name: 'target_id',
values: { key: 'actors_by_base_id', id: 15716 },
func: {
cmd: 'add_omen',
color: 'nomal',
shape_scale: {
key: 'rect',
range: 65,
width: 16,
},
pos: {
key: 'actor_pos',
id: { key: 'arg', name: 'target_id' },
},
facing: {
key: 'actor_facing',
id: { key: 'arg', name: 'target_id' },
},
duration: 10,
},
};
let json2 = {
cmd: 'foreach',
name: 'target_id',
values: { key: 'actors_by_base_id', id: 15716 },
func: {
cmd: 'add_omen',
color: 'hard',
shape_scale: {
key: 'rect',
range: 35,
width: 16,
},
pos: {
key: 'actor_pos',
id: { key: 'arg', name: 'target_id' },
},
facing: {
key: 'actor_facing',
id: { key: 'arg', name: 'target_id' },
},
duration: 10,
},
};
FFD.Send(json);
FFD.Send(json2);
},
},辣翅例子：
FFD.send_feetfighter(data.欧米茄F, 50, 8, 40, 20, 5);启动OverlayPlugin的WSS服务器，地址127.0.0.1，端口10501
浏览器打开下面这个网页
https://quisquous.github.io/cactbot/ui/raidboss/raidemulator.html?OVERLAY_WS=ws://127.0.0.1:10501/ws
然后就可以调试了，这玩意还挺好用的，打本模拟器。data数据可以直接点进某个触发器里看当前的值是多少，注意模拟器只能收集log日志包含的信息，一些比如callOverlayHandler回调来的数据是没有的。
如果你console.log了一些内容，浏览器摁F12就可以看到，F12也可以用来检查一些语法错误等
非调试模拟器时的console.log（比如做了/e test的测试触发器）在“触发器提示”的悬浮窗当中的“DevTools”中查看