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

Platform.runes.validIndex

dépendance

Appel

Platform.runes.validIndex(self, index)

Enregistrez la dépendance Platform.runes.validIndex, 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 rune slot index. Returns true for a readable integer from 1 through 6; otherwise nil with "restricted-value" or "invalid-rune-index".

Arguments

NomTypeCe qu'elle fait
selfRMPlatformRotation Master platform adapter (normally addon.Platform), used for its CanReadValue check.
indexanyRune slot index to validate.

Retours

1boolean | nilTrue when index is a valid rune slot; nil otherwise.
2string | nilReason 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/runes.lua, ligne 24. En lecture seule dans le jeu ; Dupliquer crée une copie modifiable.

Platform.runes.validIndex(self, index)
    if not self:CanReadValue(index) then return nil,'restricted-value' end
    if not finite(index) or index%1~=0 or index<1 or index>6 then return nil,'invalid-rune-index' end
    return true

Retour à Référence des fonctions