CoreGui

CoreGui.SelectionImageObject

CoreGui.Version

All GUIs returned by `Class.BasePlayerGui:GetGuiObjectsAtPosition()` are
'cloned' by the `highlightAsFrame()` local function, which creates a `Frame`
GUI positioned on top of the specified GUI that is semi-transparent and the
same `Class.GuiBase2d.AbsoluteSize` and `Class.GuiBase2d.AbsolutePosition`.

These highlights are added to the HighlightsContainer `ScreenGui` in the
Highlight folder of the player's PlayerGui folder. Both are created by the
code sample. All highlight GUIs are `Class.Instance:Destroy()`ed every time
`highlightGui()` executes.

Note that HighlightContainer's `Class.ScreenGui.DisplayOrder` is 99999, a
large number, so that it is unlikely any other GUI will render on top of the
highlight GUIs.


BasePlayerGui:GetGuiObjectsAtPosition

BasePlayerGui

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

CoreGui是Roblox为核心用户界面创建在游戏中的图形用户界面存储服务(例如游戏菜单、玩家列表、背包等)。它还可以被 `Class.Plugin|Plugins` 在Roblox Studio中使用。

Class.Actor 是一个可以安全分离为其自己线程的代码容器。

Class

Actor

Luau

Array

Dictionary

抽象类型的所有 2D 用户界面对象。

GuiObject

Data Type

RBXScriptSignal

Variant

bool

number

字母、数字和符号等的字符串。

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.

Beta 测试终点已准备好公开使用。可能出现导致功能无法正常运作的更改，但几率极低。

此字段可能在创建资源时被设置，但可能无法在后续请求中修改。

此字段可以在请求中提供，但永远不会包括在答复中。

每个 API 密钥：每个 IP 地址每 {periodInSeconds} 秒有 {maxInPeriod} 次请求

此字段可能被设置为响应，但在请求中将被忽略。

调用此端点需要以下 API 密钥权限。关于生成正确密钥的更多信息，请查看 【管理 API 密钥】({apiKeyReferenceDocLink})。

相对于基础 URL 的路径，下列端点是可用的。

此字符串格式为 [FieldMask](/cloud/reference/types#fieldmask)。

JSON 值可以是 “null”、“boolean”、“string”、“number”、“array” 或 “object”。

若要使用此端点，你的 OAuth 2.0 应用程序需要以下范围。关于如何注册 OAuth 2.0 应用程序的更多信息，请查看【应用程序注册及评价】({oauth2ReferenceDocLink})。

下列对象描述了接受或返回的有效载荷。请参阅每个单独的端点，以了解更多关于这些对象用途的信息。

这将允许查看关于你素材的信息。

这将允许在 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 you to manage group join requests for your account.

这将允许查看你的道具栏信息。

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 permission to read group 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 allows sending notifications from your experience to users.

这将允许列出与你的作品相关联的密钥。

这将允许创作和更新与你的作品相关联的密钥。

Grants access to read about your subscription products.

Grants the ability to read place information.

Grants the ability to edit place information.

此操作将会允许发布作品的新版本至 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.

默认值：{defaultValueStart}{defaultValueEnd}

数组是一个有序的数值列表。数组有助于存储数据集。

一组键值对，键值可以是任意数字、字符串或对象。

正如{tuples}一样，是一系列的值。

此函数将在可能是立即返回，但在返回值之前可以暂停调用自己的线程。

Roblox 已不再支持或维护{nameStart}名称{nameEnd}。

Roblox 已不再支持或维护这项数学运算。

此成员未在对象浏览器中出现，不应广泛使用。

此成员只能通过命令行访问。从脚本尝试访问此成员将导致错误。

此函数无法暂停调用自己的 Lua 线程。

从脚本尝试访问此成员将导致错误。你可能可以从 Roblox Studio 的属性窗口访问。

此成员不在 Roblox Studio 的对象浏览器中。

你无法使用 Instance.new 构造器创建此类别的实例。

Roblox 不会在跨服务器与客户机界限而复制此成员。

Lua 编程码无法访问此成员。你可能可以从 Roblox Studio 的属性窗口更改其值。

此会员可以从 OpenCloud Luau 执行任务访问。

此对象的复制行为取决于拥有它的玩家。

此成员可以通过命令行和插件访问。从脚本尝试访问此成员将导致错误。

此成员为只读。尝试写入此成员将会导致错误。

此属性为只读，可以从未同步的线程读取。尝试写入可能会导致错误。

只有 Roblox CoreScript 可以访问此成员，Players 不可用。

你可以安全地从多线程对此属性进行读写。

此类别为顶级类单例。使用 GetService 函数获取此类别的实例。

多线程可以写入此属性，所以从未同步的线程读取将会有风险。

此函数在返回借过前将会暂停调用自己的的线程。此操作不会中断其他脚本。

CoreGui

概要

属性

方法

活动

属性

SelectionImageObject

Version

方法

活动