Referência › Referência de funções › Functions

Functions.forecast.finite

dependência

Chame como

Functions.forecast.finite(platform, value)

Registre a dependência Functions.forecast.finite e depois chame-a por esse nome. Uma chamada com namespace não passa self: use uma chamada com dois-pontos ou passe o objeto você mesmo.

O que faz

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

Argumentos

NomeTipoO que faz
platformRMPlatformPlatform whose CanReadValue decides readability.
valueanyValue to check.

Retornos

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

Edições

As funções auxiliares integradas são registradas em todas as edições. O que muda é a API do jogo que elas leem; quando uma está ausente, a função auxiliar recorre a uma alternativa ou retorna nil com um motivo.

Não lê nenhuma API do jogo diretamente.

Valores secretos (Retail e Forever)

No Retail e no Forever, o jogo entrega valores secretos aos addons. Esta função auxiliar verifica o que lê (addon.Platform:CanReadValue) e retorna nil com um motivo como restricted-value em vez de um valor secreto que não consegue comparar. Trate nil como indisponível, não como false.

Como o addon a chama

Código-fonte

Functions/forecast.lua, linha 23. Somente leitura no jogo; Duplicar cria uma cópia editável.

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

Voltar para Referência de funções