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

Functions.forecast.finite

dépendance

Appel

Functions.forecast.finite(platform, value)

Enregistrez la dépendance Functions.forecast.finite, 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

Checks that a number used by Functions.forecast.calculate is readable and finite.

Arguments

NomTypeCe qu'elle fait
platformRMPlatformPlatform whose CanReadValue decides readability.
valueanyValue to check.

Retours

1booleanTrue when the value is a readable finite number.
2string | nilWhen false: restricted-value or invalid-forecast-number.

É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 23. En lecture seule dans le jeu ; Dupliquer crée une copie modifiable.

Functions.forecast.finite(platform, value)
    if not platform:CanReadValue(value) then return false,'restricted-value' end
    if type(value)~='number' or value~=value or value>=math.huge or value<=-math.huge then return false,'invalid-forecast-number' end
    return true

Retour à Référence des fonctions