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

来自天龙知识库
跳到导航跳到搜索
雪舞​(留言 | 贡献)
维护服务端 Lua 接口:核对参数、返回值、边界条件与调用示例
Waylee​(留言 | 贡献)
维护服务端 Lua 接口:核对参数、返回值、边界条件与调用示例
第1行: 第1行:
__NOTOC__
__NOTOC__
<div class="lua-reference" style="max-width:1200px;margin:0 auto;line-height:1.8;color:#29343a;font-family:Arial,'Microsoft YaHei',sans-serif;letter-spacing:0;overflow-wrap:anywhere;">
<div class="lua-reference">
[[首页|首页]] · [[Lua接口/服务端函数索引|服务端接口]] · [[Lua接口/服务端函数索引/角色属性与物品|角色属性与物品]] · [[Lua接口/服务端调用约定|调用约定]]
[[首页|首页]] · [[Lua接口/服务端函数索引|服务端接口]] · [[Lua接口/服务端函数索引/角色属性与物品|角色属性与物品]] · [[Lua接口/服务端调用约定|调用约定]]


<div style="padding:14px 0;border-top:3px solid #287568;border-bottom:1px solid #dbe3e6;">删除指定背包格的整格物品,包括全部堆叠数量。</div>
<div class="lua-lead lua-rule">删除指定背包格的整格物品,包括全部堆叠数量。</div>


同一接口的其他调用名称:<code style="white-space:normal;overflow-wrap:anywhere;">LuaFnEraseItem</code>。
同一接口的其他调用名称:<code>LuaFnEraseItem</code>。


== Lua 调用 ==
== Lua 调用 ==
<pre style="white-space:pre-wrap;overflow-wrap:anywhere;font-size:13px;line-height:1.7;padding:12px;background:#f5f7f8;border:1px solid #dbe3e6;">EraseItem(sceneId, selfId, bagIndex)</pre>
<pre>EraseItem(sceneId, selfId, bagIndex)</pre>


服务端脚本中共出现 84 处调用,实参个数出现过:3 个(84 处)。
服务端脚本中共出现 84 处调用,实参个数出现过:3 个(84 处)。


实现位于 <code style="white-space:normal;overflow-wrap:anywhere;">LuaFnTbl_Attr.h</code> 第 3120 行,注册表第 333、826 行。
实现位于 <code>LuaFnTbl_Attr.h</code> 第 3120 行,注册表第 333、826 行。


== 参数 ==
== 参数 ==
{| class="wikitable" style="width:100%;table-layout:fixed;border-collapse:collapse;font-size:13px;"
{| class="wikitable"
! scope="col" style="text-align:left;background:#edf3f2;padding:8px;width:11%;" | 序号
! scope="col" class="lua-w11" | 序号
! scope="col" style="text-align:left;background:#edf3f2;padding:8px;width:36%;" | 参数 / 类型
! scope="col" class="lua-w36" | 参数 / 类型
! scope="col" style="text-align:left;background:#edf3f2;padding:8px;" | 说明
! scope="col" | 说明
|-
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | 1
| 1
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">sceneId</code><br /><span style="color:#657078;"><code style="white-space:normal;overflow-wrap:anywhere;">number</code></span>
| <code>sceneId</code><br /><span class="lua-muted"><code>number</code></span>
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | 当前调用所在的场景 ID。<br /><span style="color:#657078;">脚本中的实参:<code style="white-space:normal;overflow-wrap:anywhere;">sceneId</code>(84 处)</span>
| 当前调用所在的场景 ID。<br /><span class="lua-muted">脚本中的实参:<code>sceneId</code>(84 处)</span>
|-
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | 2
| 2
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">selfId</code><br /><span style="color:#657078;"><code style="white-space:normal;overflow-wrap:anywhere;">number</code></span>
| <code>selfId</code><br /><span class="lua-muted"><code>number</code></span>
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | 当前场景内的对象 ID。玩家接口需传入有效玩家对象;不是角色 GUID。<br /><span style="color:#657078;">脚本中的实参:<code style="white-space:normal;overflow-wrap:anywhere;">selfId</code>(84 处)</span>
| 当前场景内的对象 ID。玩家接口需传入有效玩家对象;不是角色 GUID。<br /><span class="lua-muted">脚本中的实参:<code>selfId</code>(84 处)</span>
|-
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | 3
| 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>
| <code>bagIndex</code><br /><span class="lua-muted"><code>number</code></span>
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | 待删除的背包格子位置,传入查找接口返回的非负整数;不是物品配置编号或 GUID。<br /><span style="color:#657078;">脚本中的实参:<code style="white-space:normal;overflow-wrap:anywhere;">bagId</code>(21 处)、<code style="white-space:normal;overflow-wrap:anywhere;">find</code>(10 处)、<code style="white-space:normal;overflow-wrap:anywhere;">nItemIndex</code>(9 处)</span>
| 待删除的背包格子位置,传入查找接口返回的非负整数;不是物品配置编号或 GUID。<br /><span class="lua-muted">脚本中的实参:<code>bagId</code>(21 处)、<code>find</code>(10 处)、<code>nItemIndex</code>(9 处)</span>
|}
|}


第37行: 第37行:


== 调用示例 ==
== 调用示例 ==
<pre style="white-space:pre-wrap;overflow-wrap:anywhere;font-size:13px;line-height:1.7;padding:12px;background:#f5f7f8;border:1px solid #dbe3e6;">-- 本例明确要删除整格,包含全部堆叠
<pre>-- 本例明确要删除整格,包含全部堆叠
local bagPos = GetBagPosByItemSnAvailableBind(sceneId, selfId, itemTypeSn, 0)
local bagPos = GetBagPosByItemSnAvailableBind(sceneId, selfId, itemTypeSn, 0)
if bagPos &gt;= 0 then
if bagPos &gt;= 0 then
第51行: 第51行:
== 脚本中的调用 ==
== 脚本中的调用 ==
以下是服务端脚本里的真实调用点,按实参形态去重后列出 8 条。这些调用取自随包发布的脚本,可用于确认参数顺序与实际传入的值;它们不代表该写法在当前版本仍然有效。
以下是服务端脚本里的真实调用点,按实参形态去重后列出 8 条。这些调用取自随包发布的脚本,可用于确认参数顺序与实际传入的值;它们不代表该写法在当前版本仍然有效。
<pre style="white-space:pre-wrap;overflow-wrap:anywhere;font-size:13px;line-height:1.7;padding:12px;background:#f5f7f8;border:1px solid #dbe3e6;">-- city0_building5.lua
<pre>-- city0_building5.lua
LuaFnEraseItem(sceneId, selfId, i)
LuaFnEraseItem(sceneId, selfId, i)


第80行: 第80行:
* 删除流程拒绝交易锁,但不主动拒绝密码锁。需要尊重两种锁时,先用 [[Lua接口/服务端/LuaFnIsItemAvailable|LuaFnIsItemAvailable]] 检查。
* 删除流程拒绝交易锁,但不主动拒绝密码锁。需要尊重两种锁时,先用 [[Lua接口/服务端/LuaFnIsItemAvailable|LuaFnIsItemAvailable]] 检查。
* 背包格子可能因整理或移动而改变,不能跨回调长期缓存位置;删除前重新核对物品编号。
* 背包格子可能因整理或移动而改变,不能跨回调长期缓存位置;删除前重新核对物品编号。
* 调用前要求玩家处于可执行逻辑的状态(实现体断言 <code style="white-space:normal;overflow-wrap:anywhere;">pHuman-&gt;IsCanLogic()</code>);不满足时会记录断言,应先确认玩家当前状态。
* 调用前要求玩家处于可执行逻辑的状态(实现体断言 <code>pHuman-&gt;IsCanLogic()</code>);不满足时会记录断言,应先确认玩家当前状态。


</div>
</div>

2026年9月19日 (六) 16:55的版本

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

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

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

Lua 调用

EraseItem(sceneId, selfId, bagIndex)

服务端脚本中共出现 84 处调用,实参个数出现过:3 个(84 处)。

实现位于 LuaFnTbl_Attr.h 第 3120 行,注册表第 333、826 行。

参数

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

返回值

返回一个 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

脚本中的调用

以下是服务端脚本里的真实调用点,按实参形态去重后列出 8 条。这些调用取自随包发布的脚本,可用于确认参数顺序与实际传入的值;它们不代表该写法在当前版本仍然有效。

-- city0_building5.lua
LuaFnEraseItem(sceneId, selfId, i)

-- city0_building5.lua
EraseItem(sceneId, selfId, index1)

-- event/equip/equip_bind.lua
LuaFnEraseItem(sceneId, selfId, itemIndex2)

-- event/equip/equip_changevisual.lua
LuaFnEraseItem(sceneId, selfId, nItemIndex2)

-- event/equip/equip_enchance.lua
LuaFnEraseItem(sceneId, selfId, itemidx2)

-- event/equip/judge_aptitude.lua
LuaFnEraseItem(sceneId, selfId, ShaPos)

-- event/EventScript/event_lootitem.lua
EraseItem(sceneId, selfId, ItemPos)

-- event/liveabilityevent/gem_compound.lua
LuaFnEraseItem(sceneId, selfId, bagIndexList[i])

注意事项

  • 调用对象必须是当前场景中的有效玩家。
  • 删除整格物品,包括该格中的全部堆叠数量;没有数量参数。按编号扣指定数量应使用 LuaFnDelAvailableItem。
  • 删除流程拒绝交易锁,但不主动拒绝密码锁。需要尊重两种锁时,先用 LuaFnIsItemAvailable 检查。
  • 背包格子可能因整理或移动而改变,不能跨回调长期缓存位置;删除前重新核对物品编号。
  • 调用前要求玩家处于可执行逻辑的状态(实现体断言 pHuman->IsCanLogic());不满足时会记录断言,应先确认玩家当前状态。