Sommaire

Composite

📖 Concept : Composite

Le composite est aussi un acteur : ses informations, méthodes et évènements communs sont décrits dans la référence de l’acteur. Ne figurent ici que ceux qui lui sont propres.

🔧 propriété · ℹ️ information · ⚙️ méthode · ⚡ évènement · 🔒 lecture seule

Informations

allActors

composite.allActors · 🔒 lecture seule

Obtient tous les acteurs de la scène ou du composite.

availableSlots

composite.availableSlots · 🔒 lecture seule · Array<String>

Liste des clés des emplacements sur le composte.

childActors

composite.childActors · 🔒 lecture seule · Array<BaseActor

Obtiens la liste de tous les acteurs enfants.

hasSlots

composite.hasSlots · 🔒 lecture seule · boolean

Pour savoir s’il y a des emplacement sur le composte.

isInDesigner

composite.isInDesigner · 🔒 lecture seule · boolean

Obtient vrai s’il le compositesActor.Composite ou la [scène est en mode design dans Synapps Studio.

leadActor

composite.leadActor · 🔒 lecture seule · Actor.BaseActor

Obtient l’acteur principal.

slotChildUis

composite.slotChildUis · 🔒 lecture seule · Object<String,Actor.BaseActor>

Obtient les acteurs dans les emplacements.

Méthodes

addActor(actorSetup, slotKey)

composite.addActor(actorSetup, slotKey) · renvoie Promise<Actor.BaseActor>

Ajoute un acteur dans un slot.

  • actorSetup : Setup JSON de l’acteur à ajouter.
  • slotKey : Clé de l’emplacement.

canAddActor(slotKey)

composite.canAddActor(slotKey)

Pour savoir s’il est possible d’ajouter un acteur dans un emplacement.

  • slotKey : Clé de l’emplacement.

canRemoveActor(slotKey)

composite.canRemoveActor(slotKey)

Pour savoir s’il est possible de retirer un acteur dans un emplacement.

  • slotKey : Clé de l’emplacement.

getActor(key)

composite.getActor(key) · renvoie Actor.BaseActor

Obtient un acteur enfant par sa clé.

  • key : Clé de l’acteur à trouver.

getActorInSlots(key)

composite.getActorInSlots(key) · renvoie Actor.BaseActor ou null

Obtient un acteur dans l’arborescence des emplacements du composite.

  • key : Clé de l’acteur cherché.

isAvailableSlot(slotKey)

composite.isAvailableSlot(slotKey)

Pour savoir s’il est un emplacement existe.

  • slotKey : Clé de l’emplacement.

removeActor(actorKey)

composite.removeActor(actorKey)

Retire un acteur d’un slot.

  • actorKey : Clé de l’acteur enfant à retirer.

Événements

onDidActorAddInSlot

Se produit lorsque un acteur est ajouté dans un slot.

context : contexte d’évènement, avec en plus :

Membre de context Type Description
addedActor Actor.BaseActor Acteur ajouté.
inSlot    

onDidActorRemoveInSlot

Se produit lorsque un acteur est ajouté dans un slot.

context : contexte d’évènement, avec en plus :

Membre de context Type Description
addedActor Actor.BaseActor Acteur ajouté.
removedActor    
inSlot