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

Belirli bir olay meydana geldiğinde bağlı işlevleri çalıştıran bir nesne.

RBXScriptSignal

Luau

number

Deneyimler

Avatar

Varlıklar

Samples and projects

Engine API

Open Cloud API

Studio

Analizler

Platform

Öğreticiler

Yaratıcı programları

Eğitim

Kurslar

Learn

Eş zamansız olan bu yöntem, işlemin geçerli durumunu temsil eden bir `Operation` döndürür Gerçek yanıtı ve uygulanabilir üst verileri elde etmek için yoklayabileceğin bir uç nokta yolu içerir. Daha fazla bilgi için uzun süreli işlemlerle ilgili [dokümantasyonu]({longRunningOperationsLink}) incele.

Aşağıdaki kısımlar, bir işlem tamamlandığında sağlanan yanıt ve üst veri nesnelerini tanımlar.

Beta uç noktaları herkesin kullanımına açıldı. Kesme değişiklikleri mümkün olsa da nadir görülür.

These Open Cloud documentation pages will be removed on March 31, 2026. You will be automatically redirected to the new Open Cloud documentation at that time. {linkStart}Learn more{linkEnd}

These old Open Cloud pages will be removed and redirected on March 31, 2026. {linkStart}Learn more{linkEnd}

Deneysel uç noktalar herkese açık şekilde kullanıma hazırdır ancak API sözleşmesi tamamlandıkça zaman zaman önemli değişikliklerden geçebilir.

This endpoint can be called in-experience through {httpServiceLinkStart}HttpService{httpServiceLinkEnd} with an API key.

Bu alan, kaynak oluşturulurken ayarlanabilir ama sonraki taleplerde düzenlenemez.

Bu alanlar, kaynak oluşturulurken ayarlanabilir ama sonraki taleplerde düzenlenemez.

Bu alan, taleplerde sağlanabilir ancak yanıtlara asla dâhil edilmez.

Eski kimlik doğrulama yöntemi. API Anahtarı veya OAuth 2.0 kullanılabilir durumdaysa bunları kullanmayı tercih et.

API Anahtarı başına: Her {periodInSeconds} saniyede IP adresi başına {maxInPeriod} talep

Çağrı için kimlik doğrulama gerektirmez. Genellikle önemli ölçüde düşük oran limitlerine sahiptir. API Anahtarı veya OAuth 2.0 kullanılabilir durumdaysa her zaman bunları kullanmayı tercih et.

Her gruplama için şemada aşağıdaki alanlardan yalnızca birinin sağlanması gerekir, geri kalanlar hariç tutulabilir.

You can opt back in at any time. {linkStart}Provide feedback.{linkEnd}

You are viewing the old docs. {linkStart}Provide feedback.{linkEnd}

You can opt out at any time and be redirected back to the old reference pages. {linkStart}Provide feedback.{linkEnd}

You are viewing the revamped docs. {linkStart}Provide feedback.{linkEnd}

Bu alan, yanıtlar için ayarlanabilir ancak isteklerde göz ardı edilir.

Not: Yoğun trafikli dönemlerde oran sınırları daha düşük olabilir. Bazı uç noktaların ek oran sınırları vardır. [Oran sınırları hakkında daha fazla bilgi edin]({link}).

Tüm API anahtarlarında bir kullanıcı veya grup için günde {limit} talep

Tüm API anahtarlarında bir kullanıcı veya grup için saatte {limit} talep

Tüm API anahtarlarında bir kullanıcı veya grup için dakikada {limit} talep

Tüm API anahtarlarında bir kullanıcı veya grup için saniyede {limit} talep

API anahtarı sahibi başına dakikada {limit} talep

Uygulama kullanıcısı başına günde {limit} talep

Uygulama kullanıcısı başına saatte {limit} talep

Uygulama kullanıcısı başına dakikada {limit} talep

Uygulama kullanıcısı başına saniyede {limit} talep

API anahtarı sahibi başına saniyede {limit} talep

Kapsamlar, kimlik bilgilerinin sahip olduğu izinleri kontrol eder. Kimlik bilgilerin yalnızca seçtiğin kapsamlar tarafından desteklenen uç noktalara erişebilir.

Kararlı uç noktalar üretime hazırdır ve kullanım ömürleri boyunca neredeyse hiçbir zaman önemli değişikliklerden geçmez.

Bu hedef, anahtarının seçilen {requiredParts} parçalarına erişimini sınırlamanı sağlar

Bu hedef, anahtarının seçilen {requiredParts} ve {optionalParts} parçalarına erişimini sınırlamanı sağlar

Hedef türleri, kimlik bilgilerinin izne sahip olduğu kaynakları kısıtlamak için kullanılır. Hesabının ek kaynaklar üzerinde izinleri olsa bile yalnızca seçilen kaynaklar üzerinde işlem yapılabilir. Bazı kapsamların hedef bölümleri yoktur. Böyle durumlarda, ilgili tüm kaynaklar üzerinde işlem yapılabilir.

Kullanıcıya ait API Anahtarları için evren Üst Seviye Bölümünün seçilmesine gerek yoktur. Bu durumda API Anahtarının, kullanıcıya ait tüm deneyimlerine ve uygun grup izinlerine sahip olduğun grup deneyimlerine erişimi olacaktır.

Dene, API anahtarı veya OAuth 2.0 kimlik doğrulaması gerektiren uç noktalar için henüz desteklenmiyor

Güvenlik için yüksek riskli işlemlerde çerez kimlik doğrulaması devre dışı bırakılmıştır.

Kritik risk uç noktaları son derece hassastır ve güvenlik için Dene düğmesi devre dışı bırakılmıştır

Not: Kimlik doğrulama başlıkları bu kod örneğine dâhil edilmemiştir. Bu komutun çalışması için bir kimlik doğrulama başlığı eklemen gerekebilir.

Bu, kritik verileri değiştirebilecek veya silebilecek yüksek riskli bir uç noktadır. Test ederken çok dikkatli ol.

Bu API uç noktası YÜKSEK RİSKLİ olarak sınıflandırılmıştır ve canlı verileri veya kullanıcı hesaplarını etkileyebilir.

Yüksek riskli API'lere yönelik kimliği doğrulanmış talepler, geri alınamayan değişikliklere neden olabilir. Devam etmeden önce lütfen talep parametrelerini dikkatlice incele.

Çerez kimlik doğrulamasını kullanmak için lütfen giriş yap

Bu, verileri alan düşük riskli bir uç noktadır. Test edilmesi genellikle güvenlidir.

Bu, verileri değiştiren orta riskli bir uç noktadır. Değişiklikler kalıcı olabileceğinden, kritik olmayan hesaplarla dikkatlice test et.

Hesabını güvende tutmak istiyorsan buraya asla başka kaynaklardan metin yapıştırma veya bu sayfadan başkalarına bilgi gönderme.

Gerçek hesap kimlik bilgilerini kullanarak canlı API uç noktalarını test etmek üzeresin.

Yalnızca yapmak üzere olduğun API çağrılarının sonuçlarını anlıyorsan devam et. Test etmeden önce API belgelerini dikkatlice incele.

API çağrıları, kimliği doğrulanmış oturumun kullanılarak yapılacaktır

Bunlar, hesabını veya verilerini etkileyebilecek gerçek API çağrılarıdır

İstek sınırları ve diğer API kısıtlamaları geçerlidir

Bazı işlemler verileri değiştirebilir veya silebilir

This endpoint has been superseded by these recommended alternative endpoints:

Bu uç noktayı çağırmak için aşağıdaki kapsamlar gereklidir. Uygun anahtarları
oluşturma hakkında daha fazla bilgi [API anahtarlarını yönetme]({apiKeyReferenceDocLink}) bölümünden edinilir.

Anahtar oluşturma hakkında daha fazla bilgi [API anahtarlarını yönetme]({apiKeyReferenceDocLink}) bölümünden edinilir.

Şu uç noktaları, taban URL'ye göre belirlenen yollarda mevcut.

Bu dizi [FieldMask](/cloud/reference/types#fieldmask) olarak biçimlendirilmiş.

JSON değeri `null`, `boolean`, `string`, `number`, `array` ya da `object` olabilir.

Bu uç noktasının kullanılması adına OAuth 2.0 uygulaman için aşağıdaki kapsamlar gerekir. OAuth 2.0 uygulamanı nasıl kaydettireceğin hakkında daha fazla bilgi için [Uygulama kaydı ve incelemesi]({oauth2ReferenceDocLink}) sayfasını incele.

Bir OAuth 2.0 uygulamasını kaydetme hakkında daha fazla bilgi [Uygulama kaydı ve inceleme]({oauth2ReferenceDocLink}) bölümünden edinilir.

Şu nesneler kabul edilen veya döndürülen yükleri tanımlar. Bu nesnelerin ne zaman kullanıldığı hakkında daha fazla bilgi için tüm uç noktalara bak.

Bu uç noktayı çağırmak için aşağıdaki kapsamlar gereklidir.

Resource Paths

Bu dizi [Timestamp](/cloud/reference/types#timestamp) olarak biçimlendirilmiş.

Bu uç noktasının kullanılması adına OAuth 2.0 uygulaman için aşağıdaki kapsamlar gerekir. OAuth 2.0 uygulamanı nasıl kaydettireceğin hakkında daha fazla bilgi için [Uygulama Kaydı ve İncelemesi]({oauth2ReferenceDocLink}) sayfasını incele.

Not Recommended

You are viewing the revamped Open Cloud reference.

You've opted out of the new Open Cloud reference.

View your ad campaigns and their performance.

Create, update, and manage your ad campaigns.

This allows viewing information about your assets.

This allows uploading and updating assets to Roblox.

This allows viewing asset permissions for subjects (including groups and experiences) and assets your account has access to.

This allows granting asset permissions to any subjects (including groups and experiences) and assets your account has access to.

This allows you to view the status and results of avatar auto-setup jobs on your behalf.

This allows you to create and manage avatar auto-setup jobs on your behalf.

Grants the ability to update badges owned by the user.

This allows viewing information about your commerce items.

This allows making changes to your synced commerce items.

This allows viewing information about your commerce merchant connections.

This allows editing of your commerce merchant connections.

This allows you to view information about your Creator Store products.

This allows you to modify information about your Creator Store products.

This allows you to view information about your Creator Store saves.

This allows you to modify information about your Creator Store saves.

Grants access to create data stores on your behalf.

Grants access to delete data stores on your behalf.

Grants access to read a list of data stores.

Grants access to take a snapshot of your data stores.

Grants access to create entries in your data stores.

Grants access to mark specified entries for deletion.

Grants access to list your data store's entries.

Grants access to read specified entries in your data stores.

Grants access to update the value, attributes, and users of an entry.

Grants access to delete revisions of your data store's entries.

Grants access to list revisions for your data store's entries.

Grants access to read revisions of your data store's entries.

Grants access to view configuration details for the authorized user's developer products.

Grants access to edit the authorized user's developer products.

This allows viewing information about your universe's environments.

This allows editing of your universe's environments.

Grants access to view configuration details for the authorized user's game passes.

Grants access to edit the authorized user's game passes.

Grants access to view community forums information for your account.

Grants access to manage community forums information for your account.

This allows viewing information about your communities.

This allows you to manage community join requests and role updates of lower-ranked community members for your account.

Allows you to view an instance's property data.

Allows you to modify the property data of instances (currently only supports Scripts).

This allows viewing information about your inventory.

Grants access to manage your badges and spend Robux.

Grants access to update the authorized user's badges.

Grants access to manage your developer products.

Grants access to read information about the experiences you have notifications on for.

Grants access to turn on or off notifications for experiences on your behalf.

Grants access to manage your communities.

Grants permission to read community information.

Grants access to read and write your localization tables

Grants access to manage team collaboration for all experiences you own.

Grants access to manage your experiences and certain information associated with your experiences (e.g. localization information).

Grants access to read your experiences' localization information.

Grants access to modify your experiences' localization preferences.

Grants access to manage your user account.

Grants access to modify user localization preferences.

Allows you to view the status, logs, and results of Luau execution tasks for the associated place.

Allows you to create new Luau execution tasks for the associated place.

Grants access to asynchronously flush all data structures in the universe.

Grants access to discard read items from the front of the queue.

Grants access to read items at the front of the queue.

Grants access to read your memory store items.

Grants access to create, update, and delete map items.

This grants the ability to publish messages on behalf of users.

This allows sending notifications from your experience to users.

(Deprecated) Grants access to read a list of entries in an ordered data store.

(Deprecated) Grants access to create a new entry in an ordered data store.

Grants access to list entries from an ordered data store.

Grants access to create entries in an ordered data store.

This allows listing secrets associated with your experience.

This allows creating and updating secrets associated with your experience.

This permission allows you to submit an evaluation job and view the job result.

Grants access to read about your subscription products.

This allows you to read thumbnail information on your behalf.

Grants the ability to read analytics alerts.

Grants the ability to create or modify analytics alerts.

Grants the ability to read game analytics.

Grants the ability to write resources related to game analytics.

Grants the ability to read place information.

Grants the ability to edit place information.

Grants access to publish new versions of experiences to Roblox.

This allows you to read thumbnails and thumbnail personalization settings for your experiences.

This allows you to upload and delete thumbnails and manage thumbnail personalization settings for your experiences.

Grants the ability to read experience information.

Grants access to edit the authorized user's experiences.

Allows you to view user restrictions in the experience.

Allows you to edit user restrictions in the experience.

This allows viewing notifications sent to your account.

Grants the ability to read the authorized user's premium and verified status.

This allows you to view the authorized user's social accounts.

Grants the ability to read a game's events.

This enables Single Sign-On functionality.

This grants access to read your profile information.

Bu işlev, mümkünse anında döndürür ama kendisini çağıran iş parçacığını değer döndürene kadar bekletebilir.

Learn more about {linkStart}capabilities{linkEnd}.

{nameStart}ad{nameEnd} artık Roblox tarafından desteklenmiyor ve sürdürülmüyor.

This endpoint is no longer supported or maintained by Roblox.

Bu matematik işlemi artık Roblox tarafından desteklenmiyor ve sürdürülmüyor.

Bu üye, nesne tarayıcısında görünmüyor ve genel kullanım için değil.

Bu üyeye yalnızca komut çubuğu üzerinden erişilebilir. Üyeye betiklerden erişmeye çalışmak hataya yol açar.

Bu işlev kendisini çağıran Lua iş parçacığını duraklatamaz.

Bu üyeye betiklerden erişmeye çalışmak hataya yol açar. Üyeye Roblox Studio'nun özellikler penceresinden erişmen mümkün olabilir.

Bu üye, Roblox Studio'nun Nesne Tarayıcısı'nda görünmüyor.

Instance.new yapılandırıcısıyla bu sınıfın yeni bir örneğini yaratamazsın.

Roblox, bu üyeyi sunucu istemci sınırında çoğaltmaz.

Lua kodu bu üyeye erişemiyor. Üyenin değerini Roblox Studio'nun özellik penceresinden değiştirmen mümkün olabilir.

Bu üyeye OpenCloud Luau yürütme görevlerinden erişilebilir.

Bu nesnenin çoğalma davranışı, sahibi olan oyuncuya bağlı.

Bu üyeye komut çubuğu ve eklentiler üzerinden erişilebilir. Üyeye betiklerden erişmeye çalışmak hataya yol açar.

Bu üye salt okunur. Üyeye yazmaya çalışmak hataya yol açar.

Bu özellik salt okunurdur ve senkronizasyonsuz iş parçacıklarında bu özelliğin okunması güvenlidir. Özelliğe yazmaya çalışmak hataya yol açar.

There are alternative endpoints available that supersede this endpoint.

Bu üyeye yalnızca CoreScripts üzerinden erişilebilir.

Bu üyeye yalnızca Roblox CoreScripts erişebilir ve üye, Oyuncular tarafından kullanılamaz.

Bu özelliğin birden fazla iş parçacığından güvenli bir şekilde okunması ve üzerine yazılması mümkündür.

Bu sınıf en üst düzey bir tekil. GetService işleviyle bu sınıfın bir örneğini al.

Can be accessed within callbacks bound via {link1Start}RunService:BindToSimulation(){link1End}. Participates in rollbacks. See {link2Start}server authority{link2End}.

Çoklu iş parçacıkları bu özelliğe yazabileceğinden senkronizasyonsuz iç parçacıklarından okumak güvenli değildir.

Bu işlev, kendisini çağıran iş parçacığını değer döndürene kadar duraklatabilir. Bu, diğer betiklerin işleyişini durdurmaz.

Özet