开发者脚本帮助文档

# 状态管理接口 Buff

在使用状态接口前需先创建状态管理对象，方法如下：(此处已废弃)

local Buff = class.Buff.new()

具体函数名及描述如下:

序号 函数名 函数描述
1 addBuff(...) 给对象附加效果
2 removeBuff(...) 给对象移除指定效果
3 clearAllBuff(...) 给对象清除所有效果
4 clearAllBadBuff(...) 为对象清除所有负面效果
5 hasBuff(...) 判断对象身上是否有指定效果
6 getBuffList(...) 获取对象身上效果列表
7 getBuffNumByBuffid(...) 获取对象身上指定效果数量
8 getBuffIndex(...) 获取对象身上指定效果的索引位置(索引从1开始)
9 getBuffLeftTime(...) 获取对象身上指定效果剩余时间
10 getBuffName(...) 获取对象身上状态效果名称
11 GetBuffDefName(...) 获取状态效果名称
12 GetBuffDefDesc(...) 获取状态效果描述

# addBuff

  • 参数及类型：
    • objid:number对象ID
    • buffid:number效果ID
    • bufflv:number效果等级
    • customticks:number效果持续时间(-1表示默认配置，0表示无限)
  • 返回值及类型：
  • 该方法的主要作用： 给对象附加效果
  • 具体使用案例如下：
local code = Buff:addBuff(objid, buffid, bufflv, customticks)
if code == ErrorCode.OK then
	print('执行成功', code )
else
	print('执行失败')
end

# removeBuff

  • 参数及类型：
  • 返回值及类型：
  • 该方法的主要作用： 给对象移除指定效果
  • 具体使用案例如下：
local code = Buff:removeBuff(objid, buffid)
if code == ErrorCode.OK then
	print('执行成功', code )
else
	print('执行失败')
end

# clearAllBuff

  • 参数及类型：
  • 返回值及类型：
  • 该方法的主要作用： 给对象清除所有效果
  • 具体使用案例如下：
local code = Buff:clearAllBuff(objid)
if code == ErrorCode.OK then
	print('执行成功', code )
else
	print('执行失败')
end

# clearAllBadBuff

  • 参数及类型：
  • 返回值及类型：
  • 该方法的主要作用： 为对象清除所有负面效果
  • 具体使用案例如下：
local code = Buff:clearAllBadBuff(objid)
if code == ErrorCode.OK then
	print('执行成功', code )
else
	print('执行失败')
end

# hasBuff

  • 参数及类型：
  • 返回值及类型：
  • 该方法的主要作用： 判断对象身上是否有指定效果
  • 具体使用案例如下：
local code = Buff:hasBuff(objid, buffid, bufflv)
if code == ErrorCode.OK then
	print('执行成功', code )
else
	print('执行失败')
end

# getBuffList

  • 参数及类型：
  • 返回值及类型：
  • 该方法的主要作用： 获取对象身上效果列表
  • 具体使用案例如下：
local code, num, arr = Buff:getBuffList(objid)
if code == ErrorCode.OK then
	print('执行成功', code, num, arr )
else
	print('执行失败')
end

# getBuffNumByBuffid

  • 参数及类型：
  • 返回值及类型：
  • 该方法的主要作用： 获取对象身上指定效果数量
  • 具体使用案例如下：
local code, num = Buff:getBuffNumByBuffid(objid, buffid)
if code == ErrorCode.OK then
	print('执行成功', code, num )
else
	print('执行失败')
end

# getBuffIndex

  • 参数及类型：
  • 返回值及类型：
  • 该方法的主要作用： 获取对象身上指定效果的索引位置(索引从1开始)
  • 具体使用案例如下：
local code, ix = Buff:getBuffIndex(objid, buffid)
if code == ErrorCode.OK then
	print('执行成功', code, ix )
else
	print('执行失败')
end

# getBuffLeftTime

  • 参数及类型：
  • 返回值及类型：
  • 该方法的主要作用： 获取对象身上指定效果剩余时间
  • 具体使用案例如下：
local code, num = Buff:getBuffLeftTime(objid, buffid)
if code == ErrorCode.OK then
	print('执行成功', code, num )
else
	print('执行失败')
end

# getBuffName

  • 参数及类型：
  • 返回值及类型：
  • 该方法的主要作用： 获取对象身上状态效果名称
  • 具体使用案例如下：
local code, name = Buff:getBuffName(objid, buffid)
if code == ErrorCode.OK then
	print('执行成功', code, name )
else
	print('执行失败')
end

# GetBuffDefName

  • 参数及类型：
  • 返回值及类型：
  • 该方法的主要作用： 获取状态效果名称
  • 具体使用案例如下：
local code, name = Buff:GetBuffDefName(buffid)
if code == ErrorCode.OK then
	print('执行成功', code, name )
else
	print('执行失败')
end

# GetBuffDefDesc

  • 参数及类型：
  • 返回值及类型：
  • 该方法的主要作用： 获取状态效果描述
  • 具体使用案例如下：
local code, desc = Buff:GetBuffDefDesc(buffid)
if code == ErrorCode.OK then
	print('执行成功', code, desc )
else
	print('执行失败')
end
上次更新: 2023/5/10 15:09:30

← Actor管理接口 Actor →