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

특정 발생 시 연결된 함수를 실행하는 객체입니다.

RBXScriptSignal

Luau

number

체험

아바타

애셋

샘플 및 프로젝트

엔진 API

개방형 클라우드 API

Studio

애널리틱스

플랫폼

튜토리얼

크리에이터 프로그램

교육

코스

학습

비동기적 방식으로, 현재 작업 상태를 나타내는 '작업'을 반환합니다. 여기에는 투표를 진행하여 실제 응답과 적용 가능한 메타데이터를 얻을 수 있는 엔드포인트 경로가 포함됩니다. 자세한 정보는 장기 작업에 관한 [설명서]({longRunningOperationsLink})에서 확인하세요.
            
아래 섹션은 작업 완료 시 제공되는 응답 및 메타데이터 개체에 대한 설명입니다.

베타 끝점이 공개적으로 사용될 준비가 되었습니다. 중대한 변경이 발생할 수 있지만 가능성은 낮습니다.

이 개방형 클라우드 설명서 페이지는 2026년 3월 31일부터 이용할 수 없게 됩니다. 이후에는 새로운 개방형 클라우드 설명서로 자동으로 리디렉션됩니다. {linkStart}자세히 알아보기{linkEnd}

이 기존 개방형 클라우드 페이지는 2026년 3월 31일부터 이용할 수 없게 되며, 새로운 페이지로 리디렉션됩니다. {linkStart}자세히 알아보기{linkEnd}

실험적인 엔드포인트는 공개적으로 사용할 수 있지만, API 계약이 확정되는 과정에서 간헐적으로 호환성이 깨지는 변경이 발생할 수 있습니다.

이 엔드포인트는 API 키를 사용하여 {httpServiceLinkStart}HttpService{httpServiceLinkEnd}를 통해 체험 내에서 호출할 수 있습니다.

이 필드는 리소스를 생성할 때 설정될 수 있지만 후속 요청에 의해 수정될 수는 없습니다.

이 필드는 요청에 제공될 수 있지만 응답에는 포함되지 않습니다.

레거시 인증 방식. 가능한 경우 언제나 API 키 또는 OAuth 2.0을 우선 사용합니다.

각 API 키별: IP 주소당 {periodInSeconds}초마다 {maxInPeriod} 요청

호출에 인증이 필요하지 않습니다. 일반적으로 호출 제한이 매우 낮습니다. 가능한 경우 언제나 API 키 또는 OAuth 2.0을 우선 사용합니다.

각 그룹화에 대해 스키마의 다음 필드 중 하나만 제공해야 하며 나머지는 제외할 수 있습니다.

언제든지 다시 참여할 수 있습니다. {linkStart}피드백을 남겨주세요.{linkEnd}

기존 문서를 보고 계십니다. {linkStart}피드백을 남겨주세요.{linkEnd}

언제든지 옵트아웃하고 이전의 참조 페이지로 리디렉션될 수 있습니다. {linkStart}피드백을 남겨 주세요.{linkEnd}

새롭게 개선된 문서를 보고 계십니다. {linkStart}피드백을 남겨주세요.{linkEnd}

이 필드는 응답에서 설정할 수 있지만 요청에서는 무시됩니다.

참고: 트래픽이 많은 기간에는 속도 제한이 더 낮아질 수 있습니다. 일부 엔드포인트에는 속도 제한이 추가로 적용됩니다. [속도 제한에 대해서 자세히 알아보세요]({link}).

사용자 또는 그룹의 모든 API 키에 일 요청 {limit}건

사용자 또는 그룹의 모든 API 키에 시간당 요청 {limit}건

사용자 또는 그룹의 모든 API 키에 분당 요청 {limit}건

사용자 또는 그룹의 모든 API 키에 초당 요청 {limit}건

API 키 소유자당 분당 요청 {limit}건

앱 사용자당 시간당 요청 {limit}건

앱 사용자당 분당 요청 {limit}건

앱 사용자당 초당 요청 {limit}건

API 키 소유자당 초당 요청 {limit}건

범위는 내 자격 증명에 부여된 권한을 제어합니다. 내 자격 증명은 내가 선택한 범위가 지원하는 끝점만 액세스할 수 있습니다.

안정적인 엔드포인트는 프로덕션 환경에서 바로 사용할 준비가 되어 있으며 수명 주기 동안 호환성을 저해하는 변경이 발생할 가능성이 거의 없습니다.

이 대상은 선택한 {requiredParts}에 대한 내 키 액세스를 제한할 수 있게 해줍니다.

이 대상은 선택한 {requiredParts} 및 {optionalParts}에 대한 내 키 액세스를 제한할 수 있게 해줍니다.

대상 유형은 자격 증명에 권한이 있는 리소스를 제한하는 데 사용됩니다. 계정에 추가 리소스에 대한 권한이 있더라도 선택한 리소스만 이용할 수 있습니다. 일부 범위에는 대상 파트가 없으며, 이 경우 모든 관련 리소스를 이용할 수 있습니다.

사용자 소유 API 키에 대해서는 유니버스의 최상위 레벨 파트를 선택할 필요가 없습니다. 이 경우 API 키는 올바른 그룹 권한이 있는 모든 사용자 소유 체험과 그룹 소유 체험에 액세스할 수 있습니다.

이용해 보기는 아직 API 키 또는 OAuth 2.0 인증이 필요한 끝점에 지원되지 않습니다

안전을 위해 고위험 작업에선 쿠키 인증이 비활성화됩니다.

중요 위험 끝점은 극도로 민감하며 안전을 위해 이용해 보기는 비활성화됩니다

참고: 이 코드 샘플에는 인증 헤더가 포함되지 않습니다. 이 명령이 작동하려면 인증 헤더를 추가해야 할 수 있습니다.

중요 데이터를 수정하거나 삭제할 수 있는 고위험 끝점입니다. 테스트 시 매우 신중하게 이용하세요.

이 API 엔드포인트는 높은 위험으로 분류되었으며 라이브 데이터나 사용자 계정에 영향을 줄 수 있습니다.

높은 위험 API로의 인증된 요청은 되돌릴 수 없는 변경 사항을 초래할 수도 있습니다. 진행하기 전에 요청 매개변수를 신중하게 검토하세요.

쿠키 인증을 사용하려면 로그인하세요

데이터를 가져오는 저위험 끝점입니다. 일반적으로 테스트하기에 안전합니다.

데이터를 수정하는 중간 정도의 위험 끝점입니다. 변경 사항이 영구적으로 적용될 수 있으므로, 중요하지 않은 계정으로 신중하게 테스트하세요.

계정을 안전하게 보호하려면 다른 소스의 텍스트를 이곳에 붙여넣거나 이 페이지의 정보를 타인에게 전송하지 마세요.

실제 계정 자격 증명을 이용하여 실시간 API 끝점을 테스트하려고 합니다.

진행하려는 API 호출이 주는 영향을 이해한 경우에만 진행하세요. 테스트 전에 API 문서를 주의 깊게 읽어보시기 바랍니다.

API 호출은 인증된 세션을 이용해 진행됩니다

이는 실제 API 호출로, 회원님의 계정 또는 데이터에 영향을 줄 수 있습니다

비율 제한 및 기타 API 제한이 적용됩니다

일부 작업이 데이터를 수정하거나 삭제할 수 있습니다

이 끝점은 다음 추천 끝점으로 대체되었습니다.

이 엔드포인트를 호출하려면 다음 스코프가 필요합니다. 적절한 키 생성에 대한
자세한 내용은 [API 키 관리]({apiKeyReferenceDocLink})에서 확인하세요.

키 생성에 대한 자세한 내용은 [API 키 관리]({apiKeyReferenceDocLink})에서 확인하세요.

다음 끝점은 기준 URL과 관련된 경로에서 사용할 수 있습니다.

이 문자열은 [FieldMask](/cloud/reference/types#fieldmask) 형식으로 지정됩니다.

JSON 값은 `null`, `boolean`, `string`, `number`, `array`, `object`일 수 있습니다.

OAuth 2.0 애플리케이션에서 이 엔드포인트를 사용하려면 다음 범위가 필요합니다. OAuth 2.0 애플리케이션 등록 방법에 대한 자세한 내용은 [앱 등록 및 심사]({oauth2ReferenceDocLink})에서 확인하세요.

OAuth 2.0 애플리케이션 등록 방법에 대한 자세한 내용은 [앱 등록 및 검토]({oauth2ReferenceDocLink})에서 확인하세요.

다음 개체는 수락되거나 반환되는 페이로드를 설명합니다. 이러한 개체가 사용되는 시기에 대한 자세한 정보는 각 개별 끝점을 참고하세요.

이 끝점을 호출하려면 다음 스코프가 필요합니다.

리소스 경로

이 문자열은 [Timestamp](/cloud/reference/types#timestamp) 형식으로 지정됩니다.

권장되지 않음

개선된 개방형 클라우드 참조를 보고 있습니다.

새로운 오픈 클라우드 참조에서 옵트아웃했습니다.

광고 캠페인과 캠페인의 성과를 확인합니다.

광고 캠페인을 만들고, 업데이트하고, 관리합니다.

이를 통해 애셋에 대한 정보를 볼 수 있습니다.

이를 통해 애셋을 Roblox에 업로드하고 업데이트할 수 있습니다.

이는 나의 계정이 액세스할 수 있도록 주제(그룹 및 체험 포함)와 애셋에 애셋 권한을 볼 수 있도록 합니다.

이는 나의 계정이 액세스할 수 있는 모든 주체(그룹 및 체험 포함)와 애셋에 애셋 권한을 부여할 수 있도록 합니다.

이를 통해 사용자를 대신하여 아바타 자동 설정 작업의 상태와 결과를 볼 수 있습니다.

이를 통해 사용자를 대신하여 아바타 자동 설정 작업을 만들고 관리할 수 있습니다.

사용자가 소유한 배지를 업데이트할 수 있는 권한을 부여합니다.

이를 통해 커머스 아이템에 대한 정보를 볼 수 있습니다.

이를 통해 동기화된 커머스 아이템을 변경할 수 있습니다.

이를 통해 커머스 판매자 연결과 관련된 정보를 볼 수 있습니다.

이를 통해 커머스 판매자 연결을 편집할 수 있습니다.

이를 통해 크리에이터 상점 상품에 대한 정보를 볼 수 있습니다.

이를 통해 크리에이터 상점 상품에 대한 정보를 수정할 수 있습니다.

이를 통해 크리에이터 상점 저장 상품에 대한 정보를 볼 수 있습니다.

이를 통해 크리에이터 상점 저장 상품에 대한 정보를 수정할 수 있습니다.

나를 대신해 데이터 저장소를 생성할 권한을 부여합니다.

나를 대신해 데이터 저장소를 삭제할 수 있도록 권한을 부여합니다.

데이터 저장소의 목록을 읽을 권한을 부여합니다.

데이터 저장소의 스냅샷을 촬영할 권한을 부여합니다.

데이터 저장소에서 항목을 생성할 권한을 부여합니다.

지정된 항목을 삭제 대상으로 표시할 수 있는 권한을 부여합니다.

데이터 저장소 항목을 나열할 권한을 부여합니다.

데이터 저장소에서 지정된 항목을 읽을 권한을 부여합니다.

항목의 값, 특성, 사용자를 업데이트할 수 있는 권한을 부여합니다.

데이터 저장소 항목의 수정 사항을 삭제할 권한을 부여합니다.

데이터 저장소 항목의 수정 사항을 나열할 권한을 부여합니다.

데이터 저장소 항목의 수정 사항을 읽을 권한을 부여합니다.

승인한 사용자의 개발자 제품에 대한 구성 세부 정보를 볼 권한을 부여합니다.

승인한 사용자의 개발제 제품을 편집할 권한을 부여합니다.

이를 통해 유니버스의 환경을 볼 수 있습니다.

이를 통해 유니버스의 환경을 편집할 수 있습니다.

승인한 사용자의 게임 패스에 대한 구성 세부 정보를 볼 권한을 부여합니다.

승인한 사용자의 게임 패스를 편집할 권한을 부여합니다.

계정의 커뮤니티 포럼 정보를 볼 수 있도록 권한을 부여합니다.

계정의 커뮤니티 포럼 정보를 관리할 수 있는 권한을 부여합니다.

이를 통해 커뮤니티에 대한 정보를 볼 수 있습니다.

이를 통해 계정에 대한 커뮤니티 가입 요청과 등급이 낮은 커뮤니티 멤버의 역할 업데이트를 관리할 수 있습니다.

인스턴스의 속성 데이터를 조회하는 권한입니다.

인스턴스의 속성 데이터를 수정할 수 있는 권한입니다(현재는 스크립트만 지원됩니다).

이를 통해 인벤토리에 대한 정보를 볼 수 있습니다.

사용자 애셋을 관리할 수 있는 액세스 권한을 부여합니다.

내 배지를 관리할 수 있는 액세스 권한을 부여합니다.

내 배지를 관리하고 Robux를 사용할 수 있는 액세스 권한을 부여합니다.

승인한 사용자의 배지를 업데이트할 권한을 부여합니다.

내 개발자 상품을 관리할 수 있는 액세스 권한을 부여합니다.

알림을 설정 중인 체험의 정보를 읽을 수 있는 권한을 부여합니다.

나를 대신해 체험에 대한 알림을 켜거나 끌 수 있는 권한을 부여합니다.

내 패스를 관리할 수 있는 액세스 권한을 부여합니다.

내 커뮤니티를 관리할 수 있는 권한을 부여합니다.

커뮤니티 정보를 읽을 수 있는 권한을 부여합니다.

커뮤니티 관리 권한을 부여합니다.

내 로컬라이제이션 테이블을 읽고 쓸 수 있는 액세스 권한을 부여합니다

소유한 모든 체험의 팀 공동 작업을 관리할 수 있는 권한을 부여합니다.

체험 및 체험과 관련된 특정 정보를 관리할 자격을 부여합니다(예: 로컬라이제이션 정보).

내 체험의 로컬라이제이션 정보를 읽을 수 있는 액세스 권한을 부여합니다.

내 체험의 로컬라이제이션 기본 설정을 수정할 수 있는 액세스 권한을 부여합니다.

내 사용자 계정을 관리할 수 있는 권한을 부여합니다.

사용자 로컬라이제이션 기본 설정을 수정할 수 있는 액세스 권한을 부여합니다.

관련 플레이스의 상태, 로그, Luau 실행 작업의 결과를 조회할 수 있습니다.

관련 플레이스의 새로운 Luau 실행 작업을 생성할 수 있는 권한입니다.

유니버스 내 모든 데이터 구조를 비동기적으로 플러시할 수 있는 권한을 부여합니다.

신규 대기열 아이템을 생성할 권한을 부여합니다.

대기열 앞부분에서 읽은 아이템을 폐기할 수 있는 권한을 부여합니다.

대기열 앞부분에서 아이템을 읽을 수 있는 권한을 부여합니다.

메모리 저장소 아이템을 읽을 권한을 부여합니다.

맵 아이템을 읽는 권한을 부여합니다.

맵 아이템을 생성하고, 업데이트하고, 삭제하는 권한을 부여합니다.

사용자를 대신해 메시지를 게시할 수 있는 권한이 부여됩니다.

이를 통해 체험에서 사용자에게 알림을 보낼 수 있습니다.

(사용되지 않음) 정렬된 데이터 저장소에서 아이템 목록을 읽을 권한을 부여합니다.

(사용되지 않음) 정렬된 데이터 저장소에서 신규 항목을 생성할 권한을 부여합니다.

정렬된 데이터 저장소에서 아이템을 조회할 권한을 부여합니다.

정렬된 데이터 저장소에서 항목을 생성할 권한을 부여합니다.

이를 통해 체험과 관련된 보안 비밀을 나열할 수 있습니다.

이를 통해 체험과 관련된 보안 비밀을 생성하고 업데이트할 수 있습니다.

이 권한을 통해 평가 작업을 제출하고 결과를 조회할 수 있습니다.

구독 상품에 대해 읽을 수 있는 액세스 권한을 부여합니다.

이를 통해 사용자를 대신하여 썸네일 정보를 읽을 수 있습니다.

애널리틱스 알림을 읽을 수 있는 권한을 부여합니다.

애널리틱스 알림을 만들거나 수정할 수 있는 권한을 부여합니다.

게임 애널리틱스를 읽을 수 있는 권한을 부여합니다.

게임 애널리틱스와 관련된 리소스를 쓸 수 있는 권한을 부여합니다.

플레이스 정보를 읽을 수 있는 권한을 부여합니다.

플레이스 정보를 편집할 수 있는 권한을 부여합니다.

체험의 새로운 버전을 Roblox에 게시할 수 있는 권한을 부여합니다.

이를 통해 체험에 대한 섬네일 및 섬네일 개인화 설정을 읽을 수 있습니다.

이를 통해 체험에 대한 섬네일을 업로드 및 삭제하고 섬네일 개인화 설정을 관리할 수 있습니다.

체험 정보를 읽을 수 있는 권한을 부여합니다.

승인한 사용자의 체험을 편집할 권한을 부여합니다.

체험에서 사용자 제한을 볼 수 있습니다.

체험에서 사용자 제한을 편집할 수 있습니다.

계정으로 전송된 알림을 볼 수 있습니다.

승인한 사용자의 Premium 및 인증 상태를 읽을 수 있는 권한을 부여합니다.

이를 통해 승인한 사용자의 소셜 계정을 볼 수 있습니다.

게임 이벤트 확인 권한을 부여합니다.

게임 이벤트 편집 권한을 부여합니다.

이 작업은 싱글 사인온 기능을 활성화합니다.

프로필 정보를 읽을 수 있는 액세스 권한을 부여합니다.