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

Platform.actions.spellID

dependência

Chame como

Platform.actions.spellID(id)

Registre a dependência Platform.actions.spellID 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 spell ID argument. Returns true for a readable positive finite integer; otherwise nil with "restricted-value" for a secret value or "invalid-spell" for anything else (including spell names).

Argumentos

NomeTipoO que faz
idanyValue to validate as a spell ID.

Retornos

1boolean | nilTrue when id is a valid spell ID; nil otherwise.
2string | nilrestricted-value or invalid-spell when invalid.

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

Dependências

Código-fonte

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

Platform.actions.spellID(id)
    if not platform:CanReadValue(id) then return nil,"restricted-value" end
    if type(id)~="number" or id<1 or id==math.huge or id%1~=0 then return nil,"invalid-spell" end
    return true

Voltar para Referência de funções