Entities
Una entity es un objeto que es persistente en una escena (ej., nodos, assets) o a través de escenas (ej., plugins). La programación en Warudo se trata completamente de definir tus propios tipos de entity e interactuar con el runtime de Warudo. Puedes definir tu propio tipo de entity heredando de una clase base proporcionada por Warudo:
- Node: Hereda de
Nodepara crear un nuevo tipo de nodo. Un tipo de nodo puede definir data inputs, data outputs, flow inputs, flow outputs, y triggers. Un nodo es instanciado arrastrándolo desde la paleta de nodos al editor de blueprint; la instancia del nodo se guarda junto con el blueprint. - Asset: Hereda de
Assetpara crear un nuevo tipo de asset. Un tipo de asset puede definir data inputs y triggers. Un asset es instanciado usando el menú Add Asset; la instancia del asset se guarda junto con la escena. - Plugin: Hereda de
Pluginpara crear un nuevo tipo de plugin. Un tipo de plugin puede definir data inputs y triggers. Un plugin es cargado cuando Warudo inicia, o cuando el plugin es recargado en caliente. Solo hay una instancia de plugin por tipo de plugin, y los data inputs se guardan a través de escenas. - Structured Data: Hereda de
StructuredDatapara crear un nuevo tipo de structured data. Structured data es un tipo de datos complejo que puede ser usado como un data input "embebido" en nodos, assets, o plugins.
En el tutorial Creating Your First Script, creamos un tipo de nodo personalizado llamado HelloWorldNode y un tipo de asset personalizado llamado CookieClickerAsset.
El concepto de entities es vagamente similar al MonoBehaviour de Unity, pero con un enfoque más estructurado.
Después de que una entity es instanciada, se le asigna automáticamente un UUID (identificador único) por Warudo. Puedes acceder a él vía la propiedad Id. Este UUID es entonces usado para identificar la entity en la escena, y se guarda junto con la escena.
Un tipo de entity puede contener campos y métodos regulares de C#. Sin embargo, para interfaz con el runtime de Warudo, necesitas crear ports y triggers en la entity. Todas las entities pueden tener data input ports y triggers, mientras que los nodos pueden adicionalmente tener data output ports, flow input ports, y flow output ports.
Ciclo de Vida
Una entity tiene un ciclo de vida que consiste en varias etapas:
OnCreate(): Llamado cuando la entity es creada. Aquí es donde debes inicializar los campos de instancia, suscribirte a eventos, etc.- Assets: Llamado cuando un nuevo asset es agregado a la escena por el usuario, o cuando la escena es cargada.
- Nodes: Llamado cuando un nuevo nodo es agregado al blueprint por el usuario, o cuando la escena es cargada. Los nodos siempre son creados después de los assets.
- Plugins: Llamado cuando el plugin es cargado por Warudo al inicio, o cuando el plugin es recargado en caliente.
- Structured Data: Llamado cuando la entity padre es creada, o cuando el usuario agrega un nuevo structured data a un array de structured data.
OnDestroy(): Llamado cuando la entity es destruida. Aquí es donde debes liberar recursos, etc.- Assets: Llamado cuando el asset es removido de la escena por el usuario, o cuando la escena es descargada.
- Nodes: Llamado cuando el nodo es removido del blueprint por el usuario, o cuando la escena es descargada. Los nodos siempre son destruidos después de los assets.
Deserialize(TSerialized data): Llamado cuando la entity es deserializada desde un estado guardado. Por ejemplo, este método es llamado en un asset cuando la escena es apenas abierta y cargada. Usualmente no necesitas sobrescribir este método.Serialize(): Llamado cuando la entity necesita ser serializada a un estado guardado. Por ejemplo, este método es llamado en un asset cuando la escena está a punto de ser guardada, o necesita ser enviada al editor. Usualmente no necesitas sobrescribir este método.
Assets, nodos, y plugins tienen etapas extras del ciclo de vida:
OnUpdate(): Llamado cada frame cuando la entity no está destruida. Esto es similar al métodoUpdate()de Unity.OnPreUpdate()yOnPostUpdate()también se proporcionan. Son llamados antes y después deOnUpdate(), respectivamente.
OnLateUpdate(): Llamado cada frame después deOnUpdate(). Esto es similar al métodoLateUpdate()de Unity.OnFixedUpdate(): Llamado cada frame fijo. Esto es similar al métodoFixedUpdate()de Unity.OnEndOfFrame(): Llamado al final del frame. Esto es similar a usar laWaitForEndOfFramecoroutine de Unity.OnDrawGizmos(): Llamado cuando la entity debe dibujar gizmos. Esto es similar al métodoOnDrawGizmos()de Unity.
El orden de actualización es el siguiente: plugins → assets → nodos.
Puedes sobrescribir estos métodos del ciclo de vida para implementar comportamiento personalizado para tus entities. Por ejemplo, si quieres ejecutar algo en cada frame, sobrescribe el método OnUpdate().