Справочник › Справочник функций › 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"

Назад: Справочник функций