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

Contient le constructeur pour les Instances.

Data Type

Instance

Un objet qui exécute des fonctions connectées lors d'une occurrence spécifique.

RBXScriptSignal

Un nombre à virgule flottante double précision.

Luau

number

Expériences

Avatar

Contenus

Exemples et projets

API du moteur

Ouvrir Cloud API

Studio

Analyses

Plateforme

Tutoriels

Programmes Créateurs

Éducation

Cours

Apprendre

Cette méthode est asynchrone et retourne une `Operation`, qui représente l'état courant de l'opération. Il contient un chemin de terminaison que vous pouvez interroger pour obtenir la vraie réponse et les métadonnées applicables. Voir la [documentation]({longRunningOperationsLink}) sur les opérations à long terme pour plus d’informations.
            
Les sections suivantes décrivent la réponse et les objets de métadonnées qui sont fournis lorsqu'une opération se termine.

Les points de terminaison bêta sont prêts à être utilisés publiquement. Des modifications sont possibles mais rares.

Ces pages de documentation Open Cloud seront supprimées le 31 mars 2026. À compte de cette date, vous serez automatiquement redirigé vers la nouvelle documentation Open Cloud. {linkStart}En savoir plus{linkEnd}

Ces anciennes pages Open Cloud seront supprimées et redirigées le 31 mars 2026. {linkStart}En savoir plus{linkEnd}

Les points de terminaison expérimentaux sont accessibles au public, mais peuvent parfois faire l'objet de modifications majeures lors de la finalisation du contrat de l'API.

Ce point de terminaison peut être appelé au sein de l'expérience via {httpServiceLinkStart}HttpService{httpServiceLinkEnd} avec une clé API.

Ce champ peut être défini lors de la création d'une ressource, mais ne peut pas être modifié par des requêtes ultérieures.

Ces champs peuvent être définis lors de la création d'une ressource, mais ne peuvent pas être modifiés par des requêtes ultérieures.

Ce champ peut être fourni dans les demandes, mais ne sera jamais inclus dans les réponses.

Méthode d'authentification obsolète. Privilégiez l'utilisation d'une clé API ou d'OAuth 2.0 lorsque cela est possible.

Par clé API : {maxInPeriod} demande toutes les {periodInSeconds} secondes par adresse IP

Ne requiert pas d'authentification pour l'appel. Présente généralement des limites de débit bien plus faibles. Il est toujours préférable d'utiliser une clé API ou OAuth 2.0 lorsque cela est possible.

Pour chaque regroupement, un seul des champs suivants du schéma doit être fourni. Les autres peuvent être exclus.

Vous pouvez réactiver cette fonctionnalité à tout moment. {linkStart}Faites-nous part de vos commentaires.{linkEnd}

Vous consultez l'ancienne documentation. {linkStart}Faites-nous part de vos commentaires.{linkEnd}

Vous pouvez désactiver cette fonctionnalité à tout moment et revenir aux anciennes pages de référence. {linkStart}Rédiger un commentaire{linkEnd}.

Vous consultez la documentation remaniée. {linkStart}Faites-nous part de vos commentaires.{linkEnd}

Ce champ peut être défini sur les réponses, mais sera ignoré dans les demandes.

Remarque : les limites de débit peuvent être plus basses pendant les périodes de fort trafic. Certains points d'extrémité ont des limites de débit supplémentaires. [En savoir plus sur les limites de taux]({link}).

{limit} requêtes par jour sur toutes les clés API d'un utilisateur ou d'un groupe

{limit} requêtes par heure pour toutes les clés API pour un utilisateur ou un groupe

{limit} requêtes par minute pour toutes les clés API pour un utilisateur ou un groupe

{limit} requêtes par seconde pour toutes les clés API pour un utilisateur ou un groupe

{limit} requêtes par minutes par propriétaire de clé API

{limit} requêtes par jour par utilisateur de l'application

{limit} requêtes par heure par utilisateur de l'application

{limit} requêtes par minute par utilisateur de l'application

{limit} requêtes par seconde par utilisateur de l'application

{limit} requête.s par seconde par propriétaire de clé API

Les périmètres d'application définissent les autorisations de vos identifiants. Ceux-ci ne peuvent accéder qu'aux points de terminaison correspondant aux périmètres d'application sélectionnés.

Les points de terminaison stables sont prêts pour la production et ne connaîtront pratiquement jamais de modifications importantes au cours de leur existence.

Cette cible vous permet de limiter l'accès de votre clé aux {requiredParts}sélectionnées

Cette cible vous permet de limiter l'accès de votre clé aux {requiredParts} et {optionalParts} sélectionnées.

Les types de cibles permettent de restreindre les ressources sur lesquelles vos identifiants disposent de droits. Seules les ressources sélectionnées seront accessibles, même si votre compte possède des permissions sur d'autres ressources. Certains périmètres d'application ne comportent pas de cibles ; dans ce cas, toutes vos ressources concernées restent accessibles.

La partie de niveau supérieur de l'univers n'a pas à être sélectionnée pour les clés API dont vous disposez. Ainsi, votre clé API pourra accéder à toutes vos expériences personnelles ainsi qu'à celles des groupes pour lesquels vous avez les droits requis.

La fonctionnalité Essayer n'est pas encore prise en charge pour les points de terminaison nécessitant une clé API ou une authentification OAuth 2.0

L'authentification par cookie est désactivée pour les actions à haut risque afin de garantir la sécurité.

Les points de terminaison à risque critique sont extrêmement sensibles et la fonctionnalité Essayer est désactivée pour des raisons de sécurité

Remarque : les en-têtes d'authentification ne figurent pas dans cet exemple de code. Il se peut que vous deviez en ajouter un pour que la commande fonctionne.

Il s'agit d'un point de terminaison à haut risque qui peut modifier ou supprimer des données essentielles. Faites preuve de la plus grande vigilance lors des tests.

Ce point de terminaison API est classé À HAUT RISQUE et peut affecter les données en ligne ou les comptes d'utilisateurs.

Les demandes authentifiées aux API à haut risque peuvent provoquer des modifications irréversibles. Vérifiez soigneusement les paramètres de votre demande avant de continuer.

Connectez-vous pour utiliser l'authentification par cookie

Il s'agit d'un point de terminaison à faible risque qui récupère les données. Il est généralement sûr à tester.

Il s'agit d'un point de terminaison à risque moyen qui modifie les données. Testez-le soigneusement avec des comptes non essentiels, car les changements peuvent être irréversibles.

Pour sécuriser votre compte, ne collez jamais ici de texte provenant d'autres sources et ne divulguez pas les informations de cette page.

Vous vous apprêtez à tester en direct des points de terminaison d'API avec les vrais identifiants de votre compte.

Ne continuez que si vous comprenez bien les conséquences des appels d'API que vous vous apprêtez à réaliser. Consultez attentivement la documentation avant toute expérimentation.

Les appels d'API utiliseront votre session authentifiée.

Ce sont de véritables appels d'API susceptibles d'affecter votre compte ou vos données.

Des limites de débit et d'autres restrictions d'API s'appliquent.

Certaines opérations peuvent modifier ou supprimer des données.

Ce point de terminaison a été remplacé par ces autres points de terminaison recommandés :

Les périmètres d'application suivants sont requis pour appeler ce point de terminaison. Pour plus
d'informations sur la génération de clés appropriées, voir [Gestion des clés API]({apiKeyReferenceDocLink}).

Pour plus d'informations sur la génération de clés, voir [Gestion des clés API]({apiKeyReferenceDocLink}).

Les points de terminaison suivants sont disponibles à des chemins relatifs à l'URL de base.

Cette chaîne est formatée comme un [FieldMask](/cloud/reference/types#fieldmask).

Une valeur JSON peut être `null`, `boolean`, `string`, `number`, `array`, ou `object`.

Les champs d'application suivants sont nécessaires pour que votre application OAuth 2.0 puisse utiliser ce point de terminaison. Pour plus d'informations sur l'enregistrement d'une application OAuth 2.0, voir [Enregistrement et révision d'une application]. ({oauth2ReferenceDocLink}).

Pour plus d'informations sur l'enregistrement d'une application OAuth 2.0, voir [Enregistrement et examen d'une application]({oauth2ReferenceDocLink}).

Les objets suivants décrivent les charges utiles qui sont acceptées ou renvoyées. Voir chaque point de terminaison individuel pour plus d'informations sur l'utilisation de ces objets.

Les périmètres d'application suivants sont requis pour appeler ce point de terminaison.

Routes de ressources

Ce string est formatée en tant que [Timestamp](/cloud/reference/types#timestamp).

Non recommandé

Vous consultez la référence Open Cloud remaniée.

Vous avez désactivé la nouvelle référence Open Cloud.

Consultez vos comptes de facturation publicitaire.

Consultez vos campagnes publicitaires et leurs performances.

Créez, modifiez et gérez vos campagnes publicitaires.

Cela permet de consulter des informations sur vos contenus.

Il permet d'importer et de mettre à jour des éléments sur Roblox.

Cela permet d'afficher les autorisations de contenu pour les sujets (y compris les groupes et les expériences) et les contenus auxquels votre compte a accès.

Cela permet d'accorder des autorisations de contenu à tous les sujets (y compris les groupes et les expériences) et contenus auxquels votre compte a accès.

Cela vous permet d'afficher le statut et les résultats des tâches de configuration automatique de l'avatar en votre nom.

Cela vous permet de créer et de gérer des tâches de configuration automatique de l'avatar en votre nom.

Permet de mettre à jour les badges appartenant à l'utilisateur.

Cela permet de visualiser des informations sur vos articles commerciaux.

Cela permet d'apporter des modifications à vos articles de commerce synchronisés.

Cela permet de visualiser des informations sur vos connexions marchandes.

Cela permet de modifier vos connexions commerciales.

Cela vous permet d'afficher des informations sur vos produits de la Boutique du créateur.

Cela permet de consulter les informations liées à vos enregistrements dans la boutique du créateur.

Cela permet de modifier les informations liées à vos enregistrements dans la boutique du créateur.

Donne accès à la création de data stores en votre nom.

Permet de supprimer des stockages de données en votre nom.

Permet d'accéder à une liste de magasins de données.

Donne l'accès pour prendre un instantané de tes magasins de données.

Donne l'accès à la création d'entrées dans tes magasins de données.

Permet de marquer les entrées spécifiées en vue de leur suppression.

Donne accès à la liste des entrées de votre data store.

Donne l'accès à la lecture des entrées spécifiées dans tes magasins de données.

Permet de mettre à jour la valeur, les attributs et les utilisateurs d'une entrée.

Donne accès à la suppression des révisions des entrées de votre data store.

Donne accès à la liste des révisions des entrées de votre data store.

Donne accès aux révisions en lecture des entrées de votre data store.

Permet d'afficher les détails de configuration des produits développeur de l'utilisateur autorisé.

Permet de modifier les produits développeur de l'utilisateur autorisé.

Cela permet de visualiser des informations sur les environnements de votre univers.

Cela permet de modifier les environnements de votre univers.

Permet d'afficher les détails de configuration des passes de jeu de l'utilisateur autorisé.

Permet de modifier les passes de jeu de l'utilisateur autorisé.

Permet d'afficher les informations des forums de la communauté pour votre compte.

Permet d'afficher les informations des forums de la communauté pour le compte.

Cela permet d'afficher des informations sur vos communautés.

Cela te permet de gérer les demandes d'adhésion à la communauté et les mises à jour de rôle des membres de la communauté de rang inférieur pour ton compte.

Permet d'afficher les données de propriétés d'une instance.

Vous permet de modifier les données des propriétés des instances (actuellement ne supporte que les scripts).

Accorde l'accès à la gestion des contenus de l'utilisateur.

Donne accès à la gestion de tes badges.

Donne accès à la gestion de vos badges et à l'utilisation de Robux.

Donne l'accès à la mise à jour des badges de l'utilisateur autorisé.

Donne accès à la gestion de vos produits développeurs.

Accorde l'accès aux informations sur les expériences pour lesquelles vous avez activé les notifications.

Accorde l'activation ou la désactivation des notifications pour des expériences en votre nom.

Donne accès à la gestion de tes passes.

Donne accès à la gestion de tes communautés.

Donne la permission de lire les informations de la communauté.

Donne des autorisations de gestion de la communauté.

Donne accès à la lecture et à l'écriture de vos tables de localisation

Donne accès à la gestion de la collaboration en équipe pour toutes tes expériences.

Donne accès à la gestion de vos expériences et de certaines informations associées à vos expériences (par exemple des informations de localisation).

Permet de lire les informations de localisation de vos expériences.

Permet de modifier les préférences de localisation de vos expériences.

Donne accès à la gestion de votre compte utilisateur.

Permet l'accès pour modifier les préférences de localisation de l'utilisateur.

Vous permet de visualiser le statut, les journaux et les résultats des tâches d'exécution de Luau pour le lieu associé.

Vous permet de créer de nouvelles tâches d'exécution de Luau pour le lieu associé.

Donne accès à la purge asynchrone de toutes les structures de données de l'univers.

Permet de créer de nouveaux items dans la file d'attente.

Permet d'accéder à des éléments lus depuis le devant de la file d'attente.

Accorde l'accès à la lecture des items situés à l'avant de la file d'attente.

Permet de lire les items de votre mémoire.

Permet d'accéder à la lecture des éléments de la carte.

Donne accès à la création, la mise à jour et la suppression des éléments de la carte.

Cela permet de publier des messages au nom des utilisateurs.

Cela permet d'envoyer des notifications de votre expérience aux utilisateurs.

(Obsolète) Donne accès à la lecture d'une liste d'entrées dans un magasin de données ordonné.

(Obsolète) Donne l'accès à la création d'une nouvelle entrée dans un magasin de données ordonné.

Permet d'accéder aux entrées d'une liste à partir d'un magasin de données ordonné.

Donne l'accès à la création d'entrées dans un magasin de données ordonné.

Cela permet d'énumérer les secrets liés à ton expérience.

Cela permet de créer et de mettre à jour des secrets liés à ton expérience.

Cette autorisation vous permet de soumettre un job d'évaluation et de visualiser le résultat de l'emploi.

Permet d'accéder aux informations sur les produits de votre abonnement.

Cela permet de lire les informations des miniatures en votre nom.

Permet de créer ou de modifier des alertes d'analyse.

Permet la lecture des analyses de l'expérience.

Permet d'écrire des ressources liées aux analyses du jeu.

Donne la capacité de lire les informations sur les lieux.

Donne la possibilité d'éditer les informations du lieu.

Donne accès à la publication de nouvelles versions d'expériences à Roblox.

Cela vous permet de lire les miniatures et les paramètres de personnalisation des miniatures pour vos expériences.

Cela vous permet d'importer et de supprimer des miniatures et de gérer les paramètres de personnalisation des miniatures pour vos expériences.

Donne la possibilité de lire des informations sur l'expérience.

Donne l'accès à la modification des expériences de l'utilisateur autorisé.

Permet de voir les restrictions de l'utilisateur dans l'expérience.

Vous permet de modifier les restrictions d'utilisateur dans l'expérience.

Cela permet la consultation des notifications envoyées à votre compte.

Accorde la possibilité de lire la prime et le statut vérifié de l'utilisateur autorisé.

Cela te permet de voir les comptes sociaux de l'utilisateur autorisé.

Permet de lire les événements d'un jeu.

Permet de modifier les événements d'un jeu

Cela active la fonctionnalité Single Sign-On.

Cela vous donne accès à la lecture des informations de votre profil.