Lua接口/服务端/EraseItem:修订间差异
来自天龙知识库
跳到导航跳到搜索
维护服务端 Lua 接口:核对参数、返回值、边界条件与调用示例 |
维护服务端 Lua 接口:核对参数、返回值、边界条件与调用示例 |
||
| (未显示同一用户的2个中间版本) | |||
| 第1行: | 第1行: | ||
__NOTOC__ | __NOTOC__ | ||
<div class="lua-reference | <div class="lua-reference"> | ||
[[首页|首页]] · [[Lua接口/服务端函数索引|服务端接口]] · [[Lua接口/服务端函数索引/角色属性与物品|角色属性与物品]] · [[Lua接口/服务端调用约定|调用约定]] | [[首页|首页]] · [[Lua接口/服务端函数索引|服务端接口]] · [[Lua接口/服务端函数索引/角色属性与物品|角色属性与物品]] · [[Lua接口/服务端调用约定|调用约定]] | ||
<div | <div class="lua-lead lua-rule">删除指定背包格的整格物品,包括全部堆叠数量。</div> | ||
同一接口的其他调用名称:<code | 同一接口的其他调用名称:<code>LuaFnEraseItem</code>。 | ||
== Lua 调用 == | == Lua 调用 == | ||
<pre | <pre>EraseItem(sceneId, selfId, bagIndex)</pre> | ||
服务端脚本中共出现 | 服务端脚本中共出现 85 处调用,实参个数出现过:3 个(85 处)。 | ||
实现位于 <code | 实现位于 <code>LuaFnTbl_Attr.h</code>。 | ||
== 参数 == | == 参数 == | ||
{| class="wikitable | {| class="wikitable" | ||
! scope="col" | ! scope="col" class="lua-w11" | 序号 | ||
! scope="col" | ! scope="col" class="lua-w36" | 参数 / 类型 | ||
! scope="col | ! scope="col" | 说明 | ||
|- | |- | ||
| 1 | |||
| <code>sceneId</code><br /><span class="lua-muted"><code>number</code></span> | |||
| 当前调用所在的场景 ID。<br /><span class="lua-muted">脚本中的实参:<code>sceneId</code>(85 处)</span> | |||
|- | |- | ||
| 2 | |||
| <code>selfId</code><br /><span class="lua-muted"><code>number</code></span> | |||
| 当前场景内的对象 ID。玩家接口需传入有效玩家对象;不是角色 GUID。<br /><span class="lua-muted">脚本中的实参:<code>selfId</code>(85 处)</span> | |||
|- | |- | ||
| 3 | |||
| <code>bagIndex</code><br /><span class="lua-muted"><code>number</code></span> | |||
| 待删除的背包格子位置,传入查找接口返回的非负整数;不是物品配置编号或 GUID。<br /><span class="lua-muted">脚本中的实参:<code>bagId</code>(21 处)、<code>find</code>(10 处)、<code>nItemIndex</code>(9 处)</span> | |||
|} | |} | ||
| 第37行: | 第37行: | ||
== 调用示例 == | == 调用示例 == | ||
<pre | <pre>-- 本例明确要删除整格,包含全部堆叠 | ||
local bagPos = GetBagPosByItemSnAvailableBind(sceneId, selfId, itemTypeSn, 0) | local bagPos = GetBagPosByItemSnAvailableBind(sceneId, selfId, itemTypeSn, 0) | ||
if bagPos >= 0 then | if bagPos >= 0 then | ||
| 第51行: | 第51行: | ||
== 脚本中的调用 == | == 脚本中的调用 == | ||
以下是服务端脚本里的真实调用点,按实参形态去重后列出 8 条。这些调用取自随包发布的脚本,可用于确认参数顺序与实际传入的值;它们不代表该写法在当前版本仍然有效。 | 以下是服务端脚本里的真实调用点,按实参形态去重后列出 8 条。这些调用取自随包发布的脚本,可用于确认参数顺序与实际传入的值;它们不代表该写法在当前版本仍然有效。 | ||
<pre | <pre>-- city0_building5.lua | ||
LuaFnEraseItem(sceneId, selfId, i) | LuaFnEraseItem(sceneId, selfId, i) | ||
| 第80行: | 第80行: | ||
* 删除流程拒绝交易锁,但不主动拒绝密码锁。需要尊重两种锁时,先用 [[Lua接口/服务端/LuaFnIsItemAvailable|LuaFnIsItemAvailable]] 检查。 | * 删除流程拒绝交易锁,但不主动拒绝密码锁。需要尊重两种锁时,先用 [[Lua接口/服务端/LuaFnIsItemAvailable|LuaFnIsItemAvailable]] 检查。 | ||
* 背包格子可能因整理或移动而改变,不能跨回调长期缓存位置;删除前重新核对物品编号。 | * 背包格子可能因整理或移动而改变,不能跨回调长期缓存位置;删除前重新核对物品编号。 | ||
* 调用前要求玩家处于可执行逻辑的状态(实现体断言 <code | * 调用前要求玩家处于可执行逻辑的状态(实现体断言 <code>pHuman->IsCanLogic()</code>);不满足时会记录断言,应先确认玩家当前状态。 | ||
</div> | </div> | ||
2026年9月20日 (日) 00:12的最新版本
删除指定背包格的整格物品,包括全部堆叠数量。
同一接口的其他调用名称:LuaFnEraseItem。
Lua 调用
EraseItem(sceneId, selfId, bagIndex)
服务端脚本中共出现 85 处调用,实参个数出现过:3 个(85 处)。
实现位于 LuaFnTbl_Attr.h。
参数
| 序号 | 参数 / 类型 | 说明 |
|---|---|---|
| 1 | sceneIdnumber
|
当前调用所在的场景 ID。 脚本中的实参: sceneId(85 处)
|
| 2 | selfIdnumber
|
当前场景内的对象 ID。玩家接口需传入有效玩家对象;不是角色 GUID。 脚本中的实参: selfId(85 处)
|
| 3 | bagIndexnumber
|
待删除的背包格子位置,传入查找接口返回的非负整数;不是物品配置编号或 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());不满足时会记录断言,应先确认玩家当前状态。