Platform.role.readField

Как вызывать

Platform.role.readField(self, object, key)

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

Что делает

Reads object[key] in protected mode, used to look up optional APIs. Returns the value (possibly nil), or nil with "restricted-value" when the object or the value is secret, "invalid-api-result" when object is not a table, or "api-error" when indexing raises an error.

Аргументы

Имя	Тип	Что делает
`self`	`RMPlatform`	Rotation Master platform adapter (normally addon.Platform), used for its CanReadValue check.
`object`	`table`	Table to index; any other type is rejected.
`key`	`any`	Field name to read.

Возвращает

1	`any`	The field value, possibly nil; nil on failure.
2	`string \| nil`	Reason on failure; nil on success.

Издания

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

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

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

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

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

Platform.role.GetInspectRoleObservation

local namespace,reason=readField(self,_G,'C_SpecializationInfo')

Platform.role.GetTalentGroupRoleObservation

local query,reason=readField(self,_G,'GetTalentGroupRole')

Исходный код

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

Platform.role.readField(self, object, key)

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

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