Core.threat_count_conditions.readField

Как вызывать

Core.threat_count_conditions.readField(platform, object, key)

Запишите зависимость Core.threat_count_conditions.readField и вызывайте её по этому имени. Вызов через пространство имён не передаёт self: используйте вызов через двоеточие или передайте объект сами.

Что делает

Reads object[key] for the threat-count conditions without letting a restricted value, a non-table object or an index error escape.

Аргументы

Имя	Тип	Что делает
`platform`	`RMPlatform`	Platform whose CanReadValue decides readability.
`object`	`any`	Table to read, such as the addon or a unit snapshot entry.
`key`	`any`	Key to read, such as "unitsInRange".

Возвращает

1	`any`	The field's value (possibly nil), or nil on failure.
2	`string \| nil`	Reason on failure: restricted-value, invalid-unit-snapshot or unit-snapshot-read-error.

Издания

Встроенные помощники регистрируются во всех изданиях. Различается игровой API, который они читают; если нужного API нет, помощник использует запасной вариант или возвращает nil с причиной.

Не читает игровой API напрямую.

Секретные значения (Retail и Forever)

В Retail и Forever игра передаёт аддонам секретные значения. Этот помощник проверяет то, что читает (addon.Platform:CanReadValue), и вместо секретного значения, которое нельзя сравнить, возвращает nil с причиной, например restricted-value. Считайте nil недоступным значением, а не ложью.

Как его вызывает аддон

Core.threat_count_conditions.GetConditionThreatCount

local snapshot,why=readField(platform,self,'unitsInRange')

Исходный код

Core/threat_count_conditions.lua, строка 33. В игре только для чтения; «Дублировать» создаёт редактируемую копию.

Core.threat_count_conditions.readField(platform, object, key)

    if not platform:CanReadValue(object) then return nil,'restricted-value' end
    if type(object)~='table' then return nil,'invalid-unit-snapshot' end
    local ok,value=pcall(function() return object[key] end)
    if not ok then return nil,'unit-snapshot-read-error' end
    if not platform:CanReadValue(value) then return nil,'restricted-value' end
    return value

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