Référence › Référence des fonctions › Functions

Functions.forecast.readField

dépendance

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

NomTypeCe qu'elle fait
platformRMPlatformPlatform whose CanReadValue decides readability.
objectanyTable to read, such as the history record or one of its rows.
keyanyKey to read, such as "damage" or "time".

Retours

1anyThe field's value (possibly nil), or nil on failure.
2string | nilReason 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

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

Retour à Référence des fonctions