FilesExpand file tree

 master

/

moduleExample.js

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

62 lines (53 loc) · 2.9 KB

 master

/

moduleExample.js

Copy path

Top

File metadata and controls

• Code
• Blame

62 lines (53 loc) · 2.9 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

57

58

59

60

61

62

/**

* moduleExample.js

*

* This module will generate a random string of letters when we type the command in chat.

*/

(function() {

// Global variables for this script if needed.

var myRandomVariableToGetAndSetDbString = $.getSetIniDbString('my_db_table', 'my_db_key', 'my_db_string'),

myRandomVariableToGetAndSetDbBoolean = $.getSetIniDbBoolean('my_db_table', 'my_db_key', false),

myRandomVariableToGetAndSetDbNumber = $.getSetIniDbNumber('my_db_table', 'my_db_key', 0),

myRandomStaticVariable = 'something';

// Function to generate a random string of letters.

function getRandomString(size) {

// Local variables just for this function.

var letters = 'abcdefghijklmnopqrstuvwxyz',

data = '',

i;

for (i = 0; i < size; i++) {

data += letters.charAt(Math.floor(Math.random() * letters.length));

}

return data;

}

// Command event for when someone types a command for this module.

$.bind('command', function(event) {

var command = event.getCommand(), // command name all lower case.

sender = event.getSender(), // user who sent the command lower case.

args = event.getArgs(); // each argument after the command in an array.

// Command name.

if (command.equalsIgnoreCase('randomstring')) {

// Check for arguments, if needed.

if (args[0] === undefined) {

// Say something to the user.

$.say($.whisperPrefix(sender) + 'Usage: !randomstring [length of the string]');

// Stop here.

return;

}

// Argument was said, say this in chat now.

$.say('Random string: ' + getRandomString(parseInt(args[0])));

}

});

// Event that runs once at boot-up if the module is enabled.

$.bind('initReady', function() {

// Register the command with the: module path, command name, and command permission.

$.registerChatCommand('./commands/moduleExample.js', 'randomstring', 7);

});

})();

// INFORMATION ABOUT SUBMITING A PULL-REQUEST FOR A NEW MODULE. PLEASE READ:

// If you're planning on making a module for the master build please take a look at the current scripts and follow their code style

// of we will not merge your pull-request into the master build. Also keep a mind we do take performance really seriously here,

// if your module is going to slow down the bot, or affect performance we will not merge it, if we think the module isn't fit to be

// in the main build we will also reject it. Another thing, be sure to fully test your module, we will NOT test any pull-request before merging it,

// if we see an issue we will let you know that there's an issue in the code and you will have to fix it if you want us to merge it.

// If your module gets merge but causes an issue in the future it will be reverted without any notice.