Appel
Functions.forecast.readField(platform, object, key)
Enregistrez la dépendance Functions.forecast.readField, puis appelez-la sous ce nom. Un appel par espace de noms ne transmet pas self : utilisez un appel avec deux-points ou passez l'objet vous-même.
Ce qu'elle fait
Reads object[key] for Functions.forecast.calculate without letting a restricted value, a non-table object or an index error escape.
Arguments
| Nom | Type | Ce qu'elle fait |
|---|---|---|
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". |
Retours
| 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. |
Éditions
Les fonctions utilitaires intégrées sont enregistrées sur toutes les éditions. Ce qui diffère, c'est l'API du jeu qu'elles lisent ; quand l'une manque, la fonction utilitaire se rabat sur une alternative ou renvoie nil avec une raison.
Elle ne lit directement aucune API du jeu.
Valeurs secrètes (Retail et Forever)
Sur Retail et Forever, le jeu transmet aux addons des valeurs secrètes. Cette fonction utilitaire vérifie ce qu'elle lit (addon.Platform:CanReadValue) et renvoie nil avec une raison telle que restricted-value au lieu d'une valeur secrète qu'elle ne peut pas comparer. Traitez nil comme indisponible, pas comme false.
Comment l'addon l'appelle
Functions.forecast.calculatelocal rows,why=readField(platform,history,name)
Source
Functions/forecast.lua, ligne 38. En lecture seule dans le jeu ; Dupliquer crée une copie modifiable.
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