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

Platform.items.identifier

dependência

Chame como

Platform.items.identifier(item)

Registre a dependência Platform.items.identifier 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 an item argument. Accepts a positive finite integer item ID or a nonempty string (an item name or link) of up to 1024 characters. Returns true, or nil with "restricted-value" for a secret value or "invalid-item" for anything else.

Argumentos

NomeTipoO que faz
itemanyItem ID, name or link to validate.

Retornos

1boolean | nilTrue when item is acceptable; nil otherwise.
2string | nilrestricted-value or invalid-item when rejected.

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/items.lua, linha 20. Somente leitura no jogo; Duplicar cria uma cópia editável.

Platform.items.identifier(item)
    if not platform:CanReadValue(item) then return nil,"restricted-value" end
    if type(item)=="number" and item>0 and item<math.huge and item%1==0 then return true end
    if type(item)=="string" and #item>0 and #item<=1024 then return true end
    return nil,"invalid-item"

Voltar para Referência de funções