Référence › Référence des fonctions › Platform

Platform.actions.spellID

dépendance

Appel

Platform.actions.spellID(id)

Enregistrez la dépendance Platform.actions.spellID, puis appelez-la sous ce nom. Un appel par espace de noms ne transmet pas self : utilisez un appel avec deux-points ou passez l'objet vous-même.

Ce qu'elle fait

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).

Arguments

NomTypeCe qu'elle fait
idanyValue to validate as a spell ID.

Retours

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

Éditions

Les fonctions utilitaires intégrées sont enregistrées sur toutes les éditions. Ce qui diffère, c'est l'API du jeu qu'elles lisent ; quand l'une manque, la fonction utilitaire se rabat sur une alternative ou renvoie nil avec une raison.

Elle ne lit directement aucune API du jeu.

Valeurs secrètes (Retail et Forever)

Sur Retail et Forever, le jeu transmet aux addons des valeurs secrètes. Cette fonction utilitaire vérifie ce qu'elle lit (addon.Platform:CanReadValue) et renvoie nil avec une raison telle que restricted-value au lieu d'une valeur secrète qu'elle ne peut pas comparer. Traitez nil comme indisponible, pas comme false.

Comment l'addon l'appelle

Dépendances

Source

Platform/actions.lua, ligne 33. En lecture seule dans le jeu ; Dupliquer crée une copie modifiable.

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

Retour à Référence des fonctions