Entidad
Descripción
Esta clase representa una entidad individual en el gráfico de escena de 8th Wall Studio, ofreciendo acceso a componentes, control de estado y operaciones jerárquicas.Propiedades
Propiedad | Tipo | Descripción |
---|---|---|
eid | Eid | Identificador único para esta entidad. |
Métodos de los componentes
consiga
Accede a los datos actuales de un componente de esta entidad.
entity.get(component: RootAttribute<Schema>) // -> ReadData<Schema>
tiene
Comprueba si existe un componente en esta entidad.
entity.has(component: RootAttribute<Schema>) // -> boolean
configure
Aplicar datos a un componente de esta entidad.
entity.set(component: RootAttribute<Schema>, data: ReadData<Schema>) // -> void
eliminar
Elimina un componente de esta entidad.
entity.remove(component: RootAttribute<Schema>) // -> void
reiniciar
Restablece un componente de esta entidad a su valor por defecto.
entity.reset(component: RootAttribute<Schema>) // -> void
Métodos estatales
ocultar
Ocultar esta entidad.
entity.hide() // -> void
Mostrar
Mostrar esta entidad si está oculta.
entity.show() // -> void
isHidden
Comprueba si la entidad está actualmente oculta.
entity.isHidden() // -> booleano
desactivar
Desactivar esta entidad.
entity.disable() // -> void
active
Habilitar esta entidad.
entity.enable() // -> void
isDisabled
Comprueba si la entidad está actualmente desactivada.
entity.isDisabled() // -> booleano
borrar
Elimina esta entidad del mundo.
entity.delete() // -> void
isDeleted
Comprueba si la entidad ha sido eliminada.
entity.isDeleted() // -> booleano
Métodos jerárquicos
setParent
Establece el padre de esta entidad.
entity.setParent(parent: Eid | undefined | null) // -> void
getChildren
Obtener los hijos de esta entidad.
entity.getChildren() // -> Generador<Eid>
getParent
Obtener el padre de esta entidad.
entity.getParent() // -> Eid | undefined
addChild
Hacer otra entidad hija de ésta.
entity.addChild(child: Eid) // -> void