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 objeto que ejecuta funciones conectadas ante una ocurrencia específica.

RBXScriptSignal

Un número de punto flotante de doble precisión.

Luau

number

Experiencias

Avatar

Recursos

Muestras y proyectos

API del motor

API de nube abierta

Studio

Análisis

Plataforma

Tutoriales

Programas de creador

Educación

Cursos

Aprender

Este método es asíncrono y devuelve una `Operación`, que representa el estado actual de la operación. Contiene una ruta final que puede sondear para obtener la respuesta real y los metadatos aplicables. Ve la [documentation]({longRunningOperationsLink}) en operaciones de larga duración para más información.
            
Las siguientes secciones describen la respuesta y los objetos metadatos que se proporcionan cuando una operación termina.

Los puntos finales beta están listos para uso público. Los cambios que los puedan estropear son posibles, pero poco frecuentes.

Estas páginas de documentación de Open Cloud se eliminarán el 31 de marzo de 2026. En ese momento, se te redirigirá automáticamente a la nueva documentación de Open Cloud. {linkStart}Más información{linkEnd}

Estas páginas antiguas de Open Cloud se eliminarán y se redirigirán el 31 de marzo de 2026. {linkStart}Más información{linkEnd}

Los puntos de conexión experimentales están listos para su uso público, pero pueden experimentar cambios importantes ocasionalmente a medida que se finaliza el contrato de la API.

Este punto de conexión se puede llamar en la experiencia a través de {httpServiceLinkStart}HttpService{httpServiceLinkEnd} con una clave API.

Este campo se puede establecer al crear un recurso, pero no se puede modificar por solicitudes posteriores.

Estos campos se pueden establecer al crear un recurso, pero no son modificables por solicitudes posteriores.

Este campo se puede proporcionar en las solicitudes, pero nunca se incluirá en las respuestas.

Método de autenticación heredado. Siempre que esté disponible, se recomienda usar la clave API u OAuth 2.0.

Por clave API: {maxInPeriod} solicitudes cada {periodInSeconds} segundos por dirección IP

No requiere autenticación para llamar. Por lo general, tiene límites de velocidad significativamente reducidos. Siempre es preferible usar la clave API u OAuth 2.0 cuando esté disponible.

Para cada agrupación, solo se debe proporcionar uno de los siguientes campos del esquema, el resto se puede excluir.

Puedes volver a participar en cualquier momento. {linkStart}Deja tus comentarios.{linkEnd}

Estás viendo los documentos anteriores. {linkStart}Deja tus comentarios.{linkEnd}

En cualquier momento puedes decidir no usarla y volver a las páginas de referencia anteriores. {linkStart}Agradecemos cualquier comentario que tengas.{linkEnd}

Estás viendo los documentos renovados. {linkStart}Deja tus comentarios.{linkEnd}

Este campo se puede configurar como respuestas, pero se ignorará en las solicitudes.

Nota: Los límites de frecuencia pueden ser más bajos durante los periodos de tráfico alto. Ciertos puntos finales tienen límites de frecuencia adicionales. [Más información sobre los límites de frecuencia]({link}).

{limit} solicitudes por minuto en todas las claves API para un usuario o grupo

{limit} solicitudes por segundo en todas las claves API para un usuario o grupo

{limit} solicitudes por minuto por propietario de la clave API

{limit} solicitudes por día por usuario de la aplicación

{limit} solicitudes por hora por usuario de la aplicación

{limit} solicitudes por minuto por usuario de la aplicación

{limit} solicitudes por segundo por usuario de la aplicación

{limit} solicitudes por segundo por propietario de la clave API

Los alcances controlan qué permisos tienen tus credenciales. Tus credenciales solo pueden acceder a los puntos finales que admitan los alcances que seleccionaste.

Los endpoints estables están listos para producción y casi nunca presentarán cambios que rompan la compatibilidad durante su vida útil.

Este objetivo le permite limitar el acceso de su clave a las {requiredParts} seleccionadas

Este objetivo te permite limitar el acceso de tu clave a las {requiredParts} y las {optionalParts} que elijas

Los tipos de destino se utilizan para restringir los recursos para los que tus credenciales tienen permisos. Solo se puede actuar sobre los recursos seleccionados, incluso si tu cuenta tiene permisos de recursos adicionales. Algunos alcances no tienen partes de destino. En estos casos, se puede actuar sobre todos los recursos relevantes.

No es necesario seleccionar la parte superior del nivel en el universo para las claves API propiedad del usuario. En este caso, tu clave API tendrá acceso a todas tus experiencias propiedad del usuario y a las experiencias propiedad del grupo para las que tengas los permisos de grupo correctos.

La función Prueba aún no es compatible con los puntos de conexión que requieren una clave API o autenticación OAuth 2.0.

La autenticación de cookies está desactivada para operaciones de alto riesgo por motivos de seguridad.

Los puntos finales de riesgo crítico son extremadamente sensibles y la función de Prueba está deshabilitada por motivos de seguridad.

Nota: Los encabezados de autenticación no se incluyen en este ejemplo de código. Es posible que tengas que agregar un encabezado de autenticación para que este comando funcione.

Este es un punto final de alto riesgo que puede modificar o eliminar datos críticos. Ten mucho cuidado al realizar pruebas.

Este punto final de la API se ha clasificado como de ALTO RIESGO y puede afectar a los datos en vivo o a las cuentas de usuario.

Las solicitudes autenticadas a API de alto riesgo pueden realizar cambios que no se pueden deshacer. Revisa cuidadosamente los parámetros de tu solicitud antes de continuar.

Inicia sesión para usar la autenticación de cookies

Este es un punto final de bajo riesgo que recupera datos. Por lo general, es seguro probarlo.

Este es un punto final de riesgo medio que modifica datos. Pruébalo cuidadosamente con cuentas no críticas, ya que los cambios pueden ser permanentes.

Para mantener tu cuenta segura, nunca pegues aquí texto de otras fuentes ni envíes información de esta página a otras personas.

Está a punto de probar los puntos finales de la API en vivo utilizando las credenciales de tu cuenta actual.

Continúa solo si comprendes las implicaciones de las llamadas API que estás a punto de realizar. Revisa la documentación de la API cuidadosamente antes de realizar la prueba.

Las llamadas de API se realizarán utilizando tu sesión autenticada

Estas son llamadas API reales que pueden afectar tu cuenta o tus datos

Se aplican límites de velocidad y otras restricciones de API

Es posible que algunas operaciones modifiquen o eliminen datos

Este punto de conexión se reemplazó por estos puntos de conexión alternativos recomendados:

Se requieren los siguientes alcances para llamar a este punto final. Para obtener más
información sobre cómo generar claves adecuadas, consulta [Administrar claves API]({apiKeyReferenceDocLink}).

Para obtener más información sobre cómo generar claves, consulta [Administrar claves API]({apiKeyReferenceDocLink}).

Los siguientes extremos están disponibles en rutas relativas a la URL base.

Esta cadena está formateada como [Timestamp](/cloud/reference/types#timestamp).

Un valor JSON puede ser `null`, `boolean`, `string`, `number`, `array`, u `object`.

Los siguientes ámbitos son necesarios para que tu aplicación OAuth 2.0 use este extremo. Para obtener más información sobre cómo registrar una aplicación de OAuth 2.0, consulta [Registro y revisión de aplicaciones]({oauth2ReferenceDocLink}).

Para obtener más información sobre cómo registrar una aplicación OAuth 2.0, consulta [Registro y revisión de aplicaciones]({oauth2ReferenceDocLink}).

Los siguientes objetos describen cargas que son aceptadas o devueltas. Ve cada extremo para más información sobre cuándo se utilizan estos objetos.

Se requieren los siguientes alcances para llamar a este punto final.

Rutas de recursos

No recomendado

Estás viendo la referencia renovada de Open Cloud.

Decidiste no usar la nueva referencia de Open Cloud.

Consulta tus cuentas de facturación de anuncios.

Consulta tus campañas de anuncios y su ejecución.

Crea, actualiza y gestiona tus campañas de anuncios.

Esto permite ver información sobre tus recursos.

Esto permite cargar y actualizar recursos a Roblox.

Esto permite ver los permisos de recursos para temas (incluidos grupos y experiencias) y recursos a los que tu cuenta tiene acceso.

Esto permite conceder permisos de recurso a cualquier elemento (incluyendo grupos y experiencias) y recursos a los que tu cuenta tiene acceso.

Esto te permite ver el estado y los resultados de los trabajos de configuración automática de avatares en tu nombre.

Esto te permite crear y administrar trabajos de configuración automática de avatares en tu nombre.

Permite actualizar las insignias de propiedad del usuario.

Esto permite ver información sobre tus objetos de comercio.

Esto te permite realizar cambios en tus objetos comerciales sincronizados.

Esto te permite ver información sobre tus conexiones comerciales.

Esto te permite editar tus conexiones de comerciantes.

Esto te permite ver información sobre tus productos de la Tienda de creadores.

Esto te permite modificar la información sobre tus productos de la Tienda de creadores.

Esto te permite ver información sobre los elementos guardados de tu Tienda de creadores.

Esto te permite modificar la información sobre los elementos guardados de tu Tienda de creadores.

Permite acceder para crear almacenes de datos en tu nombre.

Permite acceder para eliminar almacenes de datos en tu nombre.

Permite acceder a la lectura de una lista de almacenes de datos.

Permite acceder para tomar una instantánea de tus almacenes de datos.

Permite acceder para crear entradas en tus almacenes de datos.

Permite acceder para marcar las entradas especificadas para su eliminación.

Permite enumerar las entradas de tu almacén de datos.

Permite acceder a la lectura de entradas especificadas en tus almacenes de datos.

Permite actualizar el valor, los atributos y los usuarios de una entrada.

Permite acceder para eliminar las revisiones de las entradas de tu almacén de datos.

Permite enumerar las revisiones de las entradas de tu almacén de datos.

Permite leer las revisiones de las entradas de tu almacén de datos.

Permite ver los detalles de configuración de los productos de desarrollador del usuario autorizado.

Permite editar los productos de desarrollador del usuario autorizado.

Esto permite ver información sobre tus entornos de universo.

Esto permite editar tus entornos de universo.

Permite ver los detalles de configuración de los pases de juego del usuario autorizado.

Permite editar los pases de juego del usuario autorizado.

Da acceso para ver la información de los foros de la comunidad de tu cuenta.

Da acceso para gestionar la información de los foros de la comunidad de tu cuenta.

Esto permite ver información sobre tus comunidades.

Esto te permite gestionar las solicitudes de unión a la comunidad y las actualizaciones de roles de los miembros de rango inferior para tu cuenta.

Te permite ver los datos de propiedad de una instancia.

Te permite modificar los datos de propiedad de las instancias (actualmente solo admite Scripts).

Esto permite ver información sobre tu inventario.

Da acceso para administrar los recursos del usuario.

Da acceso para administrar tus insignias.

Da acceso para gestionar tus insignias y gastar Robux.

Permite actualizar las insignias del usuario autorizado.

Da acceso para administrar tus productos de desarrollador.

Permite leer información sobre las experiencias en las que tienes notificaciones.

Permite activar o desactivar las notificaciones de experiencias en tu nombre.

Da acceso para gestionar tus comunidades.

Otorga permiso para leer información de la comunidad.

Otorga permisos de gestión de la comunidad.

Da acceso para leer y escribir tus tablas de localización

Da acceso para gestionar la colaboración en equipo para todas las experiencias de tu propiedad.

Da acceso para gestionar tus experiencias y cierta información asociada a tus experiencias (por ejemplo, información de localización).

Da acceso para leer la información de localización de tus experiencias.

Da acceso para modificar las preferencias de localización de las experiencias.

Da acceso para gestionar tu cuenta de usuario.

Da acceso para modificar las preferencias de localización de usuario.

Te permite ver el estado, los registros y los resultados de las tareas de ejecución de Luau para el lugar asociado.

Te permite crear nuevas tareas de ejecución de Luau para el lugar asociado.

Permite vaciar de forma asincrónica todas las estructuras de datos del universo.

Permite crear nuevos elementos de la cola.

Permite descartar los elementos leídos desde el frente de la cola.

Permite leer los elementos al frente de la cola.

Permite leer los elementos de tu almacén de memoria.

Permite crear, actualizar y eliminar elementos del mapa.

Esta acción permite publicar mensajes en nombre de los usuarios.

Esto permite enviar notificaciones de tu experiencia a los usuarios.

(Obsoleto) Permite acceder a la lectura de una lista de entradas en un almacén de datos ordenado.

(Obsoleto) Permite acceder para crear una nueva entrada en un almacén de datos ordenado.

Permite acceder a las entradas de lista de un almacén de datos ordenado.

Permite crear entradas en un almacén de datos ordenado.

Esto permite enumerar los secretos asociados a tu experiencia.

Esto permite crear y actualizar secretos asociados a tu experiencia.

Este permiso te permite enviar un trabajo de evaluación y ver su resultado.

Da acceso para leer los productos de tu suscripción.

Esto te permite leer la información de las miniaturas en tu nombre.

Permite consultar las alertas de análisis.

Permite crear o modificar las alertas de análisis.

Permite consultar los análisis del juego.

Permite escribir recursos relacionados con los análisis del juego.

Permite leer información sobre el lugar.

Permite editar información sobre el lugar.

Permite publicar nuevas versiones de experiencias en Roblox.

Esto te permite leer las miniaturas y la configuración de personalización de miniaturas en tus experiencias.

Esto te permite subir y eliminar miniaturas y administrar la configuración de personalización de miniaturas en tus experiencias.

Permite leer información sobre la experiencia.

Permite editar las experiencias del usuario autorizado.

Te permite ver las restricciones de usuario en la experiencia.

Te permite editar las restricciones de usuario en la experiencia.

Esto permite ver las notificaciones enviadas a tu cuenta.

Permite consultar el estado Premium y verificado del usuario autorizado.

Esto te permite ver las cuentas de redes sociales del usuario autorizado.

Activa la funcionalidad de inicio de sesión único.

Permite leer la información de tu perfil.

Esta función devuelve inmediatamente si es posible, pero puede producir el hilo que la llamó hasta que devuelva un valor.

Obtén más información sobre las {linkStart}capacidades{linkEnd}.

Roblox ya no soporta o mantiene {nameStart}nombre{nameEnd}

Este punto de conexión ya no es compatible ni recibe soporte de Roblox.

Esta operación matemática ya no es soportada o mantenida por Roblox.

Este miembro no aparece en el navegador de objetos y no está destinado a un uso generalizado.

Solo se puede acceder a este miembro a través de la barra de comandos y de los plugins. Se producirá un error si se intenta acceder a través de los scripts.

Esta función no puede pausar el hilo de Lua que la llamó.

Se producirá un error al intentar acceder a este miembro a través de los scripts. Es posible acceder a él desde la ventana de propiedades de Roblox Studio.

Este miembro no aparece en el navegador de objetos de Roblox Studio.

No se puede crear una instancia de esta clase con el constructor Instance.new.

Roblox no replica este miembro a través de su límite entre servidor y cliente.

El código Lua no puede acceder a este miembro. Puedes cambiar su valor desde la ventana de propiedades en Roblox Studio.

Este miembro es accesible desde las tareas de ejecución de OpenCloud Luau.

El comportamiento de replicación de este objeto depende del jugador que lo posee.

Este miembro es accesible a través de la barra de comandos y de los plugins. Se producirá un error si se intenta acceder a través de los scripts.

Este miembro es de solo lectura. Se producirá un error al intentar escribir a este miembro.

Esta propiedad es de solo lectura y es segura para leer en hilos no sincronizados. Escribir en ella producirá un error.

Esta propiedad es de solo lectura y es seguro leerla en hilos no sincronizados. Se producirá un error al intentar escribir en ella.

Hay puntos de conexión alternativos disponibles que reemplazan a este.

Se puede acceder a este miembro solo en CoreScripts.

Solo Roblox CoreScripts puede acceder a este miembro y no se puede utilizar por los Jugadores.

Puedes leer y escribir en esta propiedad de forma segura desde múltiples hilos.

Esta clase es un singleton de nivel superior. Recupera una instancia de esta clase con la función GetService.

Se puede acceder a ella dentro de las devoluciones de llamada vinculadas a través de {link1Start}RunService:BindToSimulation(){link1End}. Participa en las reversiones. Consulte la {link2Start}autoridad del servidor{link2End}.

Múltiples hilos pueden escribir en esta propiedad, por lo que no es seguro leerla desde hilos no sincronizados.

Esta función pausa el hilo Lua que la llamó hasta que devuelva un resultado. Esta acción no interrumpe otros scripts.