Ir al contenido

Referencia de API

El plugin tiene dos lados. El lado de Studio (cada capítulo hasta esta sección) es para crear efectos — el panel de propiedades, los gráficos, el Inventario, el Toolbench. El lado de tiempo de ejecución, documentado aquí, es para disparar esos efectos desde los scripts de tu juego.

Cuando transformas un elemento en Studio, el plugin guarda la instancia transformada en tu archivo de lugar. El módulo de tiempo de ejecución se guarda junto a él — normalmente en ReplicatedStorage (colocado automáticamente cuando se abre el panel de Emit Code) o en workspace (colocado por el botón Insert Module del QMenu). En tiempo de ejecución, tus scripts requieren el módulo, activan el motor y llaman a los métodos de emisión sobre los elementos transformados en los que el jugador debería ver efectos.

El atajo de un solo método. La mayoría del código de juego solo necesita tres líneas: require el módulo, llama a :Activate() una vez al inicio del juego, luego llama a Part_Icles:AbsoluteEmit(item) cada vez que deba dispararse un VFX. :AbsoluteEmit acepta cualquier instancia — un único Part transformado, una Folder llena de emisores transformados y nativos mezclados, un rig de Model completo, incluso workspace — y dispara cada emisor que contiene el subárbol usando la sincronización creada para cada uno. El resto de esta sección documenta los métodos de control de precisión a los que puedes graduarte cuando superes la simplicidad de disparar-todo; el capítulo Emission cubre :AbsoluteEmit en su totalidad.

Esta sección cubre la API de tiempo de ejecución completa. Aproximadamente 30 métodos públicos, agrupados por propósito:

CapítuloMétodos cubiertos
Getting StartedDónde vive el módulo en tu lugar, el patrón require, tu primera emisión.
Lifecycle:Activate, :Deactivate, :GetFolder.
EmissionLos seis despachadores de nivel superior: :Emit, :EmitAnimate, :Enable, :EnableEmit, :Disable, :AbsoluteEmit.
Per-type MethodsLos 10 métodos de emisión por tipo + 9 métodos de modo Animate por tipo + :Transform/:TransformModel.
Texture Pinning:Preload, :Deload para mantener los bytes de activos residentes.
ExamplesCuatro patrones trabajados: chispa de espada, clon de bola de fuego, emisión solo en pantalla, :AbsoluteEmit recursivo.

En Studio, el plugin gestiona automáticamente su propio tiempo de ejecución — hacer clic en el botón de la barra de herramientas activa el motor, cerrarlo lo desactiva. La creación es en vivo, las partículas de prueba se emiten, ves el efecto de inmediato.

En un juego publicado, el plugin no está en ejecución. Solo están presentes las instancias transformadas que guardó en tu lugar, más el módulo de tiempo de ejecución. Tus scripts tienen que llamar a :Activate() por sí mismos al inicio del juego, luego llamar a los métodos de emisión cuando el jugador desencadena una acción. La UI del plugin no existe fuera de Studio — solo existen los datos y el tiempo de ejecución.

Esta es una separación normal para los plugins de Roblox. El plugin crea contenido en Studio; tus scripts usan el contenido en tiempo de ejecución. El tiempo de ejecución es pequeño (un bucle Heartbeat + lógica de emisión/actualización por tipo), y :Activate() solo necesita llamarse una vez por sesión de juego.

Si nunca has usado la API de tiempo de ejecución: lee de arriba a abajo. Los capítulos están ordenados para ir construyendo.

Si estás buscando un método específico: ve directamente al capítulo que lo contiene. Cada método tiene su propia sección con firma, semántica y ejemplo.

Si quieres un punto de partida con ejemplos trabajados: empieza por Examples y complementa los capítulos de la API desde los enlaces cruzados que contiene.

Getting Started es el siguiente capítulo — dónde se coloca el módulo de tiempo de ejecución en tu juego, cómo requerirlo y tu primera llamada de emisión.