@luozhifeng/playable-web-gui-sdk
v1.0.4
Published
A SDK for Cocos game development providing parameter adjustment capabilities
Maintainers
Readme
Playable Web Platform SDK
这是一个为 Cocos 游戏开发提供参数调整能力的 SDK。基于 lil-gui 实现,允许在游戏中显示控制面板,实时调整游戏参数。
功能特点
- 基于 lil-gui 的参数控制面板
- 支持实时参数调整
- 支持参数分组管理
- 简单易用的 API
安装
npm install playable-web-platform-sdk使用示例
import { ParameterPanel } from 'playable-web-platform-sdk';
// 创建参数面板实例
const panel = new ParameterPanel();
// 注册要调整的参数
panel.registerParameter({
target: gameObject,
property: 'position',
name: 'Position',
group: 'Transform'
});
// 显示面板
panel.show();API 文档
ParameterPanel
主要的参数面板类,用于管理和显示参数控制界面。
方法
registerParameter(options: ParameterOptions): void注册一个参数到控制面板show(): void显示参数控制面板hide(): void隐藏参数控制面板
ParameterOptions
参数注册选项接口:
interface ParameterOptions {
target: any; // 目标对象
property: string; // 属性名
name?: string; // 显示名称
group?: string; // 分组名称
min?: number; // 最小值(仅用于数字类型)
max?: number; // 最大值(仅用于数字类型)
step?: number; // 步进值(仅用于数字类型)
}许可证
MIT
