Skip to content

开发插件

插件用于扩展引擎的功能,使其具备额外的能力或特性。

插件格式

插件需要遵循一定的格式进行定义。以下是一个插件的示例格式:

js
export default {
    name: 'PluginName',
    install(engine) {
        let name = '';

        // 定义一个设置名称的方法
        engine.$setName = (val) => {
            name = val;
        };

        // 定义一个获取名称的方法
        engine.$getName = () => {
            return name;
        };
    }
};

在这个示例中,install 方法用于将插件功能注入到引擎实例中。插件提供了两个新方法:$setName$getName,用于设置和获取名称值。

安装插件

要使用插件,首先需要将其安装到引擎实例中。以下是如何进行插件安装的示例:

js
import TestPlugin from './TestPlugin';
import { createPtah } from '@ptahjs/creative-vue';

const ptah = createPtah({
    id: 've1'
});

// 安装插件
ptah.use(TestPlugin);

在这个示例中,createPtah 函数用于创建引擎实例,然后通过 ptah.use 方法将插件安装到引擎中。

使用插件功能

安装插件后,你可以在引擎实例中使用插件提供的功能。例如,在某个 .vue 文件中,你可以这样使用插件的功能:

js
import { usePtahInstance } from '@ptahjs/creative-vue';

const ptahInstance = usePtahInstance();

// 使用插件提供的 $setName 方法
ptahInstance.$setName('Test');

// 使用插件提供的 $getName 方法
console.log(ptahInstance.$getName()); // 输出: 'Test'

在这个示例中,usePtahInstance Hook 用于获取应用实例,然后可以通过插件提供的方法来操作数据或获取结果。

通过插件,你可以轻松扩展引擎的功能,使其更加灵活和强大。