CustomEvent.ReceiverConnected

receiver

CustomEvent.ReceiverDisconnected

CustomEvent:GetAttachedReceivers

CustomEvent:SetValue

newValue

CustomEvent

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

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

Tipo de datos con un valor de verdadero o falso.

bool

Un número de punto flotante de doble precisión.

number

Una secuencia de caracteres, como letras, números y símbolos.

string

void

Vista general

Guías

Tutoriales

Referencia

Recursos

Arte

Diseño

Motor

Avatar

Legacy

Nube

Los puntos finales beta están listos para uso público. Los cambios que los puedan estropear son posibles, pero poco frecuentes.

Este campo se puede establecer al crear un recurso, pero no se puede modificar por solicitudes posteriores.

Este campo se puede proporcionar en las solicitudes, pero nunca se incluirá en las respuestas.

Por clave API: {maxInPeriod} solicitudes cada {periodInSeconds} segundos por dirección IP

Este campo se puede configurar como respuestas, pero se ignorará en las solicitudes.

Se requieren los siguientes permisos de clave API para llamar a este extremo. Para obtener más información sobre cómo generar claves adecuadas, consulta [Gestionar claves API]({apiKeyReferenceDocLink}).

Los siguientes extremos están disponibles en rutas relativas a la URL base.

Esta cadena está formateada como [Timestamp](/cloud/reference/types#timestamp).

Un valor JSON puede ser `null`, `boolean`, `string`, `number`, `array`, u `object`.

Los siguientes ámbitos son necesarios para que tu aplicación OAuth 2.0 use este extremo. Para obtener más información sobre cómo registrar una aplicación de OAuth 2.0, consulta [Registro y revisión de aplicaciones]({oauth2ReferenceDocLink}).

Los siguientes objetos describen cargas que son aceptadas o devueltas. Ve cada extremo para más información sobre cuándo se utilizan estos objetos.

Esto permite ver información sobre tus recursos.

Esto permite cargar y actualizar recursos a Roblox.

Permite actualizar las insignias de propiedad del usuario.

Esto permite ver información sobre tus objetos de comercio.

Esto te permite editar tus conexiones de comerciantes.

Esto te permite ver información sobre tus productos de la Tienda de creadores.

Esto te permite modificar la información sobre tus productos de la Tienda de creadores.

Esto permite ver información sobre tus grupos.

Esto te permite gestionar las solicitudes de unión a grupo para tu cuenta.

Esto permite ver información sobre tu inventario.

Da acceso para administrar tus insignias.

Da acceso para administrar tus productos de desarrollador.

Da acceso para leer la información sobre las experiencias que sigues.

Da acceso para seguir y dejar de seguir experiencias en tu nombre.

Da permiso para leer información del grupo.

Da acceso para leer y escribir tus tablas de localización

Da acceso para gestionar la colaboración en equipo para todas las experiencias de tu propiedad.

Da acceso para gestionar tus experiencias y cierta información asociada a tus experiencias (por ejemplo, información de localización).

Da acceso para leer la información de localización de tus experiencias.

Da acceso para modificar las preferencias de localización de las experiencias.

Da acceso para gestionar tu cuenta de usuario.

Da acceso para modificar las preferencias de localización de usuario.

Esta acción permite publicar mensajes en nombre de los usuarios.

Esto permite enviar notificaciones de tu experiencia a los usuarios.

Esto permite enumerar los secretos asociados a tu experiencia.

Esto permite crear y actualizar secretos asociados a tu experiencia.

Da acceso para leer los productos de tu suscripción.

Permite leer información sobre el lugar.

Permite editar información sobre el lugar.

Esta operación permite el acceso a la publicación de nuevas versiones de experiencias en Roblox.

Permite leer información sobre la experiencia.

Permite editar información sobre la experiencia.

Te permite ver las restricciones de usuario en la experiencia.

Te permite editar las restricciones de usuario en la experiencia.

Permite leer el estado Premium y verificado del usuario.

Esto te permite ver las cuentas sociales de un usuario.

Activa la funcionalidad de inicio de sesión único.

Permite leer la información de tu perfil.

Valor predeterminado: {defaultValueStart}{defaultValueEnd}

Una matriz es una lista ordenada de valores. Las matrices son útiles para almacenar colecciones de datos.

Un conjunto de pares clave-valor, donde las claves pueden ser cualquier número, cadena u objeto.

Esta función devuelve inmediatamente si es posible, pero puede producir el hilo que la llamó hasta que devuelva un valor.

Roblox ya no soporta o mantiene {nameStart}nombre{nameEnd}

Esta operación matemática ya no es soportada o mantenida por Roblox.

Este miembro no aparece en el navegador de objetos y no está destinado a un uso generalizado.

Solo se puede acceder a este miembro a través de la barra de comandos y de los plugins. Se producirá un error si se intenta acceder a través de los scripts.

Esta función no puede pausar el hilo de Lua que la llamó.

Se producirá un error al intentar acceder a este miembro a través de los scripts. Es posible acceder a él desde la ventana de propiedades de Roblox Studio.

Este miembro no aparece en el navegador de objetos de Roblox Studio.

No se puede crear una instancia de esta clase con el constructor Instance.new.

Roblox no replica este miembro a través de su límite entre servidor y cliente.

El código Lua no puede acceder a este miembro. Puedes cambiar su valor desde la ventana de propiedades en Roblox Studio.

Este miembro es accesible desde las tareas de ejecución de OpenCloud Luau.

El comportamiento de replicación de este objeto depende del jugador que lo posee.

Este miembro es accesible a través de la barra de comandos y de los plugins. Se producirá un error si se intenta acceder a través de los scripts.

Este miembro es de solo lectura. Se producirá un error al intentar escribir a este miembro.

Esta propiedad es de solo lectura y es segura para leer en hilos no sincronizados. Escribir en ella producirá un error.

Esta propiedad es de solo lectura y es seguro leerla en hilos no sincronizados. Se producirá un error al intentar escribir en ella.

Se puede acceder a este miembro solo en CoreScripts.

Solo Roblox CoreScripts puede acceder a este miembro y no se puede utilizar por los Jugadores.

Puedes leer y escribir en esta propiedad de forma segura desde múltiples hilos.

Esta clase es un singleton de nivel superior. Recupera una instancia de esta clase con la función GetService.

Múltiples hilos pueden escribir en esta propiedad, por lo que no es seguro leerla desde hilos no sincronizados.

Esta función pausa el hilo Lua que la llamó hasta que devuelva un resultado. Esta acción no interrumpe otros scripts.

CustomEvent

Resumen

Propiedades

Métodos

Eventos

Propiedades

Métodos

GetAttachedReceivers

Devuelve

SetValue

Parámetros

Devuelve

Eventos

ReceiverConnected

Parámetros

ReceiverDisconnected

Parámetros