Referencia › Referencia de funciones › Functions

Functions.forecast.finite

dependencia

Llamar como

Functions.forecast.finite(platform, value)

Registra la dependencia Functions.forecast.finite y luego llámala con ese nombre. Una llamada con espacio de nombres no pasa self: usa una llamada con dos puntos o pasa tú mismo el objeto.

Qué hace

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

Argumentos

NombreTipoQué hace
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.

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 recurre a 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 entrega a los addons valores secretos. Esta función auxiliar comprueba 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

Código fuente

Functions/forecast.lua, línea 23. Solo lectura en el juego; Duplicar crea una copia editable.

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

Volver a Referencia de funciones