phaser/src/core/Plugin.js at 5d4da0ce66be794a36fb35d2b05ab33e68deaa01 · ITCSsDeveloper/phaser · 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
/**
* Phaser - Plugin
*
* This is a base Plugin template to use for any Phaser plugin development
*/
Phaser.Plugin = function (game, parent) {

    this.game = game;
    this.parent = parent;

    this.active = false;
    this.visible = false;

    this.hasPreUpdate = false;
    this.hasUpdate = false;
    this.hasPostUpdate = false;
    this.hasPreRender = false;
    this.hasRender = false;
    this.hasPostRender = false;

};

Phaser.Plugin.prototype = {

    /**
    * Pre-update is called at the start of the update cycle, before any other updates have taken place.
    * It is only called if active is set to true.
    */
    preUpdate: function () {
    },

    /**
    * Pre-update is called at the start of the update cycle, before any other updates have taken place.
    * It is only called if active is set to true.
    */
    update: function () {
    },

    /**
    * Post-update is called at the end of the objects update cycle, after other update logic has taken place.
    * It is only called if active is set to true.
    */
    postUpdate: function () {
    },

    /**
    * Pre-render is called right before the Game Renderer starts and before any custom preRender callbacks have been run.
    * It is only called if visible is set to true.
    */
    preRender: function () {
    },

    /**
    * Pre-render is called right before the Game Renderer starts and before any custom preRender callbacks have been run.
    * It is only called if visible is set to true.
    */
    render: function () {
    },

    /**
    * Post-render is called after every camera and game object has been rendered, also after any custom postRender callbacks have been run.
    * It is only called if visible is set to true.
    */
    postRender: function () {
    },

    /**
    * Clear down this Plugin and null out references
    */
    destroy: function () {

        this.game = null;
        this.parent = null;
        this.active = false;
        this.visible = false;

    }

};