Funciones de los componentes
Introducción
Los componentes pueden añadirse, modificarse y eliminarse en tiempo de ejecución. Los componentes integrados y los personalizados utilizan la misma interfaz para gestionar los datos de los componentes.
Referencia a un componente personalizado
El siguiente ejemplo muestra cómo compartir una referencia a un componente personalizado entre diferentes archivos de código.
Asegúrese de exportar el Componente antes de intentar importarlo o utilizarlo en cualquier sitio.
import * as ecs from '@8thwall/ecs'
const CustomComponent = ecs.registerComponent({
...
})
export {CustomComponent}
import * as ecs from '@8thwall/ecs'
import {CustomComponent} from './custom-component'
ecs.registerComponent({
name: 'Another Custom Component',
stateMachine: ({world, eid, schemaAttribute, dataAttribute}) => {
ecs.defineState('default')
.initial()
.onEnter(() => {
const entity = world.createEntity()
CustomComponent.set(world, entity, {
displayName: 'Jini'
})
})
},
})
Funciones
Las funciones de componente permiten realizar diferentes acciones sobre un componente y sus datos en relación con una entidad.
Get
Returns a read-only reference.
Example
ecs.CilindroGeometría.get(world, component.eid)
Set
Ensures the component exists on the entity, then assigns the (optional) data to the component.
Example
ecs.CilindroGeometría.set(world, component.eid, {
radius: 1,
height: 1
})
Mutate
Perform an update to the component within a callback function. Return true
to indicate no changes made.
Example
ecs.CilindroGeometría.mutate(world, component.eid, (cursor) => {
cursor.radius += 1;
cursor.height *= 2;
return false;
})
Remove
Removes the component from the entity.
Example
ecs.CilindroGeometría.remove(world, component.eid)
Has
Returns true
if the component is present on the entity.
Example
ecs.CilindroGeometría.has(world, component.eid)
Reset
Adds, or resets the component to its default state.
Example
ecs.CilindroGeometría.reset(world, component.eid)
Advanced Functions
Cursor
Returns a mutable reference. Cursors are reused so only one cursor for each component can exist at a time.
Example
ecs.CilindroGeometría.cursor(world, component.eid)
Acquire
Same behavior as cursor, but commit must be called after the cursor is done being used.
Example
ecs.CilindroGeometría.acquire(world, component.eid)
Commit
Called after acquire. An optional third argument determines whether the cursor was mutated or not.
Example
ecs.CilindroGeometría.commit(world, component.eid)
ecs.CilindroGeometría.commit(world, component.eid, false)
Dirty
Mark the entity as having been mutated. Only needed in a specific case where systems are mutating data.
Example
ecs.CilindroGeometría.dirty(world, component.eid)