Home

function: registerPlugin


registerPlugin(pluginName: string, ctor: function): void

Adds a plugin to an object

Params:

Name Type Attribute Description
pluginName

The events that should be listed.

ctor

The constructor function for the plugin.

Returns:

void

  {
    "comment": "/**\n     * Adds a plugin to an object\n     *\n     * @param {string} pluginName - The events that should be listed.\n     * @param {Function} ctor - The constructor function for the plugin.\n     */",
    "meta": {
        "range": [
            497,
            613
        ],
        "filename": "pluginTarget.js",
        "lineno": 23,
        "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\utils",
        "code": {
            "id": "astnode100047990",
            "name": "obj.registerPlugin",
            "type": "FunctionExpression",
            "value": "registerPlugin",
            "paramnames": [
                "pluginName",
                "ctor"
            ]
        },
        "vars": {
            "obj.__plugins[undefined]": "obj.__plugins[undefined]"
        }
    },
    "description": "

Adds a plugin to an object

", "params": [ { "type": { "names": [ "string" ] }, "description": "

The events that should be listed.

", "name": "pluginName" }, { "type": { "names": [ "function" ] }, "description": "

The constructor function for the plugin.

", "name": "ctor" } ], "name": "registerPlugin", "longname": "obj.registerPlugin", "kind": "function", "memberof": "obj", "scope": "static", "___id": "T000002R004452", "___s": true, "filepath": "core\\utils\\pluginTarget.js" }