Skip to main content

Entité

Description​

Cette classe représente une entité individuelle dans le graphe de scène de 8th Wall Studio, offrant un accès aux composants, un contrôle de l'état et des opérations hiérarchiques.

Propriétés​

PropriétéTypeDescription
eidAïdIdentifiant unique pour cette entité.

Méthodes des composants​

obtenir​

Accéder aux données actuelles d'un composant de cette entité.

entity.get(component : RootAttribute<Schema>) // -> ReadData<Schema>

a​

Vérifier si un composant existe sur cette entité.

entity.has(component : RootAttribute<Schema>) // -> booléen

fixer​

Appliquer des données à un composant de cette entité.

entity.set(component : RootAttribute<Schema>, data : ReadData<Schema>) // -> void

supprimer​

Retirer un composant de cette entité.

entity.remove(component : RootAttribute<Schema>) // -> void

réinitialiser​

Réinitialise un composant de cette entité à sa valeur par défaut.

entity.reset(component : RootAttribute<Schema>) // -> void

Méthodes nationales​

cacher​

Masquer cette entité.

entity.hide() // -> void

montrer​

Afficher cette entité si elle est cachée.

entity.show() // -> void

estCaché​

Vérifie si l'entité est actuellement cachée.

entity.isHidden() // -> booléen

désactiver​

Désactiver cette entité.

entity.disable() // -> void

permettre​

Activer cette entité.

entity.enable() // -> void

est désactivé​

Vérifier si l'entité est actuellement désactivée.

entity.isDisabled() // -> booléen

supprimer​

Supprimer cette entité du monde.

entity.delete() // -> void

est supprimé​

Vérifier si l'entité a été supprimée.

entity.isDeleted() // -> booléen

Méthodes de hiérarchisation​

setParent​

Définit le parent de cette entité.

entity.setParent(parent : Eid | undefined | null) // -> void

getChildren​

Obtenir les enfants de cette entité.

entity.getChildren() // -> Générateur<Eid>

getParent​

Obtenir le parent de cette entité.

entity.getParent() // -> Eid | undefined

addChild​

Faire d'une autre entité un enfant de celle-ci.

entity.addChild(child : Eid) // -> void