BaseScript

BaseScript.Disabled

BaseScript.Enabled

BaseScript.LinkedSource

BaseScript.RunContext

LuaSourceContainer

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

Podstawowa klasa dla wszystkich obiektów skryptowych, które działają automatycznie.

Class.Actor jest kontenerem na kod, który można bezpiecznie podzielić na jego własny wątek.

Class

Actor

Luau

Array

Dictionary

Data Type

Obiekt, który wykonuje powiązane funkcje w określonym przypadku.

RBXScriptSignal

Enum

Enum.RunContext

Variant

Typ danych, który ma wartość prawdziwą lub fałszywą.

bool

Podwójna precyzyjna liczba punktów płynących.

number

Sekwencja znaków, takich jak litery, numery i symbole.

string

void

Omówienie

Przewodniki

Samouczki

Materiały referencyjne

Zasoby

Grafika

Projektowanie

Silnik

Awatar

Starsze

Chmura

Jest to metoda asynchroniczna, która zwraca deskryptor „Operation”, odpowiadający bieżącemu stanowi operacji. Zawiera punkt końcowy, który można wybrać przy użyciu funkcji poll, aby otrzymać rzeczywistą odpowiedź i nadające się do użycia metadane. Więcej informacji na temat operacji długotrwałych zawiera [dokumentacja]({longRunningOperationsLink}).
            
W poniższych sekcjach opisano odpowiedzi i obiekty w postaci metadanych, które zostają podane po ukończeniu operacji.

Punkty końcowe beta są gotowe do użytku publicznego. Zmiany wywołujące przerwy są możliwe, ale rzadkie.

To pole może być skonfigurowane podczas tworzenia zasobu, ale może nie być modyfikowane przez kolejne żądania.

To pole może być podane w żądaniach, ale nigdy nie będzie uwzględniane w odpowiedziach.

Na klucz API: żądanie {maxInPeriod} co {periodInSeconds} s na adres IP

To pole może być skonfigurowane do użycia w odpowiedziach, ale będzie ignorowane w żądaniach.

Do wywołania tego punktu końcowego wymagane są następujące uprawnienia do kluczy API. Więcej
informacji na temat generowania odpowiednich kluczy można znaleźć w obszarze [Zarządzanie kluczami API]({apiKeyReferenceDocLink}).

Następujące punkty końcowe są dostępne za pośrednictwem ścieżek odnoszących się do podstawowego adresu URL.

Ten ciąg jest sformatowany jako [FieldMask](/cloud/reference/types#fieldmask).

Wartość JSON może być typu „null”, „boolean”, „string”, „number”, „array” lub „object”.

Do umożliwienia aplikacji OAuth 2.0 użycia tego punktu końcowego wymagane są następujące zakresy. Więcej informacji na temat rejestrowania aplikacji OAuth 2.0 można znaleźć w obszarze [Rejestracja i omówienie aplikacji]({oauth2ReferenceDocLink}).

Następujące obiekty opisują ładunki, które są przyjmowane lub zwracane. Więcej informacji na temat tego, kiedy te obiekty są w użyciu, można znaleźć w poszczególnych punktach końcowych.

Ten ciąg jest sformatowany jako [Timestamp](/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 and role updates 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.

Wartość domyślna: {defaultValueStart}{defaultValueEnd}

Tablica to uporządkowana lista wartości. Tablice są używane do przechowywania zbiorów danych.

Zestaw par klucz-wartość, w których klucz może być dowolną liczbą, ciągiem lub obiektem.

Jeśli to możliwe ta funkcja zwraca wartość natychmiast, ale jako wynik może podawać wątek, który ją wywołał, do momentu zwrócenia wartości.

{nameStart}nazwa{nameEnd} nie jest już obsługiwana ani utrzymywana na platformie Roblox.

To działanie matematyczne nie jest już obsługiwane ani utrzymywane na platformie Roblox.

Ten członek nie jest widoczny w wyszukiwarce obiektów i nie jest przeznaczony do powszechnego użycia.

Ten członek jest dostępny tylko za pośrednictwem paska poleceń. Próba uzyskania dostępu do tego członka poprzez skrypty powoduje wystąpienie błędu.

Ta funkcja nie może wstrzymać wątku Lua, który ją wywołał.

Próba uzyskania dostępu do tego członka poprzez skrypty powoduje wystąpienie błędu. Możesz spróbować uzyskać dostęp do tego członka poprzez okno właściwości aplikacji Roblox Studio.

Ten członek nie jest widoczny w przeglądarce obiektów w aplikacji Roblox Studio.

Nie możesz utworzyć instancji tej klasy, używając polecenia Instance.new constructor.

Platforma Roblox nie replikuje tego członka poza jego granicę serwer-klient.

Kod Lua nie może uzyskać dostępu do tego członka. Możliwe, że uda ci się zmienić jego wartość w oknie właściwości w aplikacji Roblox Studio.

Ten członek jest dostępny z poziomu zadań środowiska wykonawczego OpenCloud Luau.

Zachowanie replikacyjne tego obiektu jest zależne od gracza, który jest jego właścicielem.

Ten członek jest dostępny za pośrednictwem paska poleceń i dodatków plug-in. Próba uzyskania dostępu do tego członka poprzez skrypty powoduje wystąpienie błędu.

Członek tylko do odczyty. Próba zapisu związana z tym członkiem powoduje wystąpienie błędu.

Ta właściwość jest tylko do odczytu i można ją bezpiecznie odczytywać w niezsynchronizowanych wątkach. Próba jej zapisania powoduje wystąpienie błędu.

Ten członek jest dostępny tylko w ramach skryptów CoreScript.

Tylko skrypty Roblox CoreScript mogą mieć dostęp do tego członka i nie może być używany przez graczy.

Tę właściwość można bezpiecznie odczytywać i zapisywać w ramach wielu wątków.

Ta klasa to przypadek wyjątkowy najwyższego poziomu. Pobierz instancję tej klasy przy użyciu funkcji GetService.

Większa liczba wątków może spowodować zapisanie w tej właściwości, a zatem odczytywanie niezsynchronizowanych wątków może być niebezpieczne.

Ta funkcja wstrzymuje wątek Lua, który ją wywołał, do momentu zwrócenia wyniku. Nie powoduje to przerwania działania innych skryptów.

BaseScript

Podsumowanie

Właściwości

Metody

Zdarzenia

Właściwości

Disabled

Enabled

RunContext

Metody

Zdarzenia