forked from blargbot/blargbot
-
Notifications
You must be signed in to change notification settings - Fork 0
/
templateTag.js
56 lines (52 loc) · 1.82 KB
/
templateTag.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
// START: Do not touch
var e = module.exports = {};
var bu;
var bot;
e.init = (Tbot, blargutil) => {
bot = Tbot;
bu = blargutil;
e.category = bu.TagType.COMPLEX;
};
e.requireCtx = require;
e.isTag = true;
// END: Do not touch
// name of the tag (used to execute it)
e.name = '';
// Note: the following information will be parsed with HTML. Keep this in mind (ex. <> instead of <>)
// the arguments it takes. <> for required, [] for optional
e.args = '';
// an example of usage (for docs). ex: {template;arg 1[;optional arg]}
e.usage = '';
// A brief description of the tag
e.desc = '';
// An example of tag input
e.exampleIn = '';
// An example of the previous tag's output
e.exampleOut = '';
/**
* The execution function of the tag.
* @params - the parameter object
* @params.msg - the message object that executed the tag
* @params.args - an array of the arguments that were provided by the tag
* @params.fallback - the fallback message to output if a tag fails
* @params.words - an array of the arguments that the tag executor provided
* @params.author - the creator of the tag
* @params.tagName - the name of the tag
*
* Returns an object
* @return.replaceString String - the string that will be used to replace the tag
* @return.replaceContent Boolean - if true, will replace the entire content rather than just the tag (within scope)
* @return.fallback? String - if provided, will change the fallback
*/
e.execute = (params) => {
// processes any nested tags in the `args` array. if your tag uses advanced logic, you may wish to reimplement this
for (let i = 1; i < params.args.length; i++) {
params.args[i] = bu.processTagInner(params, i);
}
var replaceString = '';
var replaceContent = false;
return {
replaceString: replaceString,
replaceContent: replaceContent
};
};