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

来自天龙知识库
跳到导航跳到搜索
雪舞​(留言 | 贡献)
维护服务端 Lua 接口:核对参数、返回值、边界条件与调用示例
Waylee​(留言 | 贡献)
维护服务端 Lua 接口:核对参数、返回值、边界条件与调用示例
 
(未显示2个用户的4个中间版本)
第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>


== 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;">DelItem(sceneId, selfId, itemIndex, delCount)</pre>
<pre>DelItem(sceneId, selfId, itemIndex, delCount)</pre>
 
服务端脚本中共出现 260 处调用,实参个数出现过:4 个(260 处)。
 
实现位于 <code>LuaFnTbl_Attr.h</code>。


== 参数 ==
== 参数 ==
{| 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。
| 当前调用所在的场景 ID。<br /><span class="lua-muted">脚本中的实参:<code>sceneId</code>(260 处)</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。
| 当前场景内的对象 ID。玩家接口需传入有效玩家对象;不是角色 GUID。<br /><span class="lua-muted">脚本中的实参:<code>selfId</code>(259 处)、<code>idObjSaved</code></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;">itemIndex</code><br /><span style="color:#657078;"><code style="white-space:normal;overflow-wrap:anywhere;">number</code></span>
| <code>itemIndex</code><br /><span class="lua-muted"><code>number</code></span>
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | 要扣除的物品配置编号,不是背包格子位置,也不是物品 GUID。
| 要扣除的物品配置编号,不是背包格子位置,也不是物品 GUID。<br /><span class="lua-muted">脚本中的实参:<code>demandItemId</code>(40 处)、<code>itemId</code>(37 处)、<code>item.id</code>(10 处)</span>
|-
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | 4
| 4
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">delCount</code><br /><span style="color:#657078;"><code style="white-space:normal;overflow-wrap:anywhere;">number</code></span>
| <code>delCount</code><br /><span class="lua-muted"><code>number</code></span>
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | 要扣除的总数量,必须是正整数;不要传 0、负数或小数。
| 要扣除的总数量,必须是正整数;不要传 0、负数或小数。<br /><span class="lua-muted">脚本中的实参:<code>1</code>(172 处)、<code>LuaFnGetAvailableItemCount(sceneId, selfId, x808</code>(34 处)、<code>5</code>(18 处)</span>
|}
|}


第35行: 第39行:


== 调用示例 ==
== 调用示例 ==
<pre style="white-space:pre-wrap;overflow-wrap:anywhere;font-size:13px;line-height:1.7;padding:12px;background:#f5f7f8;border:1px solid #dbe3e6;">-- itemTypeSn 是有效物品配置编号;此段用于已有 DelItem 流程
<pre>-- itemTypeSn 是有效物品配置编号;此段用于已有 DelItem 流程
local needCount = 1
local needCount = 1
local available = LuaFnGetAvailableItemCount(sceneId, selfId, itemTypeSn)
local available = LuaFnGetAvailableItemCount(sceneId, selfId, itemTypeSn)
第46行: 第50行:
     end
     end
end</pre>
end</pre>
== 脚本中的调用 ==
以下是服务端脚本里的真实调用点,按实参形态去重后列出 8 条。这些调用取自随包发布的脚本,可用于确认参数顺序与实际传入的值;它们不代表该写法在当前版本仍然有效。
<pre>-- city0_building5.lua
DelItem(sceneId, selfId, x805012_g_TicketItemIdx, 1)
-- event/caoyun/ecaoyun.lua
DelItem(sceneId, selfId, x311010_g_CertificateItem&#91;1&#93;.id, x311010_g_CertificateItem&#91;1&#93;.num)
-- event/caoyun/ecaoyun.lua
DelItem(sceneId, selfId, x311010_g_CashItem_id, x311010_g_CashItem_count)
-- event/city/ecity_0103deliverweapon.lua
DelItem(sceneId, selfId, nItemId, 1)
-- event/city/ecity_0104collectfoundrymat.lua
DelItem(sceneId, selfId, demandItemId, nItemNum)
-- event/city/ecity_0104collectfoundrymat.lua
DelItem(sceneId, selfId, demandItemId, demandItemCount)
-- event/city/ecity_0401seekseedling.lua
DelItem(sceneId, selfId, demandItemId, 1)
-- event/city/ecity_0501contacthero.lua
DelItem(sceneId, selfId, x600024_g_MissionItem, 1)</pre>


== 注意事项 ==
== 注意事项 ==
第53行: 第83行:
* 此接口未先过滤交易锁,也未完整检查底层每次扣除的结果;有交易锁时不能仅凭返回 1 确认实际扣除数量,具体异常表现需要实测。
* 此接口未先过滤交易锁,也未完整检查底层每次扣除的结果;有交易锁时不能仅凭返回 1 确认实际扣除数量,具体异常表现需要实测。
* 常规材料扣除优先使用 [[Lua接口/服务端/LuaFnGetAvailableItemCount|LuaFnGetAvailableItemCount]] 配合 [[Lua接口/服务端/LuaFnDelAvailableItem|LuaFnDelAvailableItem]],并显式判断返回值等于 1。
* 常规材料扣除优先使用 [[Lua接口/服务端/LuaFnGetAvailableItemCount|LuaFnGetAvailableItemCount]] 配合 [[Lua接口/服务端/LuaFnDelAvailableItem|LuaFnDelAvailableItem]],并显式判断返回值等于 1。
 
* 调用前要求玩家处于可执行逻辑的状态(实现体断言 <code>pHuman-&gt;IsCanLogic()</code>);不满足时会记录断言,应先确认玩家当前状态。
<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> 第 3030 行,服务端注册表第 328 行。调用格式与返回数量依据当前实现整理;游戏内效果、边界行为及未注明的业务枚举仍需实测。</div>


</div>
</div>

2026年9月20日 (日) 00:12的最新版本

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

按物品配置编号扣除背包中的指定数量,失败时可能已部分扣除。

Lua 调用

DelItem(sceneId, selfId, itemIndex, delCount)

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

实现位于 LuaFnTbl_Attr.h。

参数

序号 参数 / 类型 说明
1 sceneId
number
当前调用所在的场景 ID。
脚本中的实参:sceneId(260 处)
2 selfId
number
当前场景内的对象 ID。玩家接口需传入有效玩家对象;不是角色 GUID。
脚本中的实参:selfId(259 处)、idObjSaved
3 itemIndex
number
要扣除的物品配置编号,不是背包格子位置,也不是物品 GUID。
脚本中的实参:demandItemId(40 处)、itemId(37 处)、item.id(10 处)
4 delCount
number
要扣除的总数量,必须是正整数;不要传 0、负数或小数。
脚本中的实参:1(172 处)、LuaFnGetAvailableItemCount(sceneId, selfId, x808(34 处)、5(18 处)

返回值

返回一个 number:1 表示扣除流程报告成功,0 表示报告失败,-1 表示对象无效或异常等失败路径。返回 0 时可能已扣除部分物品,不能据此认定背包未变化。

调用示例

-- itemTypeSn 是有效物品配置编号;此段用于已有 DelItem 流程
local needCount = 1
local available = LuaFnGetAvailableItemCount(sceneId, selfId, itemTypeSn)
if available >= needCount then
    local result = DelItem(sceneId, selfId, itemTypeSn, needCount)
    if result == 1 then
        -- 流程报告成功;有交易锁时仍需核对实际扣除
    else
        -- 不自动重试:此时可能已经部分扣除
    end
end

脚本中的调用

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

-- city0_building5.lua
DelItem(sceneId, selfId, x805012_g_TicketItemIdx, 1)

-- event/caoyun/ecaoyun.lua
DelItem(sceneId, selfId, x311010_g_CertificateItem[1].id, x311010_g_CertificateItem[1].num)

-- event/caoyun/ecaoyun.lua
DelItem(sceneId, selfId, x311010_g_CashItem_id, x311010_g_CashItem_count)

-- event/city/ecity_0103deliverweapon.lua
DelItem(sceneId, selfId, nItemId, 1)

-- event/city/ecity_0104collectfoundrymat.lua
DelItem(sceneId, selfId, demandItemId, nItemNum)

-- event/city/ecity_0104collectfoundrymat.lua
DelItem(sceneId, selfId, demandItemId, demandItemCount)

-- event/city/ecity_0401seekseedling.lua
DelItem(sceneId, selfId, demandItemId, 1)

-- event/city/ecity_0501contacthero.lua
DelItem(sceneId, selfId, x600024_g_MissionItem, 1)

注意事项

  • 调用对象必须是当前场景中的有效玩家。
  • 按背包位置顺序查找同编号物品,可跨多个堆叠扣除;不删除已装备物品,不操作银行。
  • 数量不足时可能先扣掉已找到的物品;遇到密码锁物品会中止,之前的扣除不会回滚。
  • 此接口未先过滤交易锁,也未完整检查底层每次扣除的结果;有交易锁时不能仅凭返回 1 确认实际扣除数量,具体异常表现需要实测。
  • 常规材料扣除优先使用 LuaFnGetAvailableItemCount 配合 LuaFnDelAvailableItem,并显式判断返回值等于 1。
  • 调用前要求玩家处于可执行逻辑的状态(实现体断言 pHuman->IsCanLogic());不满足时会记录断言,应先确认玩家当前状态。