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

Platform.role.roleValue

dependência

Chame como

Platform.role.roleValue(self, value)

Registre a dependência Platform.role.roleValue 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

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

NomeTipoO que faz
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.

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.

  • Indisponível nessa edição (o motivo está na dica)
  • Só enquanto as alternativas da Blizzard para APIs obsoletas estiverem ativas
API do jogoClassic EraTBC AnniversaryClassic ProgressionForeverRetail
canaccessvalueClassic EraTBC AnniversaryClassic ProgressionForeverRetail

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

Platform/role.lua, linha 35. Somente leitura no jogo; Duplicar cria uma cópia editável.

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

Voltar para Referência de funções