数组变量数据管理接口 Array

具体函数名及描述如下:

序号	函数名	函数描述
1	SetValue(...)	设置组对应索引的值，索引值不允许大于数组当前大小
2	InsertValue(...)	插入数据到数组， index为空就加到最后
3	ReplaceValue(...)	替换组中的值
4	GetValue(...)	获取对应索引数据
5	GetIndexByValue(...)	获取数据对应索引
6	RemoveByValue(...)	删除数组中该值的所有数据
7	Remove(...)	删除索引的值
8	Clear(...)	清理数组数据
9	Sort(...)	数组排序
10	GetSize(...)	获取数组长度
11	GetAllValue(...)	获取数组所有数据
12	GetMax(...)	获取数组最大值
13	GetMin(...)	获取数组最小值
14	RandomValue(...)	数组随机值
15	HasValue(...)	组是否有值
16	HasValueByNo(...)	任意组索引是否有任意值
17	InsertValues(...)	组合并
18	RemoveByValues(...)	组合并
19	GetCountByValue(...)	获取任意组种任意值的数量
20	IncreasesValue(...)	数值组指定索引值增加指定值

SetValue

• 参数及类型：
  • varId:string表ID
  • playerId:number玩家uin（全局变量传nil）
  • value:any具体值
  • index:number索引
• 返回值及类型：
  • ret:bool是否成功
• 该方法的主要作用： 设置组对应索引的值，索引值不允许大于数组当前大小
• 具体使用案例如下：

    -- 将数值组的索引1位置的值设置为44

    Data.Array:SetValue(arrayId, nil, 44, 1)

InsertValue

• 参数及类型：
  • varId:string表ID
  • playerId:number玩家uin（全局变量传nil）
  • value:any具体值
  • index:number索引
• 返回值及类型：
  • ret:bool是否成功
• 该方法的主要作用： 插入数据到数组， index为空就加到最后
• 具体使用案例如下：

    -- 末尾插入数字5

    Data.Array:InsertValue(arrayId, nil, 5)

    -- 在索引1位置插入数字4

    Data.Array:InsertValue(arrayId, nil, 4, 1)

ReplaceValue

• 参数及类型：
  • varId:string表ID
  • playerId:number玩家uin（全局变量传nil）
  • newvalue:any具体值
  • oldValue:any具体值
• 返回值及类型：
  • ret:bool是否成功
• 该方法的主要作用： 替换组中的值
• 具体使用案例如下：

    -- 将数值组的全部5替换为55

    Data.Array:ReplaceValue(arrayId, nil, 55, 5)

GetValue

• 参数及类型：
  • varId:string表ID
  • playerId:number玩家uin
  • index:number索引
• 返回值及类型：
  • ret:any返回值
• 该方法的主要作用： 获取对应索引数据
• 具体使用案例如下：

    local value = Data.Array:GetValue(arrayId, nil, 1)

GetIndexByValue

• 参数及类型：
  • varId:string表ID
  • playerId:number玩家uin（全局变量传nil）
  • value:any具体值
• 返回值及类型：
  • ret:number索引
• 该方法的主要作用： 获取数据对应索引
• 具体使用案例如下：

    local indexByValue = Data.Array:GetIndexByValue(arrayId, nil, 5)

RemoveByValue

• 参数及类型：
  • varId:string表ID
  • playerId:number玩家uin（全局变量传nil）
  • value:any具体值
• 返回值及类型：
  • ret:bool是否成功
• 该方法的主要作用： 删除数组中该值的所有数据
• 具体使用案例如下：

    Data.Array:RemoveByValue(arrayId, nil, 55)

Remove

• 参数及类型：
  • varId:string表ID
  • playerId:number玩家uin（全局变量传nil）
  • index:number索引
• 返回值及类型：
  • ret:bool是否成功
• 该方法的主要作用： 删除索引的值
• 具体使用案例如下：

    local isSuccess = Data.Array:Remove(arrayId, nil, 1)

Clear

• 参数及类型：
  • varId:string表ID
  • playerId:number玩家uin（全局变量传nil）
• 返回值及类型：
  • ret:bool是否成功
• 该方法的主要作用： 清理数组数据
• 具体使用案例如下：

    Data.Array:Clear(arrayId)

Sort

• 参数及类型：
  • varId:string表ID
  • playerId:number玩家uin（全局变量传nil）
  • isUp:number排序方式
• 返回值及类型：
  • ret:bool是否成功
• 该方法的主要作用： 数组排序
• 具体使用案例如下：

    -- 将数值组arrayId按升序排序

    local isSuccess = Data.Array:Sort(arrayId, nil, SortType.Up)

GetSize

• 参数及类型：
  • varId:string表ID
  • playerId:number玩家uin（全局变量传nil）
• 返回值及类型：
  • ret:num数量
• 该方法的主要作用： 获取数组长度
• 具体使用案例如下：

local ret = Data.Array:GetSize(varId, playerId)

GetAllValue

• 参数及类型：
  • varId:string表ID
  • playerId:number玩家uin
• 返回值及类型：
  • ret:table数组值
• 该方法的主要作用： 获取数组所有数据
• 具体使用案例如下：

    local allValues = Data.Array:GetAllValue(arrayId)

    local allValues2 = Data.Array:GetAllValue(arrayPlayerId, Player:GetHostUin())

GetMax

• 参数及类型：
  • varId:string表ID
  • playerId:number玩家uin（全局变量传nil）
• 返回值及类型：
  • ret:number数值
• 该方法的主要作用： 获取数组最大值
• 具体使用案例如下：

    local max = Data.Array:GetMax(arrayId)

GetMin

• 参数及类型：
  • varId:string表ID
  • playerId:number玩家uin（全局变量传nil）
• 返回值及类型：
  • ret:number数值
• 该方法的主要作用： 获取数组最小值
• 具体使用案例如下：

    local min = Data.Array:GetMin(arrayId)

RandomValue

• 参数及类型：
  • varId:string表ID
  • playerId:number玩家uin（全局变量传nil）
• 返回值及类型：
  • ret:number数值
• 该方法的主要作用： 数组随机值
• 具体使用案例如下：

    local randomValue = Data.Array:RandomValue(arrayId)

HasValue

• 参数及类型：
  • varId:string表ID
  • playerId:number玩家uin（全局变量传nil）
  • value:any具体值
• 返回值及类型：
  • ret:bool是否有值
• 该方法的主要作用： 组是否有值
• 具体使用案例如下：

    local hasValue = Data.Array:HasValue(arrayId, nil, 5)

HasValueByNo

• 参数及类型：
  • varId:string表ID
  • playerId:number玩家uin
  • index:number索引
• 返回值及类型：
  • ret:bool是否有值
• 该方法的主要作用： 任意组索引是否有任意值
• 具体使用案例如下：

    local hasValueByNo = Data.Array:HasValueByNo(arrayId, nil, 1)

InsertValues

• 参数及类型：
  • varId:string表ID
  • playerId:number玩家uin（全局变量传nil）
  • index:number索引
  • varId:string表ID
  • playerId:number玩家uin（全局变量传nil）
• 返回值及类型：
  • ret:bool是否成功
• 该方法的主要作用： 组合并
• 具体使用案例如下：

    local size = Data.Array:GetSize(arrayId)

RemoveByValues

• 参数及类型：
  • varId:string表ID
  • playerId:number玩家uin（全局变量传nil）
  • index:number索引
  • varId:string表ID
  • playerId:number玩家uin（全局变量传nil）
• 返回值及类型：
  • ret:bool是否成功
• 该方法的主要作用： 组合并
• 具体使用案例如下：

    -- 将玩家私有变量组arrayPlayerId的全部值从数值组arrayId中删除

    Data.Array:RemoveByValues(arrayId, nil, arrayPlayerId, Player:GetHostUin())

GetCountByValue

• 参数及类型：
  • varId:string表ID
  • playerId:number玩家uin（全局变量传nil）
  • value:any具体值
• 返回值及类型：
  • ret:number数量
• 该方法的主要作用： 获取任意组种任意值的数量
• 具体使用案例如下：

    local countByValue = Data.Array:GetCountByValue(arrayId, nil, 5)

IncreasesValue

• 参数及类型：
  • varId:string表ID
  • playerId:number玩家uin（全局变量传nil）
  • value:number具体值
  • index:number索引
• 返回值及类型：
  • ret:bool是否成功
• 该方法的主要作用： 数值组指定索引值增加指定值
• 具体使用案例如下：

    -- 将数值组的索引1位置的值增加10

    local isSuccess = Data.Array:IncreasesValue(arrayId, nil, 10, 1)