Last updated
Last updated
Si eres nuevo en scripting, te recomendamos encarecidamente leer primero las siguientes guías:
Si sabes lo que estás haciendo, siéntete libre de ir directamente a la .
El código en tiempo de ejecución para Needle Engine está escrito en (recomendado) o . Generamos automáticamente componentes stub C# a partir de eso, que puedes añadir a GameObjects en el editor. Los componentes C# y sus datos son recreados por el tiempo de ejecución como componentes JavaScript con los mismos datos y adjuntados a objetos three.js.
Tanto los componentes personalizados como los componentes integrados de Unity pueden mapearse a componentes JavaScript de esta manera. Por ejemplo, las asignaciones para muchos componentes integrados relacionados con animación, renderizado o física ya están .
Si deseas seguir los siguientes ejemplos sin tener que instalar nada, simplemente haz clic en el siguiente enlace:
.
Nuestro motor de tiempo de ejecución web adopta un modelo de componentes similar a Unity y, por lo tanto, proporciona mucha funcionalidad que resultará familiar.
Los componentes adjuntos a los objetos Object3D de three tienen métodos de ciclo de vida como awake
, start
, onEnable
, onDisable
, update
y lateUpdate
que puedes implementar. También puedes usar .
A menudo, las escenas interactivas se pueden realizar utilizando Events en Unity y llamando a métodos en componentes integrados. Un ejemplo típico es reproducir una animación al hacer clic en un botón: creas un botón, añades un evento Click en el inspector y haces que llame a Animator.SetTrigger o similar para reproducir una animación específica.
Needle Engine traduce Unity Events en llamadas a métodos JavaScript, lo que hace que este flujo de trabajo sea muy rápido y flexible: configura tus eventos como de costumbre y, cuando se activen, funcionarán igual que en Unity.
Un ejemplo de un Button Click Event que funciona de inmediato en Needle Engine — no se necesita código.
Los scripts se escriben en TypeScript (recomendado) o JavaScript. Hay dos formas de añadir scripts personalizados a tu proyecto:
Simplemente añade un archivo con extensión .ts
o .js
dentro de src/scripts/
en el directorio de tu proyecto generado, por ejemplo src/scripts/MyFirstScript.ts
En ambos enfoques, los directorios de origen son vigilados para detectar cambios y los componentes stub C# o paneles de Blender se regeneran cada vez que se detecta un cambio. Los cambios en los archivos de origen también resultan en una recarga en caliente del sitio web en ejecución – no tienes que esperar a que Unity recompile los componentes C#. Esto hace que iterar sobre el código sea prácticamente instantáneo.
Incluso puedes tener múltiples tipos de componentes dentro de un mismo archivo (por ejemplo, puedes declarar export class MyComponent1
y export class MyOtherComponent
en el mismo archivo Typescript).
:::details Ejemplo: Crear un Componente que rota un objeto
Crear un componente que rota un objeto
Crea src/scripts/Rotate.ts
y añade el siguiente código:
Ahora, dentro de Unity, se generará automáticamente un nuevo script llamado Rotate.cs
. Añade el nuevo componente de Unity a un Cube y guarda la escena.
El cubo ahora está rotando dentro del navegador.
Abre la consola del desarrollador de chrome presionando F12
para inspeccionar el registro del método Rotate.start
. Esta es una práctica útil para aprender y depurar qué campos se exportan y se asignan actualmente. En general, se exportan todos los campos públicos y serializables y todas las propiedades públicas.
Ahora añade un nuevo campo public float speed = 5
a tu componente de Unity y guárdalo. El inspector del componente Rotate ahora muestra un campo speed
que puedes editar. Guarda la escena (o haz clic en el botón Build
) y observa que el componente javascript ahora tiene el valor speed
exportado asignado.
:::
:::
:::details Control de Versiones y Unity Aunque los componentes C# generados utilizan el nombre del tipo para producir GUIDs estables, recomendamos incluir los componentes generados en el control de versiones como una buena práctica. :::
Los componentes se añaden a los Object3Ds
de three.js. Esto es similar a cómo se añaden los Componentes en Unity a los GameObjects
. Por lo tanto, cuando queremos acceder a un Object3D de three.js, podemos acceder a él como this.gameObject
, que devuelve el Object3D
al que está adjunto el componente.
Nota: Establecer visible
en falso en un Object3D actuará como SetActive(false)
en Unity, lo que significa que también deshabilitará todos los componentes actuales en este objeto y sus hijos. Los eventos de actualización para componentes inactivos no se llaman hasta que visible
se establece nuevamente en verdadero. Si quieres ocultar un objeto sin afectar a los componentes, simplemente puedes deshabilitar el componente Renderer
de Needle Engine.
Ten en cuenta que los métodos del ciclo de vida solo se llaman cuando se declaran. Por lo tanto, solo declara los métodos del ciclo de vida update
cuando sean realmente necesarios, de lo contrario, puede perjudicar el rendimiento si tienes muchos componentes con bucles de actualización que no hacen nada.
requiere Needle Engine >= 3.32.0
Eventos XR adicionales
Ejemplo
Para detener una coroutine, sal de la rutina retornando de ella, o guarda en caché el valor de retorno de startCoroutine
y llama a this.stopCoroutine(<...>)
. Todas las Coroutines se detienen en onDisable
/ al deshabilitar un componente.
Needle Engine también expone algunos hooks del ciclo de vida que puedes usar para engancharte al bucle de actualización sin tener que escribir un componente completo. Estos hooks pueden insertarse en cualquier punto de tu aplicación web (por ejemplo, en el ámbito de nivel superior o en un componente svelte)
Para acceder a otros componentes, utiliza los métodos estáticos en GameObject
o los métodos this.gameObject
. Por ejemplo, para acceder a un componente Renderer
en el padre, utiliza GameObject.getComponentInParent(this.gameObject, Renderer)
o this.gameObject.getComponentInParent(Renderer)
.
Ejemplo:
Esta arquitectura permite tener potencialmente múltiples escenas WebGL de Needle en la misma página web, que pueden ejecutarse por sí solas o comunicarse entre sí como partes de tu página web.
Para acceder a la escena actual desde un componente, utilizas this.scene
, que es equivalente a this.context.scene
; esto te da el objeto raíz de la escena de three.js.
Para recorrer la jerarquía desde un componente, puedes iterar sobre los hijos de un objeto con un bucle for:
o puedes iterar usando el equivalente a foreach
:
Otra opción que es bastante útil cuando solo quieres iterar objetos que son renderizables es consultar todos los componentes renderer e iterar sobre ellos de la siguiente manera:
Para más información sobre cómo obtener componentes, consulta la siguiente sección.
Usa this.context.time
para acceder a los datos de tiempo:
this.context.time.time
es el tiempo transcurrido desde que la aplicación comenzó a ejecutarse
this.context.time.deltaTime
es el tiempo que ha pasado desde el último frame
this.context.time.frameCount
es el número de frames que han pasado desde que la aplicación comenzó
this.context.time.realtimeSinceStartup
es el tiempo sin escalar desde que la aplicación comenzó a ejecutarse
También es posible usar this.context.time.timeScale
para ralentizar deliberadamente el tiempo para efectos de cámara lenta, por ejemplo.
Recibe datos de entrada para el objeto en el que se encuentra el componente:
También puedes suscribirte a eventos globales en la enumeración InputEvents
de la siguiente manera:
O usa this.context.input
si quieres sondear el estado de entrada en cada frame:
Ten en cuenta que en este caso tienes que manejar todos los casos tú mismo. Por ejemplo, es posible que necesites usar diferentes eventos si tu usuario está visitando tu sitio web en un escritorio, móvil o un dispositivo VR. Needle Engine maneja automáticamente estos casos con los eventos de entrada (por ejemplo, PointerDown
se dispara tanto para el clic del ratón, el toque en pantalla y, en el caso de VR, al presionar un botón del controlador).
Utiliza this.context.physics.raycast()
para realizar un raycast y obtener una lista de intersecciones. Si no pasas ninguna opción, el raycast se realiza desde la posición del ratón (o la primera posición táctil) en espacio de pantalla utilizando la mainCamera
actualmente activa. También puedes pasar un objeto RaycastOptions
que tiene varias configuraciones como maxDistance
, la cámara a usar o las capas contra las que se debe probar.
Nota: Este tipo de raycast lanza un rayo contra todos los objetos visibles en la escena. No se necesita un motor de física, lo cual es diferente al comportamiento en Unity, donde siempre necesitas colliders para golpear objetos. Si quieres lanzar solo contra colliders de física, utiliza los métodos
physics.engine.raycast
descritos a continuación.
Consideraciones de rendimiento
Cuando se utilizan las configuraciones de compresión predeterminadas de Needle, se crean y utilizan automáticamente versiones simplificadas de las mallas para el raycasting también. Aun así, algunos tipos de mallas son lentas; por ejemplo, las mallas con skinning o las mallas con blendshapes requieren cálculos costosos para determinar los hits exactos. Considera establecer esos objetos en la capa Ignore Raycast
en Unity para evitar el raycasting contra ellos.
Raycasting basado en física
Otra opción es utilizar los métodos de raycast de física que solo devolverán hits con colliders en la escena.
Es posible acceder a toda la funcionalidad descrita anteriormente utilizando código JavaScript regular que no esté dentro de los componentes y que se encuentre en otro lugar. Todos los componentes y la funcionalidad del tiempo de ejecución de Needle son accesibles a través del namespace global Needle
(puedes escribir console.log(Needle)
para obtener una visión general)
Para obtener callbacks para la carga inicial de la escena, consulta el siguiente ejemplo:
También puedes suscribirte al NeedleEngine
global (a veces también conocido como ContextRegistry) para recibir un callback cuando se haya creado un contexto de Needle Engine o para acceder a todos los contextos disponibles:
También puedes acceder a todos los contextos disponibles a través de NeedleEngine.Registered
, que devuelve el array interno. (Ten en cuenta que este array no debe modificarse, pero se puede usar para iterar sobre todos los contextos activos para modificar configuraciones, por ejemplo, establecer todos los contextos en context.isPaused = true
)
A continuación, encontrarás una lista de eventos disponibles en el tipo estático NeedleEngine
.
Puedes suscribirte a estos eventos a través de NeedleEngine.registerCallback(ContextEvent.ContextCreated, (args) => {})
La clase estática Gizmos
se puede usar para dibujar líneas, formas y texto, lo cual es principalmente útil para la depuración.
Todas las funciones de Gizmos tienen múltiples opciones para, por ejemplo, colores o por cuánto tiempo deben mostrarse en la escena. Internamente se almacenan en caché y se reutilizan.
Para incrustar componentes y recrear componentes con sus tipos correctos en glTF, también necesitamos guardar tipos no primitivos (todo lo que no sea un Number
, Boolean
o String
). Puedes hacerlo añadiendo un decorador @serializable(<type>)
encima de tu campo o propiedad.
Para serializar desde y hacia formatos personalizados, es posible extender la clase TypeSerializer
y crear una instancia. Usa super()
en el constructor para registrar los tipos soportados.
Nota: Además de los campos que coinciden, las propiedades que coinciden también se exportarán cuando coincidan con campos en el archivo typescript.
Estos archivos glTF exportados se serializarán como URIs de cadena plana. Para simplificar la carga de estos desde componentes TypeScript, añadimos el concepto de tipos AssetReference
. Se pueden cargar en tiempo de ejecución y, por lo tanto, permiten diferir la carga de partes de tu aplicación o cargar contenido externo.
Los AssetReferences se almacenan en caché por URI, por lo que si referencias el mismo glTF/Prefab exportado en múltiples componentes/scripts, solo se cargará una vez y luego se reutilizará.
Página traducida automáticamente usando IA
Específico de Unity:
Organiza tu código en NPM Definition Files (paquetes npm). Estos te ayudan a modularizar y reutilizar código entre proyectos y, si estás familiarizado con el desarrollo web, de hecho son paquetes npm regulares que se instalan localmente.
En Unity puedes crear archivos NpmDef a través de Create > NPM Definition
y luego añadir archivos TypeScript haciendo clic derecho en un archivo NpmDef y seleccionando Create > TypeScript
. Consulta para más información.
Si eres nuevo escribiendo Javascript o Typescript, te recomendamos leer primero la guía antes de continuar con esta guía.
:::details Crear componente con una función personalizada Consulta la para obtener más información sobre la sintaxis y el lenguaje.
Las Coroutines se pueden declarar utilizando la .
Para iniciar una coroutine, llama a this.startCoroutine(this.myRoutineName());
Por ejemplo ()
El contexto se refiere al tiempo de ejecución dentro de un .
La escena de three.js vive dentro de un componente HTML personalizado llamado <needle-engine>
(consulta el index.html en tu proyecto). Puedes acceder al web component <needle-engine>
utilizando this.context.domElement
.
También puedes usar métodos específicos de three.js para iterar rápidamente todos los objetos recursivamente usando el método :
o para recorrer solo objetos visibles, utiliza en su lugar.
Si quieres manejar las entradas tú mismo, también puedes suscribirte a (hay muchísimos). Por ejemplo, para suscribirte al evento click del navegador, puedes escribir:
Utiliza this.context.physics.raycastFromRay(your_ray)
para realizar un raycast utilizando un .
Aquí tienes un
Se puede acceder a los métodos de Networking a través de this.context.connection
. Consulta la para más información.
Puedes encontrar componentes utilizando Needle.findObjectOfType(Needle.AudioSource)
, por ejemplo. Se recomienda guardar en caché estas referencias, ya que buscar en toda la escena repetidamente es costoso. Consulta la lista para arriba.
Otra opción es usar el onInitialized(ctx => {})
Ejemplo: @
En Unity, los Prefabs, SceneAssets y AssetReferences (el sistema Addressable de Unity) referenciados se exportarán automáticamente como archivos glTF (consulta la documentación ).
Ejemplo: @
awake()
Primer método llamado cuando se crea un nuevo componente
onEnable()
Llamado cuando un componente está habilitado (por ejemplo, cuando enabled
cambia de falso a verdadero)
onDisable()
Llamado cuando un componente está deshabilitado (por ejemplo, cuando enabled
cambia de verdadero a falso)
onDestroy()
llamado cuando el Object3D o el componente está siendo destruido
start()
Llamado al inicio del primer frame después de que se creó el componente
earlyUpdate()
Primer evento de actualización
update()
Evento de actualización por defecto
lateUpdate()
Llamado después de update
onBeforeRender()
Último evento de actualización antes de la llamada de renderizado
onAfterRender()
Llamado después del evento de renderizado
onCollisionEnter(col : Collision)
onCollisionStay(col : Collision)
onCollisionExit(col : Collision)
onTriggerEnter(col : Collision)
onTriggerStay(col : Collision)
onTriggerExit(col : Collision)
onPointerEnter(args : PointerEventData)
Llamado cuando un cursor comienza a pasar sobre un objeto (o cualquiera de sus hijos)
onPointerMove(args : PointerEventData)
Llamado cuando un cursor se mueve sobre un objeto (o cualquiera de sus hijos)
onPointerExit(args : PointerEventData)
Llamado cuando un cursor sale (deja de pasar sobre) un objeto
onPointerDown(args : PointerEventData)
Llamado cuando se presiona un cursor sobre un objeto
onPointerUp(args : PointerEventData)
Llamado cuando se suelta un cursor sobre un objeto
onPointerClick(args : PointerEventData)
Llamado cuando se hace clic con un cursor sobre un objeto
supportsXR(mode: XRSessionMode)
Implementa opcionalmente si solo quieres recibir callbacks de XR para modos XR específicos como immersive-vr
o immersive-ar
. Retorna true
para notificar al sistema que quieres callbacks para el modo pasado
onBeforeXR(mode: XRSessionMode, init: XRSessionInit)
Llamado justo antes de que se solicite una XRSession y se puede usar para modificar el objeto XRSessionInit
onEnterXR(args: NeedleXREventArgs)
Callback cuando este componente se une a una sesión xr (o se activa en una sesión XR en ejecución)
onUpdateXR(args: NeedleXREventArgs)
Callback cuando una sesión xr se actualiza (mientras todavía está activa en la sesión XR)
onLeaveXR(args: NeedleXREventArgs)
Callback cuando este componente sale de una sesión xr (o cuando se vuelve inactivo en una sesión XR en ejecución)
onControllerAdded(args: NeedleXRControllerEventArgs)
Callback cuando se conecta/añade un controlador mientras está en una sesión XR O cuando el componente se une a una sesión XR en ejecución que ya tiene controladores conectados O cuando el componente se activa durante una sesión XR en ejecución que ya tiene controladores conectados
onControllerRemoved(args: NeedleXRControllerEventArgs)
Callback cuando se elimina un controlador mientras está en una sesión XR O cuando el componente se vuelve inactivo durante una sesión XR en ejecución
window.addEventListener("needle-xrsession-start")
CustomEvent que se invoca cuando comienza una XRSession. details
contiene la NeedleXRSession
window.addEventListener("needle-xrsession-end")
CustomEvent que se invoca cuando comienza una XRSession. details
contiene la NeedleXRSession
onXRSessionStart(args: { session:NeedleXRSession } )
Hook de evento global. Para desuscribirse, usa offXRSessionStart
onInitialized(cb, options)
Llamado cuando se inicializa un nuevo contexto (antes del primer frame)
onClear(cb, options)
Registra un callback antes de que se limpie el contexto del motor
onDestroy(cb, options)
Registra un callback en el motor antes de que se destruya el contexto
onStart(cb, options)
Llamado directamente después de que los componentes start
al principio de un frame
onUpdate(cb, options)
Llamado directamente después de que los componentes update
onBeforeRender(cb, options)
llamado antes de llamar a render
onAfterRender(cb, options)
llamado antes de llamar a render
GameObject.instantiate(Object3D, InstantiateOptions)
crea una nueva instancia de este objeto incluyendo nuevas instancias de todos sus componentes
GameObject.destroy(Object3D | Component)
destruye un componente o Object3D (y sus componentes)
GameObject.addNewComponent(Object3D, Type)
añade (y crea) un nuevo componente para un tipo al objeto proporcionado. Ten en cuenta que awake
y onEnable
ya se llaman cuando se devuelve el componente
GameObject.addComponent(Object3D, Component)
mueve una instancia de componente al objeto proporcionado. Es útil si ya tienes una instancia, por ejemplo, cuando creas un componente con new MyComponent()
y luego lo adjuntas a un objeto.
GameObject.removeComponent(Component)
elimina un componente de un gameObject
GameObject.getComponent(Object3D, Type)
devuelve el primer componente que coincide con un tipo en el objeto proporcionado.
GameObject.getComponents(Object3D, Type)
devuelve todos los componentes que coinciden con un tipo en el objeto proporcionado.
GameObject.getComponentInChildren
igual que getComponent
pero también busca en objetos hijos.
GameObject.getComponentsInChildren
igual que getComponents
pero también busca en objetos hijos.
GameObject.getComponentInParent
igual que getComponent
pero también busca en objetos padre.
GameObject.getComponentsInParent
igual que getComponents
pero también busca en objetos padre.
GameObject.findObjectOfType
busca en toda la escena un tipo.
GameObject.findObjectsOfType
busca en toda la escena todos los tipos que coinciden.
ContextEvent.ContextRegistered
Llamado cuando el contexto se registra en el registro.
ContextEvent.ContextCreationStart
Llamado antes de que se cargue el primer glb y se puede usar para inicializar el motor de física. Puede devolver una promesa
ContextEvent.ContextCreated
Llamado cuando el contexto ha sido creado antes del primer frame
ContextEvent.ContextDestroyed
Llamado cuando el contexto ha sido destruido
ContextEvent.MissingCamera
Llamado cuando el contexto no pudo encontrar una cámara, actualmente solo se llama durante la creación
ContextEvent.ContextClearing
Llamado cuando el contexto se está limpiando: todos los objetos en la escena se están destruyendo y el estado interno se restablece
ContextEvent.ContextCleared
Llamado después de que el contexto ha sido limpiado
Gizmos.DrawLabel
Dibuja una etiqueta con fondo opcionalmente. Puede adjuntarse a un objeto. Devuelve un identificador Label que se puede usar para actualizar el texto.
Gizmos.DrawRay
Toma un origen y una dirección en espacio de mundo para dibujar una línea de rayo infinita
Gizmos.DrawDirection
Toma un origen y una dirección para dibujar una dirección en espacio de mundo
Gizmos.DrawLine
Toma dos puntos vec3 en espacio de mundo para dibujar una línea
Gizmos.DrawWireSphere
Dibuja una esfera de estructura alámbrica en espacio de mundo
Gizmos.DrawSphere
Dibuja una esfera sólida en espacio de mundo
Gizmos.DrawWireBox
Dibuja una caja de estructura alámbrica en espacio de mundo
Gizmos.DrawWireBox3
Dibuja una box3 de estructura alámbrica
Gizmos.DrawArrow
Dibuja una flecha tomando dos puntos en espacio de mundo