The handle refers to the instance weakly and doesn't extend its lifetime.

```lua
local target = Instance.new("Part")
target.Name = "TargetPart"

local handle = InstanceHandle.new(target)
local empty = InstanceHandle.new(nil)

print(handle:Get()) --> TargetPart
print(empty:Get()) --> nil
```

Throws if `instance` is neither an `Class.Instance` nor `nil`.


InstanceHandle.new

instance

The instance to refer to, or `nil` for an empty handle.


Returns a new `Datatype.InstanceHandle` referring to the given
`Class.Instance`.


The `Datatype.InstanceHandle` data type is a weak reference to an
`Class.Instance` that might not be available locally. Use it to point at an
instance that hasn't arrived yet, could stream out, or exists only on another
machine, and to pick that instance up once it's there.

A handle always refers to the same target. To reach that target, call
`Datatype.InstanceHandle:Wait()`, which yields until the instance is
available:

```lua
local Workspace = game:GetService("Workspace")

local part = Instance.new("Part")
local target = Instance.new("Part")
target.Name = "TargetPart"
part.Parent = Workspace
target.Parent = Workspace

part:SetAttribute("Target", target)

local handle = part:GetAttribute("Target")
local instance = handle:Wait(10)
if instance then
	print("Target is", instance.Name) --> Target is TargetPart
end
```

Prefer `Datatype.InstanceHandle:Wait()` with a timeout so your code runs as
soon as the instance shows up. Use `Datatype.InstanceHandle:Get()` when you
want an immediate answer and can handle `nil`, such as in code that runs every
frame.

#### Examples

##### Attributes

Attributes use `Datatype.InstanceHandle` instead of an ordinary instance
reference. Since the handle itself is never `nil`, you can tell apart an
attribute that is missing from one where the instance is not currently
present:

```lua
local part = Instance.new("Part")

print(part:GetAttribute("Target")) --> nil

part:SetAttribute("Target", InstanceHandle.new(nil))
local handle = part:GetAttribute("Target")
print(handle:Get()) --> nil
```

`Datatype.InstanceHandle` attributes also appear in
`Class.Instance:GetAttributes()`, which can't hold `nil` values.

`Class.Instance:GetAttributeChangedSignal()` fires when the attribute is set
to a new target or removed. It does not fire when the target streams in or
out, or when the target is destroyed. To react to availability, combine the
signal with `Datatype.InstanceHandle:Wait()`:

```lua
local part = Instance.new("Part")

part:GetAttributeChangedSignal("Target"):Connect(function()
	local handle = part:GetAttribute("Target")
	if not handle then
		return
	end

	local instance = handle:Wait(10)
	if instance then
		print("New target:", instance.Name)
	end
end)
```

##### Remote events

Pass a handle through a `Class.RemoteEvent` to give the receiver a reference
to an instance it doesn't have yet. The receiver waits for the instance
instead of getting nothing.

In a server script, call this function with your remote event, the receiving
player, and the model to send:

```lua
local function sendHandle(remoteEvent: RemoteEvent, player: Player, spawnedModel: Model)
	local handle = InstanceHandle.new(spawnedModel)
	remoteEvent:FireClient(player, handle)
end
```

In a client script, call this function with the same remote event to start
listening before the server sends the handle:

```lua
local function receiveHandles(remoteEvent: RemoteEvent)
	remoteEvent.OnClientEvent:Connect(function(handle)
		local model = handle:Wait(10)
		if model then
			print("Received", model.Name)
		end
	end)
end
```

#### Ownership

A handle acts as a weak reference. It never keeps its target alive. The
lifetime of the target is controlled by the rest of your experience: its
parent and any ordinary references your scripts hold that prevent it from
being garbage collected.

`Datatype.InstanceHandle:Get()` and `Datatype.InstanceHandle:Wait()` return an
ordinary instance reference, which does keep the instance alive for as long as
you hold it.

A handle is otherwise lightweight and needs no cleanup.

#### Equality

Two handles are equal when they refer to the same target, even if you created
them separately and even after the target is gone. All empty handles are equal
to each other. Each handle is still a distinct value.

```lua
local instance1 = Instance.new("Part")
local instance2 = Instance.new("Part")

local a = InstanceHandle.new(instance1)
local b = InstanceHandle.new(instance1)
local c = InstanceHandle.new(instance2)

print(a == b) --> true
print(a == c) --> false
```

Equality depends on target identity, so it still works when the target isn't
currently available.


This method doesn't yield.

`Get()` returns `nil` when the handle is empty, when the target hasn't
arrived on the client or server running the script, when the target is no
longer available after streaming out, when the target has been garbage
collected, and when the target isn't accessible to the calling script. Use
`Datatype.InstanceHandle:Wait()` to yield until the target arrives instead
of checking once.


InstanceHandle:Get

The referenced instance, or `nil` if it isn't available locally.


Returns the referenced `Class.Instance` if it's available locally,
otherwise `nil`.


Returns `nil` if the handle is empty, the target is inaccessible to the
calling script, or `timeout` elapses first. `Wait()` returns immediately
when the target is already available and when the handle is empty.

Pass a timeout whenever you can't guarantee that the target reaches the
caller. A target that's destroyed before it replicates leaves a handle
that never resolves, and a `Wait()` with no timeout never returns. A
pending wait can't be cancelled: `Library.task.cancel()` stops your
coroutine, but the wait isn't unregistered until the target arrives or the
timeout elapses.

`timeout` must be a number greater than zero. Throws if `timeout` is zero,
negative, or not a number.


InstanceHandle:Wait

timeout

How long to wait, in seconds. Must be greater than zero. Waits
indefinitely when omitted.


The referenced instance, or `nil` if the handle is empty, the target
is inaccessible to the calling script, or `timeout` elapses first.


Yields until the referenced `Class.Instance` is available locally, then
returns it.


InstanceHandle

A lightweight, weak reference to an `Class.Instance` that might not be
available locally.


/reference/engine/datatypes/InstanceHandle.yaml

Data Type

Instance

Un oggetto che esegue funzioni connesse al verificarsi di un evento specifico.

RBXScriptSignal

Un numero a virgola mobile a doppia precisione.

Luau

number

Esperienze

Avatar

Risorse

Campioni e progetti

API Motore

Cloud API aperto

Studio

Analisi

Piattaforma

Tutorial

Programmi per creatori

Istruzione

Corsi

Impara

Questo metodo è asincrono e restituisce un'"operazione", che rappresenta lo stato corrente della stessa. Contiene un percorso endpoint che è possibile sondare per ottenere la risposta reale e i metadati applicabili. Per ulteriori informazioni, consulta la [documentazione]({longRunningOperationsLink}) sulle operazioni di lunga durata.
            
Le sezioni seguenti descrivono gli oggetti di risposta e metadati forniti al completamento di un'operazione.

Gli endpoint beta sono pronti per l'uso del pubblico. Modifiche incompatibili sono possibili ma rare.

Queste pagine di documentazione di Open Cloud verranno rimosse il 31 marzo 2026. Verrai reindirizzato automaticamente alla nuova documentazione di Open Cloud in quel momento. {linkStart}Scopri di più{linkEnd}

Queste vecchie pagine di Open Cloud verranno rimosse e reindirizzate il 31 marzo 2026. {linkStart}Scopri di più{linkEnd}

Gli endpoint sperimentali sono pronti per l'uso pubblico, ma potrebbero subire modifiche incompatibili durante il processo di finalizzazione del contratto API.

Questo endpoint può essere chiamato in-experience tramite {httpServiceLinkStart}HttpService{httpServiceLinkEnd} con una chiave API.

Questo campo può essere impostato durante la creazione di una risorsa, ma non può essere modificato da richieste successive.

È possibile impostare questi campi durante la creazione di una risorsa, ma non modificarli in base a richieste successive.

Questo campo può essere fornito per le richieste, ma non verrà mai incluso nelle risposte.

Metodo di autenticazione legacy. Preferisci sempre l'utilizzo della chiave dell'API o OAuth 2.0 quando disponibile.

Per chiave API: {maxInPeriod} richieste ogni {periodInSeconds} secondi per indirizzo IP

Non richiede un'autenticazione. In genere ha limiti di velocità notevolmente ridotti. Se disponibile, è sempre meglio l'utilizzo della chiave dell'API o OAuth 2.0.

Per ogni raggruppamento, devi inserire solo uno dei campi seguenti nello schema. Gli altri possono essere ignorati.

Puoi riattivarle in qualsiasi momento. {linkStart}Lascia un feedback{linkEnd}.

Stai visualizzando i vecchi documenti. {linkStart}Lascia un feedback{linkEnd}.

Puoi disattivarle in qualsiasi momento e tornare alle vecchie pagine di riferimento. {linkStart}Lascia un feedback.{linkEnd}

Stai visualizzando i documenti rinnovati. {linkStart}Lascia un feedback{linkEnd}.

Questo campo può essere impostato per le risposte, ma verrà ignorato nelle richieste.

Nota: i limiti di velocità possono essere inferiori durante i periodi di traffico elevato. Alcuni endpoint ne hanno di aggiuntivi. [Scopri di più sui limiti di velocità]({link}).

{limit} richieste al giorno su tutte le chiavi dell'API per un utente o un gruppo

{limit} richieste all'ora su tutte le chiavi dell'API per un utente o un gruppo

{limit} richieste al minuto su tutte le chiavi dell'API per un utente o un gruppo

{limit} richieste al secondo su tutte le chiavi dell'API per un utente o un gruppo

{limit} richieste al minuto per proprietario della chiave dell'API

{limit} richieste al giorno per utente dell'app

{limit} richieste all'ora per utente dell'app

{limit} richieste al minuto per utente dell'app

{limit} richieste al secondo per utente dell'app

{limit} richiesta/e al secondo per proprietario della chiave dell'API

Gli obiettivi controllano le autorizzazioni delle tue credenziali. Le tue credenziali possono accedere solo agli endpoint supportati dagli obiettivi selezionati.

Gli endpoint stabili sono pronti per la produzione e raramente subiscono modifiche significative nel corso del loro ciclo di vita.

Questo obiettivo consente di limitare l'accesso della chiave a {requiredParts}

Questo obiettivo consente di limitare l'accesso della chiave a {requiredParts} e {optionalParts}

I tipi di destinazione servono a limitare le risorse su cui le tue credenziali hanno permesso di agire. Solo le risorse selezionate possono essere utilizzate, anche se l'account ha permessi su risorse aggiuntive. Alcuni ambiti non includono parti di destinazione. In questi casi, tutte le risorse pertinenti possono essere utilizzate.

La parte di primo livello dell'universo non dovrebbe essere selezionata per le chiavi dell'API di proprietà dell'utente. In questo modo, la tua chiave dell'API potrà accedere a tutte le esperienze di proprietà dell'utente e del gruppo, a condizione che tu disponga dei permessi corretti per il gruppo.

Provalo non è ancora supportato per gli endpoint che richiedono la chiave dell'API o l'autenticazione OAuth 2.0

L'autenticazione dei cookie è disabilitata per le operazioni ad alto rischio per la sicurezza.

Gli endpoint critici sono altamente sensibili e Provalo è stato disabilitato per ragioni di sicurezza

Nota: le intestazioni di autenticazione non sono incluse in questo esempio di codice. Potrebbe essere necessario aggiungerne una affinché questo comando funzioni.

Questo è un endpoint ad alto rischio che potrebbe causare la modifica o la cancellazione di dati critici. Utilizza estrema cautela in fase di test.

Questo endpoint API è stato classificato come AD ALTO RISCHIO e può influire sui dati in tempo reale o sugli account utente.

Le richieste autenticate alle API ad alto rischio possono apportare modifiche irreversibili. Controlla attentamente i parametri della richiesta prima di procedere.

Effettua il login per utilizzare l'autenticazione tramite cookie

Questo è un endpoint a basso rischio per il recupero dati. Generalmente è sicuro in fase di test.

Questo è un endpoint a rischio medio per la modifica dei dati. Esegui il test con attenzione servendoti di account non critici, poiché le modifiche potrebbero essere permanenti.

Per proteggere il tuo account, non incollare mai qui il testo da altre fonti e non inviare informazioni da questa pagina ad altri.

Stai per testare gli endpoint API live utilizzando le credenziali del tuo account reale.

Procedi solo se comprendi le implicazioni delle chiamate API che stai per effettuare. Esamina attentamente la documentazione dell'API prima di eseguire il test.

Le chiamate API verranno effettuate utilizzando la tua sessione autenticata

Si tratta di chiamate API reali che potrebbero influire sul tuo account o sui tuoi dati

Si applicano limiti di velocità e altre restrizioni API

Alcune operazioni possono modificare o eliminare i dati

Questo endpoint è stato sostituito dai seguenti endpoint alternativi consigliati:

I seguenti ambiti sono necessari per chiamare questo endpoint. Per ulteriori informazioni sulla generazione di chiavi appropriate, consulta l'articolo [Gestire le chiavi API]({apiKeyReferenceDocLink}).

Per ulteriori informazioni sulla generazione di chiavi, consulta l'articolo [Gestire le chiavi API]({apiKeyReferenceDocLink}).

I seguenti endpoint sono disponibili nei percorsi relativi all'URL di base.

Questa stringa è formattata come [Timestamp](/cloud/reference/types#timestamp).

Un valore JSON può essere `null`, `boolean`, `string`, `number`, `array`, or `object`.

I seguenti ambiti sono necessari per l'applicazione OAuth 2.0 per utilizzare questo endpoint. Per ulteriori informazioni su come registrare un'applicazione OAuth 2.0, vedi [Registrazione e revisione dell'app]({oauth2ReferenceDocLink}).

Per ulteriori informazioni su come registrare un'applicazione OAuth 2.0, consulta l'articolo dedicato alla [registrazione e alla revisione dell'app]({oauth2ReferenceDocLink}).

Gli oggetti seguenti descrivono i payloads accettati o restituiti. Per maggiori informazioni su quando vengono utilizzati questi oggetti, consultare ogni singolo endpoint.

Per chiamare questo endpoint sono richiesti i seguenti ambiti.

Percorsi risorse

Per utilizzare questo endpoint sono necessari i seguenti ambiti per la tua applicazione OAuth 2.0. Per ulteriori informazioni su come registrare un'applicazione OAuth 2.0, vedere [Registrazione e revisione dell'app]({oauth2ReferenceDocLink}).

Non consigliato

Stai visualizzando la nuova versione del riferimento Open Cloud.

Hai disattivato il nuovo riferimento Open Cloud.

Visualizza i tuoi account di fatturazione pubblicitaria.

Visualizza le tue campagne pubblicitarie e le loro prestazioni.

Crea, aggiorna e gestisci le tue campagne pubblicitarie.

Questo permette di visualizzare informazioni sui tuoi beni.

Questo permette di caricare e aggiornare gli asset su Roblox.

Consente di visualizzare permessi per le risorse ai soggetti (inclusi gruppi ed esperienze) o risorsa a cui il tuo account ha accesso.

Consente di concedere permessi per le risorse a qualsiasi soggetto (inclusi gruppi ed esperienze) o risorsa a cui il tuo account ha accesso.

Consente di visualizzare lo stato e i risultati delle attività di configurazione automatica dell'avatar per tuo conto.

Consente di creare e gestire attività di configurazione automatica dell'avatar per tuo conto.

Fornisce la possibilità di aggiornare i badge di proprietà dell'utente.

Consente di visualizzare informazioni sui tuoi articoli commerciali.

Consente di apportare modifiche ai tuoi articoli commerciali sincronizzati.

Ciò permette di visualizzare le informazioni sulle tue connessioni commerciali.

Consente la modifica delle tue connessioni commerciali.

Consente di visualizzare le informazioni sui tuoi prodotti del Creator Store.

Consente di modificare le informazioni sui tuoi prodotti del Creator Store.

Consente di visualizzare le informazioni sui tuoi prodotti del Negozio creatore.

Consente di modificare le informazioni sui tuoi salvataggi del Negozio creatore.

Consente l'accesso per creare data store per tuo conto.

Consente l'accesso per eliminare data store per tuo conto.

Consente l'accesso per leggere un elenco di data store.

Consente l'accesso per acquisire un'istantanea dei tuoi data store.

Consente l'accesso per creare voci nei tuoi data store.

Consente l'accesso per contrassegnare specifiche voci ed eliminarle.

Consente l'accesso all'elenco delle voci del tuo data store.

Consente l'accesso per leggere specifiche voci nei tuoi data store.

Consente l'accesso per aggiornare il valore, gli attributi e gli utenti di una voce.

Consente l'accesso per eliminare le revisioni delle voci del tuo data store.

Consente l'accesso alle revisioni dell'elenco delle voci del tuo data store.

Fornisce l'accesso per visualizzare i dettagli di configurazione dei developer product dell'utente autorizzato.

Fornisce l'accesso per modificare i developer product dell'utente autorizzato.

Questo permette di visualizzare informazioni sugli ambienti del tuo universo.

Questo permette di modificare gli ambienti del tuo universo.

Fornisce l'accesso per visualizzare i dettagli di configurazione dei pass di gioco dell'utente autorizzato.

Offre l'accesso per modificare i pass di gioco dell'utente autorizzato.

Offre l'accesso per visualizzare le informazioni sul forum della community per il tuo account.

Offre l'accesso per gestire le informazioni sul forum della community per il tuo account.

Consente di vedere le informazioni sulle tue community.

Consente di gestire le richieste di adesione alla community e gli aggiornamenti dei ruoli dei membri della community di rango inferiore per il tuo account.

Consente di visualizzare i dati delle proprietà di un'istanza.

Consente di modificare i dati delle proprietà delle istanze (attualmente supporta solo script).

Consente l'accesso per gestire le risorse dell'utente.

Offre l'accesso per gestire i tuoi badge.

Offre l'accesso per gestire i tuoi badge e spendere Robux.

Offre l'accesso per aggiornare i badge dell'utente autorizzato.

Consente l'accesso per gestire i tuoi prodotti per sviluppatori.

Consente l'accesso per leggere le informazioni sulle esperienze per le quali hai ricevuto notifiche.

Consente l'accesso per attivare o disattivare le notifiche sulle esperienze per tuo conto.

Consente l'accesso per gestire le tue community.

Fornisce il permesso di leggere le informazioni sulla community.

Concede le autorizzazioni di gestione della community.

Consente l'accesso per leggere e scrivere le tue tabelle di localizzazione

Consente l'accesso per gestire la collaborazione in team per tutte le tue esperienze.

Consente l'accesso per gestire le tue esperienze e determinate informazioni associate alle tue esperienze (ad esempio, informazioni sulla localizzazione).

Offre l'accesso per leggere le informazioni sulla localizzazione delle tue esperienze.

Consente l'accesso per modificare le preferenze di localizzazione delle tue esperienze.

Consente l'accesso per gestire il tuo account utente.

Consente l'accesso per modificare le preferenze di localizzazione dell'utente.

Consente di visualizzare lo stato, i registri e i risultati delle attività di esecuzione Luau per il luogo associato.

Consente di creare nuove attività di esecuzione Luau per il luogo associato.

Concede l'accesso per svuotare in modo asincrono tutte le strutture dati nell'universo.

Consente l'accesso per creare nuovi elementi della coda.

Consente l'accesso per scartare gli elementi letti davanti alla coda.

Consente l'accesso agli elementi letti davanti alla coda.

Consente l'accesso per leggere gli elementi del tuo memory store.

Consente l'accesso per leggere gli elementi della mappa.

Consente l'accesso per creare, aggiornare ed eliminare elementi della mappa.

Ciò garantisce la possibilità di pubblicare messaggi per conto degli utenti.

Consente di inviare notifiche dalla tua esperienza agli utenti.

(Obsoleto) Consente l'accesso per leggere un elenco di voci in un data store ordinato.

(Obsoleto) Consente l'accesso per creare una nuova voce in un data store ordinato.

Consente l'accesso alle voci di elenco da un data store ordinato.

Consente l'accesso per creare voci in un data store ordinato.

Questo permette di elencare i segreti associati alla tua esperienza.

Ciò consente di creare e aggiornare i segreti associati alla tua esperienza.

Questa autorizzazione consente di inviare un lavoro di valutazione e visualizzarne il risultato.

Consente l'accesso per leggere i tuoi prodotti in abbonamento.

Consente di leggere le informazioni sulle miniature per tuo conto.

Offre la possibilità di leggere gli avvisi delle analitiche.

Offre la possibilità di creare o modificare gli avvisi delle analitiche.

Offre la possibilità di leggere le analitiche del gioco.

Offre la possibilità di scrivere risorse relative alle analitiche del gioco.

Offre la possibilità di leggere le informazioni sul posto.

Offre la possibilità di modificare le informazioni sul posto.

Permette di pubblicare nuove versioni di esperienze su Roblox.

Ciò ti consente di leggere le miniature e le impostazioni di personalizzazione delle miniature per le tue esperienze.

Ciò ti consente di caricare ed eliminare le miniature e gestire le impostazioni di personalizzazione delle miniature per le tue esperienze.

Offre la possibilità di leggere le informazioni sull'esperienza.

Offre l'accesso per modificare le esperienze dell'utente autorizzato.

Consente di visualizzare le restrizioni degli utenti nell'esperienza.

Ciò consente di visualizzare le notifiche inviate al tuo account.

Offre la possibilità di leggere lo stato premium e verificato dell'utente autorizzato.

Consente di visualizzare gli account social dell'utente autorizzato.

Offre la possibilità di leggere gli eventi di un gioco.

Offre la possibilità di modificare gli eventi del gioco

Questa operazione abilita la funzionalità Single Sign-On.

Consente l'accesso alla lettura delle informazioni del tuo profilo.