ZegoRangeSceneItem

Declared in ZegoExpressDefines.h

方法

setEventHandler:

- (BOOL)setEventHandler:(nullable id<ZegoRangeSceneItemEventHandler>) handler;

设置范围场景物品管理回调。

Declared in ZegoExpressDefines.h

参数

名称	类型	描述
handler	nullable id<ZegoRangeSceneItemEventHandler>	用于接收范围场景物品管理回调的对象。

详情

设置范围场景物品管理模块回调。

调用时机：通过 [getRangeSceneItem] 获取范围场景物品管理对象之后。

支持版本：3.1.0 及以上。

返回值

设置范围场景物品管理回调结果。true: 成功, false: 失败。

createItem:callback:

- (int)createItem:(ZegoItemParam *) param callback:(nullable ZegoRangeSceneCreateItemCallback) callback;

创建物品。

Declared in ZegoExpressDefines.h

参数

名称	类型	描述
param	ZegoItemParam *	物品参数。
callback	nullable ZegoRangeSceneCreateItemCallback	创建物品结果回调。

详情

创建物品。

业务场景：虚拟世界内物品竞争。
调用时机：登录场景成功之后，[logoutScene] 之前。
相关接口：可调用 [destroyItem] 销毁物品。

支持版本：3.1.0 及以上。
注意事项： 1. 物品属于范围场景，而不是某个用户，当某用户成功绑定某物品时，只是表示该用户拥有对该物品的暂时使用权。 2. 一个物品允许拥有1个或多个绑定用户，申请绑定物品时遵循先到先得的原则。 3. 当有多个用户同时绑定了某个物品时，他们对该物品的变更遵循cas原则。 4. 创建物品时允许指定是否在创建成功后绑定该物品。 5. 物品创建成功时，该物品范围内的用户会收到 [onItemEnterView] 回调通知。

返回值

错误码，详情请参考常用错误码文档 https://doc-zh.zego.im/zh/4378.html

destroyItem:callback:

- (int)destroyItem:(long long) itemID callback:(nullable ZegoRangeSceneDestroyItemCallback) callback;

销毁物品。

Declared in ZegoExpressDefines.h

参数

名称	类型	描述
itemID	long long	物品 ID。
callback	nullable ZegoRangeSceneDestroyItemCallback	销毁物品结果回调。

详情

销毁物品。

业务场景：虚拟世界内物品竞争。
调用时机：登录场景成功之后，[logoutScene] 之前。
相关接口：可调用 [createItem] 创建物品。

支持版本：3.1.0 及以上。
注意事项：物品被销毁时，该物品范围内的用户会收到 [onItemLeaveView]回调通知。

返回值

错误码，详情请参考常用错误码文档 https://doc-zh.zego.im/zh/4378.html

bindItem:callback:

- (int)bindItem:(long long) itemID callback:(nullable ZegoRangeSceneBindItemCallback) callback;

申请绑定物品。

Declared in ZegoExpressDefines.h

参数

名称	类型	描述
itemID	long long	物品 ID。
callback	nullable ZegoRangeSceneBindItemCallback	申请绑定物品结果回调。

详情

申请绑定物品。

业务场景：虚拟世界内物品竞争。
调用时机：登录场景成功之后，[logoutScene] 之前。
相关接口：可调用 [unbindItem] 申请解绑物品。

支持版本：3.1.0 及以上。
注意事项：成功绑定物品时，该物品范围内的用户会收到 [onItemBindUpdate] 回调通知。

返回值

错误码，详情请参考常用错误码文档 https://doc-zh.zego.im/zh/4378.html

unbindItem:callback:

- (int)unbindItem:(long long) itemID callback:(nullable ZegoRangeSceneUnbindItemCallback) callback;

申请解绑物品。

Declared in ZegoExpressDefines.h

参数

名称	类型	描述
itemID	long long	物品 ID。
callback	nullable ZegoRangeSceneUnbindItemCallback	销毁物品结果回调。

详情

申请解绑物品。

业务场景：虚拟世界内物品竞争。
调用时机：[bindItem] 之后，[logoutScene] 之前。
相关接口：可调用 [bindItem] 申请绑定物品。

支持版本：3.1.0 及以上。
注意事项：成功解绑物品时，该物品范围内的用户会收到 [onItemUnbindUpdate] 回调通知。

返回值

错误码，详情请参考常用错误码文档 https://doc-zh.zego.im/zh/4378.html

updateItemStatus:position:channel:status:callback:

- (int)updateItemStatus:(long long) itemID position:(ZegoPosition *) position channel:(unsigned int) channel status:(NSData *) status callback:(nullable ZegoRangeSceneUpdateItemStatusCallback) callback;

更新物品的状态。

Declared in ZegoExpressDefines.h

参数

名称	类型	描述
itemID	long long	物品 ID。
position	ZegoPosition *	物品当前位置。
channel	unsigned int	状态所属通道，从0开始，不能超过最大通道号。
status	NSData *	物品当前状态数据。
callback	nullable ZegoRangeSceneUpdateItemStatusCallback	更新物品状态结果回调。

详情

开发者可以调用该接口更新物品的状态。

调用时机：[onBindItem] 之后，[unbindItem] 之前。

支持版本：3.1.0 及以上。
使用限制：无。
注意事项：无。

返回值

错误码，详情请参考常用错误码文档 https://doc-zh.zego.im/zh/4378.html

updateItemCommand:position:channel:command:callback:

- (int)updateItemCommand:(long long) itemID position:(ZegoPosition *) position channel:(unsigned int) channel command:(NSData *) command callback:(nullable ZegoRangeSceneUpdateItemCommandCallback) callback;

更新物品的指令。

Declared in ZegoExpressDefines.h

参数

名称	类型	描述
itemID	long long	物品 ID。
position	ZegoPosition *	物品当前位置。
channel	unsigned int	状态所属通道，从0开始，不能超过最大通道号。
command	NSData *	物品下一步命令数据。
callback	nullable ZegoRangeSceneUpdateItemCommandCallback	更新物品下一步命令结果回调。

详情

开发者可以调用该接口更新物品的指令。

调用时机：[onBindItem] 之后，[unbindItem] 之前。

支持版本：3.1.0 及以上。
使用限制：无。
注意事项：无。

返回值

错误码，详情请参考常用错误码文档 https://doc-zh.zego.im/zh/4378.html