When an error occurs, this example prints the name of the script that errored,
the reason it errored, and a trace of the error.


ScriptContext.Error

message

stackTrace

script

ScriptContext:SetTimeout

seconds

ScriptContext

Demonstrates detecting changes to an instance's ancestry by connecting to the `Class.Instance.AncestryChanged` event.

The ChangingPart's Parent is set to different values overtime. The parent of the part is the part's ancestor, so the `Class.Instance.AncestryChanged` event will fire whenever it changes.


Instance.AncestryChanged

child

parent

Instance.AttributeChanged

attribute

This snippet prints the names of objects as they are added to the Workspace:


Instance.ChildAdded

This snippet prints the names of objects as they are removed from the
Workspace:


Instance.ChildRemoved

This following example will print the name of any object that is added to the
Workspace:


Instance.DescendantAdded

descendant

The following example prints the name of any descendant as it is being removed
from the Workspace:


Instance.DescendantRemoving

This sample demonstrates how, when using Immediate signal behavior, an Instance being destroyed remains in place until the connected function yields.


This sample demonstrates how, when using Deferred signal behavior,
an Instance is destroyed before the signal fires.


Instance.Destroying

Instance.childAdded

Instance:AddTag

This example creates a Part and adds a few sparkle objects to the part. Then
it calls Part:ClearAllChildren() to remove all of the children.


Instance:ClearAllChildren

Demonstrates cloning a model using `Class.Instance:Clone()`.

Instance:Clone

Demonstrates destroying a Part using the `Class.Instance:Destroy()` function.

This function is the correct way to dispose of objects that are no longer required.


Instance:Destroy

Instance:FindFirstAncestor

name

Instance:FindFirstAncestorOfClass

className

Instance:FindFirstAncestorWhichIsA

The below would look in Workspace for an object name "Brick". If found, it
will change the name of the object to "Foo".


Instance:FindFirstChild

recursive

Instance:FindFirstChildOfClass

Instance:FindFirstChildWhichIsA

Instance:FindFirstDescendant

Instance:GetActor

Instance:GetAttribute

Instance:GetAttributeChangedSignal

Instance:GetAttributes

The below would print the name of all objects currently in Workspace when ran.


Instance:GetChildren

Instance:GetDebugId

scopeLength

GetDescendants is often used to do something to all the descendants that are a
particular type of object. The code in this example uses GetDescendants and
`Class.Instance:IsA()` to find all of the parts in the workspace and turns
them green.


Instance:GetDescendants

This code sample demonstrates the behavior of `Class.Instance:GetFullName()`.
It shows how the function behaves when called on an object not in the
`DataModel` hierarchy, and it also shows how the return value does not escape
special characters.


This code sample re-implements the `Class.Instance:GetFullName()` function in
Lua.


Instance:GetFullName

Instance:GetStyled

Instance:GetTags

Instance:HasTag

Demonstrates determining if one instance is the ancestor of another using `Class.Instance:IsAncestorOf()`

Workspace and SpawnLocation are ancestors of the SpawnLocation's decal.
Workspace is an ancestor of SpawnLocation.

SpawnLocation and its decal are descendants of Workspace, not ancenstors.
Decal is a descendant to SpawnLocation, not an ancestor.


Instance:IsAncestorOf

Instance:IsDescendantOf

ancestor

The following code demonstrates how a part can be re-added to the DataModel
after being removed:


Instance:Remove

Instance:RemoveTag

Instance:SetAttribute

value

The following code waits for an instance named "Part" to be added to
Workspace.


Instance:WaitForChild

childName

timeOut

Instance:children

Instance:clone

Instance:destroy

Instance:findFirstChild

Instance:getChildren

Instance:isDescendantOf

Instance:remove

Instance

Instance.Archivable

Instance.Capabilities

Instance.Name

Instance.Parent

Instance.RobloxLocked

Instance.Sandboxed

Instance.UniqueId

Instance.archivable

This sample demonstrates the subtleties of the Changed event on normal objects
and "-Value" objects.


This code sample demonstrates the Changed event firing within a parent object.


Object.Changed

property

This code sample demonstrates how to save a value before a changed event fires
on it in order to get more information about a change.


This code sample demonstrates the equivalence of the `Changed` event and event
returned by `GetPropertyChangedSignal`.


Object:GetPropertyChangedSignal

Demonstrates determining the class of Workspace using `Class.Instance:IsA()`

Workspace is of class 'Workspace', so the first statement is true.
Workspace is not of class 'BasePart', so the second statement is false.
Workspace inherits from Instance and therefore is of class 'Instance', so the third statement is true.


Object:IsA

Object:isA

Object

Object.ClassName

Object.className

/reference/engine/classes/ScriptContext.yaml

This service controls all `Class.BaseScript` objects. Most of the properties
and methods of this service are locked for internal use.


An `Class.Actor` is a container for code that can be safely split into its own thread.

Class

Actor

Luau

Array

Dictionary

Data Type

An object that runs connected functions upon a specific occurrence.

RBXScriptSignal

Variant

Data type having a value of either true or false.

bool

A double-precision floating-point number.

number

A sequence of characters, such as letters, numbers, and symbols.

string

void

概要

ガイド

チュートリアル

リファレンス

リソース

アート

デザイン

エンジン

Avatar

旧型

クラウド

ベータエンドポイントが一般向けに使用できるようになりました。破壊的変更は可能ですがまれです。

このフィールドはリソースの作成時に設定できますがその後のリクエストでは変更することはできません。

このフィールドはリクエスト上で提供されることはあるかもしれませんが、応答に入ることはありません。

各APIキー：各IPアドレスにつき {maxInPeriod} 回のリクエストが {periodInSeconds} 秒ごとに送信されます

このフィールドは応答に設定できますが、リクエストでは無視されます。

このエンドポイントを呼び出すには以下のAPIキー権限が必要です。適切なキーの生成方法についての情報は、 [API キーの管理]({apiKeyReferenceDocLink}) をごらんください。

次のエンドポイントは、ベースのURLに相対するパスで使用できます。

この文字列は [Timestamp](/cloud/reference/types#fieldmask) としてフォーマットされています。

JSON 値は、 `null`、 `boolean`、 `string`、 `number`、 `array`、 `object` にはできません。

あなたのOAuth 2.0 アプリケーションでこのエンドポイントを使用するには以下の範囲が必要です。OAuth 2.0 アプリケーションの登録方法についての情報は、 [アプリ登録とレビュー]({oauth2ReferenceDocLink}) をごらんください。

以下のオブジェクトは、受け入れられたか返されたペイロードの説明です。これらのオブジェクトがいつ使用されるかについて詳しくは、各エンドポイントを参照してください。

この文字列は [Timestamp](/cloud/reference/types#timestamp) としてフォーマットされています。

これであなたのアセットについての情報を表示できるようになります。

これでRobloxにアセットをアップロードしたり、アップデートしたりできます。

ユーザー所有のバッジを更新する能力を付与。

あなたのコマースアイテムについての情報を表示できるようにします。

This allows editing of your commerce merchant connections.

これでクリエーターストアの製品に関する情報を表示できます。

これでクリエーターストアの製品に関する情報を変更できます。

これであなたのグループについての情報を表示できるようになります。

これでお持ちのアカウントのグループ参加リクエストを管理できるようになります。

これであなたの持ち物についての情報を表示できるようになります。

あなたのバッジ管理へのアクセス権を付与。

あなたの開発者製品の管理機能へのアクセス権を付与。

フォローしているバーチャル空間についての情報を読むためのアクセス権を付与。

あなたに代わってバーチャル空間のフォローとフォロー解除をするアクセス権を付与。

あなたのパス管理へのアクセス権を付与。

あなたのグループ管理へのアクセス権を付与。

グループ情報を読む権限を付与。

多言語化テーブルの読み込みと書き込みへのアクセス権を付与

あなたが所有するすべてのバーチャル空間に関するチーム共同制作管理へのアクセス権を付与。

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

バーチャル空間の多言語化情報を読むアクセス権を付与。

バーチャル空間の多言語化設定を変更するためのアクセス権を付与。

あなたのユーザーアカウントへのアクセス権を付与。

ユーザーの多言語化設定を変更するアクセス権を付与。

これでユーザーに代わってメッセージを公開する権限を与えることができます。

これでバーチャル空間からユーザーに通知を送信できるようになります。

これであなたのバーチャル空間に関連した秘密をリストアップできるようになります。

これであなたのバーチャル空間に関連した秘密を作成してアップデートできるようになります。

あなたの定期購入製品についての内容を読む権限を付与。

プレース情報を読み取る能力を付与。

プレース情報を編集する能力を付与。

この操作によって、Robloxに新しいバージョンのバーチャル空間を公開するアクセス権限が与えられます。

バーチャル空間の情報を読む能力を付与。

バーチャル空間の情報を編集する能力を付与。

バーチャル空間内でのユーザー制限を表示できます。

バーチャル空間内でのユーザー制限が編集できるようになります。

ユーザーがプレミアム会員がどうかと認証済みかどうかを読み取る権限を付与。

これでユーザーのSNSアカウントを表示できるようになります。

シングルサインオン機能を有効化。

これにより、あなたのプロフィール情報を読む権限が与えられます。

デフォルト値: {defaultValueStart}{defaultValueEnd}

配列は順番に並べてある値のリストです。配列はデータの集まりを保存するのに便利です。

キーと値のペアのセットで、キーは任意の番号、文字列、またはオブジェクトにできます。

{tuples} のような数値のリスト。

この関数は可能であればすぐに返しますが、値を返すまで呼び出したスレッドを返すことができます。

Robloxは現在、 {nameStart}名前{nameEnd} への対応と管理をしていません。

Robloxは現在、 この演算への対応と管理をしていません。

このメンバーはオブジェクトブラウザに表示されず、広く使用されることを意図していません。

このメンバーはコマンドバーからしかアクセスできません。スクリプトからこのメンバーにアクセスしようとするとエラーが発生します。

この関数は、それを呼び出したLuaスレッドを一時停止できません。

スクリプト内でこのメンバーにアクセスしようとするとエラーが発生します。Roblox Studio のプロパティ ウィンドウからこのメンバーにアクセスできる可能性があります。

このメンバーはRoblox Studioのオブジェクトブラウザには表示されません。

Instance.new コンストラクタを使用してこのクラスのインスタンスを作成できません。

Robloxは、このメンバーをサーバーとクライアント間の境界を超えて複製しません。

Luaコードはこのメンバーにアクセスできません。Roblox Studioのプロパティウィンドウから値を変更できるかもしれません。

このメンバーは、 OpenCloud Luau 実行タスクからアクセスできます。

このオブジェクトのレプリケーション動作は、所有しているプレイヤーによって異なります。

このメンバーには、コマンドバーとプラグインからしかアクセスできません。スクリプトからこのメンバーにアクセスしようとするとエラーが発生します。

このメンバーは読み取り専用です。このメンバーに書き込みを試みるとエラーが発生します。

このプロパティは読み取り専用で、同期されていないスレッドでも安全に読み取りできます。書き込みを試みるとエラーが発生します。

このメンバーは CoreScript でしかアクセスできません。

Roblox CoreScripts のみがこのメンバーにアクセスでき、Players は使用できません。

複数のスレッドから安全にこのプロパティの読み取りと書き込みができます。

このクラスはトップレベルのシングルトンです。GetService 関数でこのクラスのインスタンスを回収します。

複数のスレッドがこのプロパティに書き込める可能性があるため、同期されていないスレッドから読み取るのは安全ではありません。

この関数は、結果を返すまで呼び出した Lua スレッドを一時停止します。他のスクリプトを中断することはありません。

ScriptContext

概要

プロパティ

方法

イベント

プロパティ

方法

SetTimeout

パラメータ

戻り値

イベント

Error

パラメータ

コードサンプル