Riferimento › Riferimento delle funzioni › Platform

Platform.role.readField

dipendenza

Chiamala come

Platform.role.readField(self, object, key)

Registra la dipendenza Platform.role.readField, poi chiamala con quel nome. Una chiamata con spazio dei nomi non passa self: usa una chiamata con i due punti o passa tu l'oggetto.

Cosa fa

Reads object[key] in protected mode, used to look up optional APIs. Returns the value (possibly nil), or nil with "restricted-value" when the object or the value is secret, "invalid-api-result" when object is not a table, or "api-error" when indexing raises an error.

Argomenti

NomeTipoCosa fa
selfRMPlatformRotation Master platform adapter (normally addon.Platform), used for its CanReadValue check.
objecttableTable to index; any other type is rejected.
keyanyField name to read.

Valori restituiti

1anyThe field value, possibly nil; nil on failure.
2string | nilReason on failure; nil on success.

Edizioni

Le funzioni di supporto integrate sono registrate su ogni edizione. Ciò che cambia è l'API di gioco che leggono; dove ne manca una, la funzione di supporto ripiega su un'alternativa o restituisce nil con un motivo.

Non legge direttamente alcuna API di gioco.

Valori segreti (Retail e Forever)

Su Retail e Forever il gioco fornisce agli addon valori segreti. Questa funzione di supporto controlla ciò che legge (addon.Platform:CanReadValue) e restituisce nil con un motivo come restricted-value invece di un valore segreto che non può confrontare. Considera nil come non disponibile, non come false.

Come la chiama l'addon

Sorgente

Platform/role.lua, riga 19. Nel gioco è in sola lettura; Duplica crea una copia modificabile.

Platform.role.readField(self, object, key)
    if not self:CanReadValue(object) then return nil,'restricted-value' end
    if type(object)~='table' then return nil,'invalid-api-result' end
    local ok,value=pcall(function() return object[key] end)
    if not ok then return nil,'api-error' end
    if not self:CanReadValue(value) then return nil,'restricted-value' end
    return value

Torna a Riferimento delle funzioni