参考 › 函数参考 › Conditions

Conditions.spatial_stats.aggregate

依赖项

调用方式

Conditions.spatial_stats.aggregate(values, operation)

记录依赖项 Conditions.spatial_stats.aggregate,然后按该名称调用。带命名空间的调用不会传入 self:请使用冒号调用,或自行传入该对象。

作用

Reduces the per-unit readings a PROXIMITY_* condition collected to one statistic: their average, minimum or maximum.

参数

名称类型作用
valuesnumber[]Readings from the units in range.
operationstringaverage, minimum or maximum.

返回值

1number | nilThe statistic, or nil when it cannot be computed.
2string | nilReason for nil: no-units-in-range, statistic-unavailable (a nonfinite sum) or invalid-operation.

版本

内置辅助函数在每个版本上都会注册。不同的是它们读取的游戏 API;某个 API 缺失时,辅助函数会改用后备方案,或返回 nil 并附上原因。

它不直接读取任何游戏 API。

插件如何调用它

源码

Conditions/spatial_stats.lua,第 107 行。在游戏中为只读;“复制”会生成一份可编辑的副本。

Conditions.spatial_stats.aggregate(values, operation)
    if #values==0 then return nil,"no-units-in-range" end
    local value=values[1]
    if operation=="average" then
        local sum=0;for _,current in ipairs(values) do sum=sum+current end
        if sum==math.huge or sum==-math.huge or sum~=sum then return nil,"statistic-unavailable" end
        return sum/#values
    elseif operation=="minimum" or operation=="maximum" then
        for index=2,#values do
            if operation=="minimum" then value=math.min(value,values[index])
            else value=math.max(value,values[index]) end
        end
        return value
    end
    return nil,"invalid-operation"

返回函数参考