简单背包系统，管理游戏中的道具

旧人不必等 · 发表于 2023-3-15 13:54:37

本帖最后由旧人不必等于 2023-3-15 18:44 编辑

简单背包系统
游戏中的物品管理都依赖于背包，这里实现了一套简单的背包系统,支持添加/删除/使用/查找/交换背包物品

一分钟上手
1.将以下预制体导入项目

Bag.zip (39.85 KB, 下载次数: 114)

2023-3-15 13:35 上传

点击文件名下载附件
2.将预制体拖入场景
download_image 1.png

3.修改BagConfigScript的属性

增加物品配置，背包中用到的物品都需要在脚本中增加配置。

4.增加物品
使用Bag.addItem方法在用户获得道具时将道具放入背包，注意道具ID必须配置在上述脚本中。
5.操作指南
5.1使用物品
点击背包中的物品可以直接使用，物品的使用效果需要自己实现，通过BagConfigScript脚本中的onItemUse方法可以监听到物品的使用。
5.2交换背包物品
拖动背包中的物品到其他物品上可以交换位置
5.3删除背包物品
拖动背包物品到背包外面可以删除物品
6.更改UI
如果不满意默认的背包UI，可以修改UI/bag文件夹下的UI文件来实现自定义外观，需要注意的是不要修改现有UI控件的名字

进阶用法
API列表
以下API都属于Bag实例，直接调用Bag.xxx即可

/**

 * 给背包注册物品信息

 * @life 双端调用

 * @param itemId 道具ID

 * @param icon 道具图片

 * @param name 名称

 * @param quality 道具品质

 * @param stackCount 堆叠数量

 * @param customData 额外数据

 * @returns 

 */

public register(itemId: number, icon: string, name: string, quality: ItemQuality = ItemQuality.Common, stackCount: number = 1, customData?: any): this



/**

* 打开背包界面

* @life 双端调用，服务端调用时需要传入player

* @param player 背包的所有者

* @returns 

*/

public open(player?: Gameplay.Player);



/**

 * 获取背包指定道具数量

 * @life 双端可用，服务端调用时需要传入player

 * @param itemId 物品id

 * @param player 物品所有者，服务端必传入

 * @returns 

 */

public itemCount(itemId: number, player?: Gameplay.Player): number;  



 /**

 * 给背包添加物品

 * @life 双端可用，服务端调用时需要传入player

 * @param itemId 物品id

 * @param count 物品数量

 * @param player 物品所有者，服务端必传入

 * @returns 

 */

public addItem(itemId: number, count: number = 1, player?: Gameplay.Player): this;



/**

 * 删除一个物品

 * @life 双端可用，服务端调用时需要传入player

 * @param itemId 物品ID

 * @param count 物品数量

 * @param player 物品所有者，服务端必传入

 * @returns 

 */

public removeItem(itemId: number, count: number = 1, player?: Gameplay.Player): this  

    

 /**

 * 关闭背包界面

 * @life 双端调用，服务端调用时需要传入player

 * @param player 背包的所有者

 * @returns 

 */

public close(player?: Gameplay.Player): this;



 /**

 * 增加道具使用回调

 * @life 客户端调用 

 */

public addUseHandler(useCallback: (struct: IBagStruct, cfg: ItemConfig) => void, thisObject: any): this 

 /**

 * 移除道具使用回调

 * @life 客户端调用 

 */

public removeUseHandler(useCallback: (struct: IBagStruct, cfg: ItemConfig) => void, thisObject: any): this