Lua接口/服务端/EraseItem:修订间差异

来自天龙知识库
跳到导航跳到搜索
雪舞留言 | 贡献
整理当前服务端 Lua 接口:注册名称、参数、返回值与调用说明
 
雪舞留言 | 贡献
维护服务端 Lua 接口:核对参数、返回值、边界条件与调用示例
 
第3行: 第3行:
[[首页|首页]] · [[Lua接口/服务端函数索引|服务端接口]] · [[Lua接口/服务端函数索引/角色属性与物品|角色属性与物品]] · [[Lua接口/服务端调用约定|调用约定]]
[[首页|首页]] · [[Lua接口/服务端函数索引|服务端接口]] · [[Lua接口/服务端函数索引/角色属性与物品|角色属性与物品]] · [[Lua接口/服务端调用约定|调用约定]]


<div style="padding:14px 0;border-top:3px solid #287568;border-bottom:1px solid #dbe3e6;">删除当前玩家背包某一格的道具</div>
<div style="padding:14px 0;border-top:3px solid #287568;border-bottom:1px solid #dbe3e6;">删除指定背包格的整格物品,包括全部堆叠数量。</div>


同一接口的其他调用名称:<code style="white-space:normal;overflow-wrap:anywhere;">LuaFnEraseItem</code>。
同一接口的其他调用名称:<code style="white-space:normal;overflow-wrap:anywhere;">LuaFnEraseItem</code>。
第26行: 第26行:
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | 3
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | 3
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">bagIndex</code><br /><span style="color:#657078;"><code style="white-space:normal;overflow-wrap:anywhere;">number</code></span>
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">bagIndex</code><br /><span style="color:#657078;"><code style="white-space:normal;overflow-wrap:anywhere;">number</code></span>
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | 背包的格子
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | 待删除的背包格子位置,传入查找接口返回的非负整数;不是物品配置编号或 GUID。
|}
|}


== 返回值 ==
== 返回值 ==
返回 1 个值。返回类型包括 <code style="white-space:normal;overflow-wrap:anywhere;">number</code>。明确的固定返回组合包括 <code style="white-space:normal;overflow-wrap:anywhere;">1</code>;<code style="white-space:normal;overflow-wrap:anywhere;">0</code>;<code style="white-space:normal;overflow-wrap:anywhere;">-1</code>
返回一个 number:1 表示该格物品已删除;0 表示删除失败(如空格或交易锁);-1 表示对象无效或异常等失败路径。
 
== 调用示例 ==
<pre style="white-space:pre-wrap;overflow-wrap:anywhere;font-size:13px;line-height:1.7;padding:12px;background:#f5f7f8;border:1px solid #dbe3e6;">-- 本例明确要删除整格,包含全部堆叠
local bagPos = GetBagPosByItemSnAvailableBind(sceneId, selfId, itemTypeSn, 0)
if bagPos &gt;= 0 then
    if GetItemTableIndexByIndex(sceneId, selfId, bagPos) == itemTypeSn
        and LuaFnIsItemAvailable(sceneId, selfId, bagPos) == 1 then
        local result = EraseItem(sceneId, selfId, bagPos)
        if result == 1 then
            -- 该格物品已删除
        end
    end
end</pre>


== 注意事项 ==
== 注意事项 ==
* 调用对象必须是当前场景中的有效玩家。
* 调用对象必须是当前场景中的有效玩家。
* 删除整格物品,包括该格中的全部堆叠数量;没有数量参数。按编号扣指定数量应使用 [[Lua接口/服务端/LuaFnDelAvailableItem|LuaFnDelAvailableItem]]。
* 删除流程拒绝交易锁,但不主动拒绝密码锁。需要尊重两种锁时,先用 [[Lua接口/服务端/LuaFnIsItemAvailable|LuaFnIsItemAvailable]] 检查。
* 背包格子可能因整理或移动而改变,不能跨回调长期缓存位置;删除前重新核对物品编号。


<div style="margin-top:20px;padding-top:10px;border-top:1px solid #dbe3e6;color:#657078;font-size:12px;">核对依据:<code style="white-space:normal;overflow-wrap:anywhere;">LuaFnTbl_Attr.h</code> 第 3121 行,服务端注册表第 329、822 行。调用格式与返回数量依据当前实现整理;游戏内效果、边界行为及未注明的业务枚举仍需实测。</div>
<div style="margin-top:20px;padding-top:10px;border-top:1px solid #dbe3e6;color:#657078;font-size:12px;">核对依据:<code style="white-space:normal;overflow-wrap:anywhere;">LuaFnTbl_Attr.h</code> 第 3121 行,服务端注册表第 329、822 行。调用格式与返回数量依据当前实现整理;游戏内效果、边界行为及未注明的业务枚举仍需实测。</div>


</div>
</div>

2026年9月7日 (一) 19:42的最新版本

首页 · 服务端接口 · 角色属性与物品 · 调用约定

删除指定背包格的整格物品,包括全部堆叠数量。

同一接口的其他调用名称:LuaFnEraseItem

Lua 调用

EraseItem(sceneId, selfId, bagIndex)

参数

序号 参数 / 类型 说明
1 sceneId
number
当前调用所在的场景 ID。
2 selfId
number
当前场景内的对象 ID。玩家接口需传入有效玩家对象;不是角色 GUID。
3 bagIndex
number
待删除的背包格子位置,传入查找接口返回的非负整数;不是物品配置编号或 GUID。

返回值

返回一个 number:1 表示该格物品已删除;0 表示删除失败(如空格或交易锁);-1 表示对象无效或异常等失败路径。

调用示例

-- 本例明确要删除整格,包含全部堆叠
local bagPos = GetBagPosByItemSnAvailableBind(sceneId, selfId, itemTypeSn, 0)
if bagPos >= 0 then
    if GetItemTableIndexByIndex(sceneId, selfId, bagPos) == itemTypeSn
        and LuaFnIsItemAvailable(sceneId, selfId, bagPos) == 1 then
        local result = EraseItem(sceneId, selfId, bagPos)
        if result == 1 then
            -- 该格物品已删除
        end
    end
end

注意事项

  • 调用对象必须是当前场景中的有效玩家。
  • 删除整格物品,包括该格中的全部堆叠数量;没有数量参数。按编号扣指定数量应使用 LuaFnDelAvailableItem
  • 删除流程拒绝交易锁,但不主动拒绝密码锁。需要尊重两种锁时,先用 LuaFnIsItemAvailable 检查。
  • 背包格子可能因整理或移动而改变,不能跨回调长期缓存位置;删除前重新核对物品编号。
核对依据:LuaFnTbl_Attr.h 第 3121 行,服务端注册表第 329、822 行。调用格式与返回数量依据当前实现整理;游戏内效果、边界行为及未注明的业务枚举仍需实测。