Skip to content

Commit 6d55bfc

Browse files
erikoganerikogan
authoredSep 7, 2020
ChatTurnManager v0.0.2 (Roll20#1084)
* Clean up negative items as well as 0 with !turns-clean * Refactor ChatTurnManager: * Add command: remove/rm * Add command: append * Add whipsers to the correct user on errors. * Reorder functions to put helpers first, then handlers
1 parent 1123418 commit 6d55bfc

File tree

4 files changed

+400
-59
lines changed

4 files changed

+400
-59
lines changed
 

‎ChatTurnManager/0.0.2/ChatTurnManager.js

+251
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,251 @@
1+
/**
2+
* ChatTurnManager v0.0.2
3+
*
4+
* Script to simplify Turn Order Management, and move it into chat.
5+
* Commands:
6+
*
7+
* !turns-begin / !turns-start
8+
* Sort the Turn Counter numerically descending, and add a turn counter to the
9+
* top of the order
10+
*
11+
* !turns-clear
12+
* Clear the turn order. NOTE: THERE IS NO CONFIRMATION.
13+
*
14+
* !turns-down <n> [--<before|after> prefix] name
15+
* Add an item to the list that counts down from n. By default this is added
16+
* to the current end of the order. If --before or --after is provided, the
17+
* argument is used as a prefix search for a name to put the item before or
18+
* after.
19+
*
20+
* !turns-up <n> [--<before|after> prefix] name
21+
* Add an item to the list that counts up from n. By default this is added
22+
* to the current end of the order. If --before or --after is provided, the
23+
* argument is used as a prefix search for a name to put the item before or
24+
* after.
25+
*
26+
* !turns-clean
27+
* Remove all elements with a counter of 0.
28+
*/
29+
30+
var ChatTurnManager;
31+
var ChatTurnManager =
32+
ChatTurnManager ||
33+
(() => {
34+
"use strict";
35+
const version = "0.0.2";
36+
const counterName = "Round Counter";
37+
38+
const getTurns = () => {
39+
let turns = Campaign().get("turnorder");
40+
if (turns === "") turns = [];
41+
else turns = JSON.parse(turns);
42+
43+
for (let i = 0; i < turns.length; i++) {
44+
turns[i]["pr"] = parseFloat(turns[i]["pr"]);
45+
if (isNaN(turns[i]["pr"])) turns[i]["pr"] = 0;
46+
}
47+
return turns;
48+
};
49+
50+
const setTurns = (turns) => {
51+
Campaign().set("turnorder", JSON.stringify(turns));
52+
};
53+
54+
const playerName = (playerID) => {
55+
const player = getObj("player", playerID);
56+
if (!player) return player;
57+
return player.get("_displayname");
58+
};
59+
60+
const whisperToID = (id, msg) => {
61+
const name = id === "GM" ? id : playerName(id);
62+
if (!name) return;
63+
sendChat("ChatTurnManager", `/w "${name}" ${msg}`);
64+
};
65+
66+
const itemName = (item) => {
67+
if (item.id === "-1") return item.custom;
68+
const g = getObj("graphic", item.id);
69+
if (!g) return null;
70+
const name = g.get("name");
71+
if (name) return name;
72+
const char = getObj("character", g.get("represents"));
73+
if (!char) return null;
74+
return char.get("name");
75+
};
76+
77+
const findPrefixIndex = (turns, prefix) =>
78+
turns.findIndex((t) => {
79+
const name = itemName(t);
80+
if (!name) return false;
81+
return name.toLowerCase().startsWith(prefix);
82+
});
83+
84+
const addWithFormula = (msg, isGM, playerID, formula) => {
85+
const parts = msg.split(/\s+/);
86+
parts.shift();
87+
const newItem = { id: "-1", pr: parseFloat(parts.shift()), formula };
88+
if (!isGM) newItem.p = true;
89+
90+
let position = null;
91+
let search = null;
92+
if (parts[0].startsWith("--")) {
93+
position = parts.shift().substring(2);
94+
search = parts.shift().toLowerCase();
95+
}
96+
newItem.custom = parts.join(" ");
97+
98+
let turns = getTurns();
99+
let i = null;
100+
101+
if (search) {
102+
i = findPrefixIndex(turns, search);
103+
if (i == -1) {
104+
i = null;
105+
whisperToID(playerID, `could not find item prefix “${search}”. Putting “${newItem.custom}” at the end.`);
106+
} else if (position === "after") i++;
107+
}
108+
109+
if (i !== null) turns.splice(i, 0, newItem);
110+
else turns.push(newItem);
111+
112+
setTurns(turns);
113+
114+
if (!isGM) {
115+
const name = playerName(playerID) || "";
116+
let pos = "";
117+
if (i !== null) pos = ` in position ${i + 1}`;
118+
whisperToID("GM", `Player (${name}) added turn item “${newItem.custom}${pos}”`);
119+
}
120+
};
121+
122+
const handleClear = (msg, isGM, playerID) => {
123+
if (!isGM) {
124+
whisperToID(playerID, "Only the GM can clear turn data.");
125+
return;
126+
}
127+
const turns = Campaign().get("turnorder");
128+
setTurns([]);
129+
log(`ChatTurnManager: CLEARING: ${turns}`);
130+
whisperToID("GM", `Turns cleared. To restore, run <code>!turns-load ${turns}</code>`);
131+
};
132+
133+
const handleLoad = (msg, isGM, playerID) => {
134+
if (!isGM) {
135+
whisperToID(playerID, "Only the GM can load turn data.");
136+
return;
137+
}
138+
Campaign().set("turnorder", msg.split(/\s+/, 2)[1]);
139+
};
140+
141+
const handleAppend = (msg, isGM, playerID) => {
142+
if (!isGM) {
143+
whisperToID(playerID, "Only the GM can append turn data.");
144+
return;
145+
}
146+
147+
try {
148+
const data = JSON.parse(msg.split(/\s+/, 2)[1]);
149+
turns = getTurns();
150+
setTurns(turns.concat(data));
151+
} catch (e) {
152+
whisperToID(playerID, `ERROR appending data: '${e.message}'`);
153+
}
154+
};
155+
156+
const handleClean = (msg) => {
157+
let turns = getTurns();
158+
turns = _.filter(turns, (t) => t.pr <= 0);
159+
setTurns(turns);
160+
};
161+
162+
const handleBegin = (msg, isGM) => {
163+
if (!isGM) {
164+
whisperToID(playerID, "Only the GM can start the counter.");
165+
return;
166+
}
167+
let turns = getTurns();
168+
169+
turns = _.filter(turns, (t) => t.custom !== counterName);
170+
turns = _.sortBy(turns, (t) => -t.pr);
171+
turns.unshift({ id: "-1", custom: counterName, pr: 1, formula: "+1" });
172+
173+
setTurns(turns);
174+
};
175+
176+
const handleUp = (msg, isGM, playerID) => {
177+
addWithFormula(msg, isGM, playerID, "+1");
178+
};
179+
180+
const handleDown = (msg, isGM, playerID) => {
181+
addWithFormula(msg, isGM, playerID, "-1");
182+
};
183+
184+
const handleRemove = (msg, isGM, playerID) => {
185+
const parts = msg.split(/\s+/, 2);
186+
const prefix = parts[1];
187+
if (!prefix) {
188+
whisperToID(playerID, `missing item to remove!`);
189+
return;
190+
}
191+
192+
const turns = getTurns();
193+
const i = findPrefixIndex(turns, prefix);
194+
if (i === -1) {
195+
whisperToID(playerID, `Cannot find prefix “${prefix}” to remove.`);
196+
return;
197+
}
198+
199+
if (isGM || turns[i].p) {
200+
turns.splice(i, 1);
201+
setTurns(turns);
202+
return;
203+
}
204+
const name = itemName(turns[i]) || "that item";
205+
whisperToID(playerID, `You do not have permission to remove ${name}. Please ask the GM to do it.`);
206+
};
207+
208+
const handlers = {
209+
handleClear,
210+
handleLoad,
211+
handleAppend,
212+
handleClean,
213+
handleBegin,
214+
handleUp,
215+
handleDown,
216+
handleRemove,
217+
handleStart: handleBegin,
218+
handleRm: handleRemove,
219+
};
220+
221+
const handleMessage = (msg) => {
222+
if (msg.type != "api" || !msg.content.startsWith("!turns")) return;
223+
const cmd = msg.content.split(/\s+/)[0].substring(7);
224+
const handler = handlers[`handle${cmd.charAt(0).toUpperCase()}${cmd.slice(1)}`];
225+
if (handler) {
226+
handler(msg.content, playerIsGM(msg.playerid), msg.playerid);
227+
return;
228+
}
229+
log(`ChatTurnManager: unknown cmd: ${cmd}`);
230+
whisperToID(playerID, `Unknown command: ${cmd}`);
231+
};
232+
233+
const registerHandlers = () => {
234+
on("chat:message", handleMessage);
235+
};
236+
237+
const notifyStart = () => {
238+
log(`ChatTurnManager ${version} Loading.`);
239+
};
240+
241+
return {
242+
notifyStart: notifyStart,
243+
registerHandlers: registerHandlers,
244+
};
245+
})();
246+
247+
on("ready", () => {
248+
"use strict";
249+
ChatTurnManager.notifyStart();
250+
ChatTurnManager.registerHandlers();
251+
});

‎ChatTurnManager/ChatTurnManager.js

+132-50
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* ChatTurnManager v0.0.1
2+
* ChatTurnManager v0.0.2
33
*
44
* Script to simplify Turn Order Management, and move it into chat.
55
* Commands:
@@ -32,7 +32,7 @@ var ChatTurnManager =
3232
ChatTurnManager ||
3333
(() => {
3434
"use strict";
35-
const version = "0.0.1";
35+
const version = "0.0.2";
3636
const counterName = "Round Counter";
3737

3838
const getTurns = () => {
@@ -51,44 +51,42 @@ var ChatTurnManager =
5151
Campaign().set("turnorder", JSON.stringify(turns));
5252
};
5353

54-
const handleClear = (msg, isGM) => {
55-
if (!isGM) return;
56-
const turns = Campaign().get("turnorder");
57-
setTurns([]);
58-
log(`ChatTurnManager: CLEARING: ${turns}`)
59-
sendChat('ChatTurnManager', `/w GM Turns cleared. To restore, run <code>!turns-load ${turns}</code>`)
54+
const playerName = (playerID) => {
55+
const player = getObj("player", playerID);
56+
if (!player) return player;
57+
return player.get("_displayname");
6058
};
6159

62-
const handleLoad = (msg, isGM) => {
63-
if (!isGM) return;
64-
Campaign().set("turnorder", msg.split(/\s+/, 2)[1]);
65-
}
66-
67-
const handleClean = (msg) => {
68-
let turns = getTurns();
69-
turns = _.filter(turns, (t) => t.pr != 0);
70-
setTurns(turns);
60+
const whisperToID = (id, msg) => {
61+
const name = id === "GM" ? id : playerName(id);
62+
if (!name) return;
63+
sendChat("ChatTurnManager", `/w "${name}" ${msg}`);
7164
};
7265

73-
const handleBegin = (msg, isGM) => {
74-
if (!isGM) return;
75-
let turns = getTurns();
76-
77-
turns = _.filter(turns, (t) => t.custom !== counterName);
78-
turns = _.sortBy(turns, (t) => -t.pr);
79-
turns.unshift({ id: "-1", custom: counterName, pr: 1, formula: "+1" });
80-
81-
setTurns(turns);
66+
const itemName = (item) => {
67+
if (item.id === "-1") return item.custom;
68+
const g = getObj("graphic", item.id);
69+
if (!g) return null;
70+
const name = g.get("name");
71+
if (name) return name;
72+
const char = getObj("character", g.get("represents"));
73+
if (!char) return null;
74+
return char.get("name");
8275
};
8376

84-
const matchName = (search, name) => {
85-
return name && name.toLowerCase().startsWith(search);
86-
};
77+
const findPrefixIndex = (turns, prefix) =>
78+
turns.findIndex((t) => {
79+
const name = itemName(t);
80+
if (!name) return false;
81+
return name.toLowerCase().startsWith(prefix);
82+
});
8783

88-
const addWithFormula = (msg, formula) => {
84+
const addWithFormula = (msg, isGM, playerID, formula) => {
8985
const parts = msg.split(/\s+/);
9086
parts.shift();
9187
const newItem = { id: "-1", pr: parseFloat(parts.shift()), formula };
88+
if (!isGM) newItem.p = true;
89+
9290
let position = null;
9391
let search = null;
9492
if (parts[0].startsWith("--")) {
@@ -99,53 +97,137 @@ var ChatTurnManager =
9997

10098
let turns = getTurns();
10199
let i = null;
100+
102101
if (search) {
103-
i = turns.findIndex((t) => {
104-
if (t.id === "-1") return matchName(search, t.custom);
105-
const g = getObj("graphic", t.id);
106-
if (!g) return false;
107-
let name = g.get("name");
108-
if (name) return matchName(search, name);
109-
else {
110-
const char = getObj("character", g.get("represents"));
111-
if (!char) return false;
112-
return matchName(search, char.get("name"));
113-
}
114-
});
115-
if (i == -1) i = null;
116-
else if (position === "after") i++;
102+
i = findPrefixIndex(turns, search);
103+
if (i == -1) {
104+
i = null;
105+
whisperToID(playerID, `could not find item prefix “${search}”. Putting “${newItem.custom}” at the end.`);
106+
} else if (position === "after") i++;
117107
}
118108

119109
if (i !== null) turns.splice(i, 0, newItem);
120110
else turns.push(newItem);
121111

122112
setTurns(turns);
113+
114+
if (!isGM) {
115+
const name = playerName(playerID) || "";
116+
let pos = "";
117+
if (i !== null) pos = ` in position ${i + 1}`;
118+
whisperToID("GM", `Player (${name}) added turn item “${newItem.custom}${pos}”`);
119+
}
120+
};
121+
122+
const handleClear = (msg, isGM, playerID) => {
123+
if (!isGM) {
124+
whisperToID(playerID, "Only the GM can clear turn data.");
125+
return;
126+
}
127+
const turns = Campaign().get("turnorder");
128+
setTurns([]);
129+
log(`ChatTurnManager: CLEARING: ${turns}`);
130+
whisperToID("GM", `Turns cleared. To restore, run <code>!turns-load ${turns}</code>`);
131+
};
132+
133+
const handleLoad = (msg, isGM, playerID) => {
134+
if (!isGM) {
135+
whisperToID(playerID, "Only the GM can load turn data.");
136+
return;
137+
}
138+
Campaign().set("turnorder", msg.split(/\s+/, 2)[1]);
139+
};
140+
141+
const handleAppend = (msg, isGM, playerID) => {
142+
if (!isGM) {
143+
whisperToID(playerID, "Only the GM can append turn data.");
144+
return;
145+
}
146+
147+
try {
148+
const data = JSON.parse(msg.split(/\s+/, 2)[1]);
149+
turns = getTurns();
150+
setTurns(turns.concat(data));
151+
} catch (e) {
152+
whisperToID(playerID, `ERROR appending data: '${e.message}'`);
153+
}
154+
};
155+
156+
const handleClean = (msg) => {
157+
let turns = getTurns();
158+
turns = _.filter(turns, (t) => t.pr <= 0);
159+
setTurns(turns);
123160
};
124161

125-
const handleUp = (msg) => {
126-
addWithFormula(msg, "+1");
162+
const handleBegin = (msg, isGM) => {
163+
if (!isGM) {
164+
whisperToID(playerID, "Only the GM can start the counter.");
165+
return;
166+
}
167+
let turns = getTurns();
168+
169+
turns = _.filter(turns, (t) => t.custom !== counterName);
170+
turns = _.sortBy(turns, (t) => -t.pr);
171+
turns.unshift({ id: "-1", custom: counterName, pr: 1, formula: "+1" });
172+
173+
setTurns(turns);
174+
};
175+
176+
const handleUp = (msg, isGM, playerID) => {
177+
addWithFormula(msg, isGM, playerID, "+1");
178+
};
179+
180+
const handleDown = (msg, isGM, playerID) => {
181+
addWithFormula(msg, isGM, playerID, "-1");
127182
};
128183

129-
const handleDown = (msg) => {
130-
addWithFormula(msg, "-1");
184+
const handleRemove = (msg, isGM, playerID) => {
185+
const parts = msg.split(/\s+/, 2);
186+
const prefix = parts[1];
187+
if (!prefix) {
188+
whisperToID(playerID, `missing item to remove!`);
189+
return;
190+
}
191+
192+
const turns = getTurns();
193+
const i = findPrefixIndex(turns, prefix);
194+
if (i === -1) {
195+
whisperToID(playerID, `Cannot find prefix “${prefix}” to remove.`);
196+
return;
197+
}
198+
199+
if (isGM || turns[i].p) {
200+
turns.splice(i, 1);
201+
setTurns(turns);
202+
return;
203+
}
204+
const name = itemName(turns[i]) || "that item";
205+
whisperToID(playerID, `You do not have permission to remove ${name}. Please ask the GM to do it.`);
131206
};
132207

133208
const handlers = {
134209
handleClear,
135210
handleLoad,
211+
handleAppend,
136212
handleClean,
137213
handleBegin,
138214
handleUp,
139215
handleDown,
216+
handleRemove,
140217
handleStart: handleBegin,
218+
handleRm: handleRemove,
141219
};
142220

143221
const handleMessage = (msg) => {
144222
if (msg.type != "api" || !msg.content.startsWith("!turns")) return;
145223
const cmd = msg.content.split(/\s+/)[0].substring(7);
146224
const handler = handlers[`handle${cmd.charAt(0).toUpperCase()}${cmd.slice(1)}`];
147-
if (handler) handler(msg.content, playerIsGM(msg.playerid));
148-
else log(`ChatTurnManager: unknown cmd: ${cmd}`);
225+
if (handler) {
226+
handler(msg.content, playerIsGM(msg.playerid), msg.playerid);
227+
return;
228+
}
229+
log(`ChatTurnManager: unknown cmd: ${cmd}`);
230+
whisperToID(playerID, `Unknown command: ${cmd}`);
149231
};
150232

151233
const registerHandlers = () => {

‎ChatTurnManager/README.md

+15-7
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,16 @@ A script to simplify Turn Order Management, and move it into chat.
44

55
## Commands
66

7-
### `!turns-begin` / `!turns-start`
7+
### `!turns-begin` / `!turns-start` (GM Only)
88

99
Sort the Turn Counter numerically descending, and add a turn counter to the
1010
top of the order
1111

12-
### `!turns-clear`
12+
### `!turns-clear` (GM Only)
1313

1414
Clear the turn order. There is no confirmation, but the GM gets a whisper with
1515
a load command to restore what was just cleared, if done in error.
1616

17-
### `!turns-load <JSON string>`
18-
19-
Load the turn order from a blob of JSON data.
20-
2117
### `!turns-down <n> [--<before|after> prefix] name`
2218

2319
Add an item to the list that counts down from n. By default this is added to
@@ -33,7 +29,19 @@ is used as a prefix search for a name to put the item before or after.
3329

3430
### `!turns-clean`
3531

36-
Remove all elements with a counter of 0.
32+
Remove all elements with a counter of 0 (or less).
33+
34+
### `!turns-remove prefix` / `!turns-rm prefix` (GM Only)
35+
36+
Remove the element first with the given prefix.
37+
38+
### `!turns-load <JSON string>` (GM Only)
39+
40+
Load the turn order from a blob of JSON data.
41+
42+
### `!turns-append <JSON string>` (GM Only)
43+
44+
Append the turn order data from a blob of JSON data to the current list.
3745

3846
## Permission Notes
3947

‎ChatTurnManager/script.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"name": "ChatTurnManager",
33
"script": "ChatTurnManager.js",
4-
"version": "0.0.1",
5-
"previousversions": [],
4+
"version": "0.0.2",
5+
"previousversions": ["0.0.1"],
66
"description": "A script to simplify Turn Order Management, and move it into chat.",
77
"authors": "Erik O.",
88
"roll20userid": "1828947",

0 commit comments

Comments
 (0)
Please sign in to comment.