CustomProperty

自定义属性

 获取元件身上的自定义属性

---

枚举列表

CustomProperty.PROPERTY_TYPE

• 描述: 自定义属性类型

成员名称	成员说明
Bool	布尔值
Number	数值
String	字符串
Color	颜色
Vector	向量
Element	元件预设
Particle	特效
ChainParticle	链式特效
Audio	音效
Image	图片
CharacterPart	角色部位
Animation	动画
RechargeAbility	充能大招
Prop	道具
CustomUI	自定义UI控件

---

函数列表

GetCustomProperty

• 描述: 获取场景实例身上的自定义属性

• 范围: 服务端、客户端

• 警告: 扣叮在游戏中修改自定义参数只在服务端生效，客户端只能读取到编辑地图保存时的预设值

参数列表:

参数	类型	说明
ElementId	number	场景实例ID
PropertyName	string	自定义属性名称
PropertyType	CustomProperty.PROPERTY_TYPE	自定义属性类型

返回字段:

返回字段	字段类型	说明
value	any	自定义属性值

local elementId = System:GetScriptParentID()
local value = CustomProperty:GetCustomProperty(elementId, "n", CustomProperty.PROPERTY_TYPE.Number)

---

GetCustomPropertyArray

• 描述: 获取自定义数组参数

• 范围: 服务端、客户端

• 警告: 扣叮在游戏中修改自定义参数只在服务端生效，客户端只能读取到编辑地图保存时的预设值

参数列表:

参数	类型	说明
ElementId	number	场景实例ID
PropertyName	string	自定义属性名称
PropertyType	CustomProperty.PROPERTY_TYPE	自定义属性类型

返回字段:

返回字段	字段类型	说明
valueArray	any[]	自定义属性值数组

local elementId = System:GetScriptParentID()
local valueArray = CustomProperty:GetCustomPropertyArray(elementId, "n", CustomProperty.PROPERTY_TYPE.Number)

---

SetCustomProperty

• 描述: 设置自定义参数

• 描述: 参数需要符合自定义属性类型，否则会设置失败

• 范围: 服务端、客户端

参数列表:

参数	类型	说明
ElementId	number	场景实例ID
PropertyName	string	自定义属性名称
PropertyType	CustomProperty.PROPERTY_TYPE	自定义属性类型
Value	any	自定义属性值

local ElementId = System:GetScriptParentID()
local Num = 1
CustomProperty:SetCustomProperty(ElementId, "n", CustomProperty.PROPERTY_TYPE.Number,Num)

---

SetCustomPropertyArray

• 描述: 设置自定义数组参数

• 描述: 数组中每个参数需要符合自定义属性类型，否则会设置失败

• 范围: 服务端、客户端

参数列表:

参数	类型	说明
ElementId	number	场景实例ID
PropertyName	string	自定义属性名称
PropertyType	CustomProperty.PROPERTY_TYPE	自定义属性类型
ValueArray	any[]	自定义属性值数组

local ElementId = System:GetScriptParentID()
local NumberArray = {1,2,3,4}
CustomProperty:SetCustomPropertyArray(ElementId, "n", CustomProperty.PROPERTY_TYPE.Number,NumberArray)

---