GameSettings

GameSettings.VideoCaptureEnabled

GameSettings.VideoRecording

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/GameSettings.yaml

A container for miscellaneous in-game options.


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

ภาพรวม

คำแนะนำ

คู่มือการใช้งาน

การอ้างอิง

แหล่งข้อมูล

งานศิลป์

การออกแบบ

เอ็นจิน

อวาตาร์

ไม่ใช้แล้ว

คลาวด์

This method is asynchronous and returns an `Operation`, which represents the current state of the operation. It contains an endpoint path that you can poll to obtain the real response and applicable metadata. See the [documentation]({longRunningOperationsLink}) on long-running operations for more information.
            
The following sections describe the response and metadata objects that are provided when an operation completes.

Endpoint เวอร์ชัน Beta พร้อมสำหรับการใช้งานทั่วไปแล้ว อาจมีการเปลี่ยนแปลงที่ทำให้ใช้งานไม่ได้ แต่ก็เป็นไปได้ยาก

ตั้งค่าฟิลด์นี้ตอนสร้างแหล่งข้อมูลได้ แต่จะแก้ไขโดยคำขอหลังจากนั้นไม่ได้

อาจมีช่องข้อมูลนี้ในคำขอ แต่จะไม่รวมอยู่ในการตอบกลับโดยเด็ดขาด

ต่อคีย์ API: {maxInPeriod} คำขอทุกๆ {periodInSeconds} วินาทีต่อที่อยู่ IP

อาจใช้ช่องข้อมูลนี้การตอบกลับ แต่จะเว้นไว้ในคำขอ

ต้องมีสิทธิ์เข้าถึงคีย์ API ต่อไปนี้เพื่อเรียกใช้ Endpoint นี้ ดูข้อมูล
เพิ่มเติมเกี่ยวกับการสร้างคีย์ที่เหมาะสมได้ที่[การจัดการคีย์ API]({apiKeyReferenceDocLink})

Endpoints ต่อไปนี้พร้อมใช้งานที่เส้นทางที่สัมพันธ์กับ URL หลัก

สตริงนี้มีรูปแบบ [FieldMask](/cloud/reference/types#fieldmask)

ค่า JSON จะเป็น `null`, `boolean`, `string`, `number`, `array` หรือ `object` ก็ได้

ต้องมีขอบเขตต่อไปนี้สำหรับแอปพลิเคชัน OAuth 2.0 ของคุณเพื่อใช้ Endpoint นี้ ดูข้อมูลเพิ่มเติมเกี่ยวกับวิธีลงทะเบียนแอปพลิเคชัน OAuth 2.0 ได้ที่[การลงทะเบียนและการตรวจสอบแอป]({oauth2ReferenceDocLink})

วัตถุต่อไปนี้ใช้บรรยายเพย์โหลดที่ยอมรับหรือส่งคืน ดูข้อมูลเพิ่มเติมว่าจะใช้วัตถุเหล่านี้ตอนไหนที่ Endpoint แต่ละจุด

เนื้อหาคำขอเป็น

สตริงนี้มีรูปแบบ[ประทับเวลา](/cloud/reference/types#timestamp)

This allows viewing information about your assets.

This allows uploading and updating assets to Roblox.

Grants the ability to update badges owned by the user.

This allows viewing information about your commerce items.

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 viewing information about your communities.

This allows you to manage community join requests for your account.

This allows viewing information about your inventory.

Grants access to mange your badges and spend robux.

Grants access to manage your developer products.

Grants access to read information about the experiences you follow.

Grants access to follow and unfollow 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.

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

This allows sending notifications from your experience to users.

This allows listing secrets associated with your experience.

This allows creating and updating secrets associated with your experience.

Grants access to read about your subscription products.

Grants the ability to read place information.

Grants the ability to edit place information.

This operation grants access to publish new versions of experiences to Roblox.

Grants the ability to read experience information.

Grants the ability to edit experience information.

Allows you to view user restrictions in the experience.

Allows you to edit user restrictions in the experience.

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

This allows you to view a user's social accounts.

This enables Single Sign-On functionality.

This grants access to read your profile information.

ค่าเริ่มต้น: {defaultValueStart}{defaultValueEnd}

อาร์เรย์คือรายการค่าที่เรียงตามลำดับ โดยมีไว้จัดเก็บคอลเล็กชันข้อมูล

ชุดคู่คีย์-ค่า โดยคีย์อาจเป็นตัวเลข สตริง หรืออ็อบเจกต์ใดก็ได้

เช่น {tuples} ซึ่งเป็นรายการค่า

คืนค่าเป็นศูนย์

ฟังก์ชันนี้จะส่งคืนค่าทันทีหากเป็นไปได้ แต่อาจหยุดการทำงานของเธรดที่เรียกใช้จนกว่าจะส่งคืนค่าได้

Roblox ไม่รองรับหรือดูแลรักษา{nameStart}ชื่อ{nameEnd}อีกต่อไป

Roblox ไม่รองรับหรือปรับปรุงการคำนวณนี้อีกต่อไป

สมาชิกรายการนี้ไม่ปรากฏในเบราว์เซอร์วัตถุและไม่ได้มีไว้สำหรับการใช้งานอย่างแพร่หลาย

สามารถเข้าถึงสมาชิกรายการนี้ได้ทางแถบคำสั่งเท่านั้น หากพยายามเข้าถึงจากสคริปต์ จะเกิดข้อผิดพลาด

ฟังก์ชันนี้ไม่สามารถหยุดเธรดภาษา Lua ที่เรียกใช้ไว้ชั่วคราว

หากพยายามเข้าถึงสมาชิกรายการนี้ในสคริปต์ จะเกิดข้อผิดพลาด คุณอาจเข้าถึงสมาชิกรายการนี้ได้จากหน้าต่างคุณสมบัติของ Roblox Studio

สมาชิกรายการนี้ไม่ปรากฏในเบราว์เซอร์วัตถุของ Roblox Studio

คุณไม่สามารถสร้างอินสแตนซ์ของ Class นี้ด้วยคอนสตรัคเตอร์ Instance.new

Roblox ไม่ได้จำลองสมาชิกรายการนี้ข้ามระหว่างเซิร์ฟเวอร์กับไคลเอนต์

โค้ดภาษา Lua เข้าถึงสมาชิกรายการนี้ไม่ได้ คุณอาจเปลี่ยนค่าได้จากหน้าต่างคุณสมบัติใน Roblox Studio

เข้าถึงสมาชิกรายการนี้ได้จากการดำเนินการของ Luau ใน OpenCloud

พฤติกรรมการจำลองวัตถุนี้ขึ้นอยู่กับผู้เล่นที่เป็นเจ้าของ

สามารถเข้าถึงสมาชิกรายการนี้ได้ทางแถบคำสั่งและปลั๊กอิน หากพยายามเข้าถึงจากสคริปต์ จะเกิดข้อผิดพลาด

สมาชิกรายการนี้เป็นแบบอ่านอย่างเดียว หากพยายามเขียน จะเกิดข้อผิดพลาด

คุณสมบัตินี้อ่านได้อย่างเดียวและอ่านได้อย่างปลอดภัยในเธรดที่ไม่ซิงค์ การพยายามเขียนคุณสมบัตินี้อาจทำให้เกิดข้อผิดพลาด

สามารถเข้าถึงสมาชิกรายการนี้ได้ใน CoreScripts เท่านั้น

มีเพียง Roblox CoreScripts เท่านั้นที่สามารถเข้าถึงสมาชิกรายการนี้ได้ ซึ่ง Player จะไม่สามารถใช้ได้

อ่านและเขียนคุณสมบัตินี้ได้อย่างปลอดภัยจากหลายเธรด

Class นี้เป็นซิงเกิลตันระดับบนสุด ดึงอินสแตนซ์ Class นี้ด้วยฟังก์ชัน GetService

อาจมีหลายเธรดที่เขียนไปยังคุณสมบัตินี้ได้ จึงไม่ปลอดภัยที่จะอ่านจากเธรดที่ไม่ได้ซิงค์

ฟังก์ชันนี้จะหยุดเธรดภาษา Lua ที่เรียกใช้ชั่วคราวจนกว่าจะได้ผลลัพธ์ โดยการดำเนินการนี้จะไม่ขัดจังหวะสคริปต์อื่น

GameSettings

สรุป

คุณสมบัติ

วิธีการ

อีเวนต์

คุณสมบัติ

VideoCaptureEnabled

VideoRecording

วิธีการ

อีเวนต์