Llamar como
Functions.forecast.readField(platform, object, key)
Registra la dependencia Functions.forecast.readField y después llámala con ese nombre. Una llamada con espacio de nombres no pasa self: usa una llamada con dos puntos o pasa el objeto tú mismo.
Qué hace
Reads object[key] for Functions.forecast.calculate without letting a restricted value, a non-table object or an index error escape.
Argumentos
| Nombre | Tipo | Qué hace |
|---|---|---|
platform | RMPlatform | Platform whose CanReadValue decides readability. |
object | any | Table to read, such as the history record or one of its rows. |
key | any | Key to read, such as "damage" or "time". |
Retornos
| 1 | any | The field's value (possibly nil), or nil on failure. |
|---|---|---|
| 2 | string | nil | Reason on failure: restricted-value, invalid-forecast-history or forecast-history-error. |
Ediciones
Las funciones auxiliares integradas se registran en todas las ediciones. Lo que cambia es la API del juego que leen; donde falta alguna, la función auxiliar usa una alternativa o devuelve nil con un motivo.
No lee directamente ninguna API del juego.
Valores secretos (Retail y Forever)
En Retail y Forever, el juego les entrega a los addons valores secretos. Esta función auxiliar verifica lo que lee (addon.Platform:CanReadValue) y, en lugar de un secreto que no puede comparar, devuelve nil con un motivo como restricted-value. Trata nil como no disponible, no como falso.
Cómo la llama el addon
Functions.forecast.calculatelocal rows,why=readField(platform,history,name)
Código fuente
Functions/forecast.lua, línea 38. Solo lectura en el juego; Duplicar crea una copia editable.
Functions.forecast.readField(platform, object, key)
if not platform:CanReadValue(object) then return nil,'restricted-value' end
if type(object)~='table' then return nil,'invalid-forecast-history' end
local ok,value=pcall(function() return object[key] end)
if not ok then return nil,'forecast-history-error' end
if not platform:CanReadValue(value) then return nil,'restricted-value' end
return value