Platform.instance.GetInstanceObservation

Appel

addon.Platform:GetInstanceObservation()

Disponible directement via addon ; aucune dépendance n'est nécessaire.

Ce qu'elle fait

Observe un tuple protégé IsInInstance sans argument. L'appartenance booléenne lisible requise est indépendante du champ de type : hors instance, le résultat est renvoyé sans interpréter le type inutilisé ; en instance, il renvoie un type sous forme de chaîne lisible, ou un instanceTypeReason si ce champ secondaire est indisponible. Les appelants qui testent « hors instance » n'ont besoin que de l'appartenance ; les comparaisons de type en instance doivent vérifier le motif secondaire. Aucune déduction d'extérieur, de zone ou d'unité n'est ajoutée.

Arguments

Retours

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

• Indisponible sur cette édition (la raison figure dans l'infobulle)
• Uniquement tant que les solutions de repli de Blizzard pour les fonctions obsolètes sont actives

API du jeu	Classic Era	TBC Anniversary	Classic Progression	Forever	Retail
IsInInstance
canaccessvalue

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.

Exemple

local record = addon.Platform:GetInstanceObservation()
if not record then return nil end
if not record.inInstance then return false end
if not record.instanceType then return nil end
return record.instanceType == "raid"

Source

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

    local family=self:GetClientFamily()
    if family~='retail' and family~='forever' and family~='era' and family~='tbc' and family~='progression' then return nil,'unsupported-policy' end
    if type(IsInInstance)~='function' then return nil,'missing-api' end
    local ok,inInstance,instanceType=pcall(IsInInstance)
    if not ok then return nil,'api-error' end
    if not self:CanReadValue(inInstance) then return nil,'restricted-value' end
    if canaccessvalue and not canaccessvalue(inInstance) then return nil,'restricted-value' end
    if inInstance==nil then return nil,'instance-data-unavailable' end
    if type(inInstance)~='boolean' then return nil,'invalid-api-result' end
    if not inInstance then return {inInstance=false} end
    if not self:CanReadValue(instanceType) then return {inInstance=true,instanceTypeReason='restricted-value'} end
    if canaccessvalue and not canaccessvalue(instanceType) then return {inInstance=true,instanceTypeReason='restricted-value'} end
    if instanceType==nil then return {inInstance=true,instanceTypeReason='instance-type-unavailable'} end
    if type(instanceType)~='string' then return {inInstance=true,instanceTypeReason='invalid-api-result'} end
    return {inInstance=true,instanceType=instanceType}