Referencia › Referencia de funciones › Platform

Platform.role.roleValue

dependencia

Llamar como

Platform.role.roleValue(self, value)

Registra la dependencia Platform.role.roleValue 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

Validates a role returned by a native API. Returns the value when it is a readable nonempty string (such as TANK, HEALER or DAMAGER); otherwise nil with "restricted-value", "role-unavailable" (nil) or "invalid-api-result".

Argumentos

NombreTipoQué hace
selfRMPlatformRotation Master platform adapter (normally addon.Platform), used for its CanReadValue check.
valueanyRole value returned by the native API.

Retornos

1string | nilThe role string, or nil when unavailable.
2string | nilReason when the role is nil.

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 disponible en esa edición (el motivo aparece en la información emergente)
  • Solo mientras estén activas las alternativas de Blizzard para API obsoletas
API del juegoClassic EraTBC AnniversaryClassic ProgressionForeverRetail
canaccessvalueClassic EraTBC AnniversaryClassic ProgressionForeverRetail

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

Platform/role.lua, línea 35. Solo lectura en el juego; Duplicar crea una copia editable.

Platform.role.roleValue(self, value)
    if not self:CanReadValue(value) then return nil,'restricted-value' end
    if canaccessvalue and not canaccessvalue(value) then return nil,'restricted-value' end
    if value==nil then return nil,'role-unavailable' end
    if type(value)~='string' or value=='' then return nil,'invalid-api-result' end
    return value

Volver a Referencia de funciones