pgmmv-plugin-template/plugin.js at main · kidthales/pgmmv-plugin-template · GitHub

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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
// noinspection ES6ConvertVarToLetConst
(function () {
  // noinspection UnnecessaryLocalVariableJS
  /**
   * @type {import("pgmmv-types/lib/agtk/plugins/plugin").AgtkPlugin}
   */
  var plugin = {
      setLocale: function (locale) {},

      getInfo: function (category) {
        switch (category) {
          case 'name':
            return 'PGMMV Plugin Template';
          case 'description':
            return 'PGMMV Plugin Template';
          case 'author':
            return 'Author Name';
          case 'help':
            return 'Plugin Help';
          case 'parameter':
            return [];
          case 'internal':
            return {};
          case 'actionCommand':
            return [];
          case 'linkCondition':
            return [];
          default:
            break;
        }
      },

      initialize: function (data) {
        if (isEditor()) {
          return;
        }

        Agtk.log('Initialize ' + plugin.getInfo('name'));
      },

      finalize: function () {},

      setParamValue: function (paramValue) {
        if (isEditor()) {
          return;
        }

        for (var i = 0; i < paramValue.length; ++i) {
          Agtk.log('Parameter ' + paramValue[i].id + ' = ' + paramValue[i].value);
        }
      },

      setInternal: function (data) {},

      call: function () {},

      update: function (delta) {},

      execActionCommand: function (
        actionCommandIndex,
        parameter,
        objectId,
        instanceId,
        actionId,
        commandId,
        commonActionStatus,
        sceneId
      ) {},

      execLinkCondition: function (
        linkConditionIndex,
        parameter,
        objectId,
        instanceId,
        actionLinkId,
        commonActionStatus
      ) {}
    },
    /**
     * @returns {boolean}
     */
    isEditor = function () {
      return !Agtk || typeof Agtk.log !== 'function';
    };

  return plugin;
})();