Sommaire

Contexte d’évènement

📖 Concept : Scripts

Objet context passé à tous les scripts (évènements, transformations de liaison). Chaque évènement peut y ajouter ses propres membres : ils sont décrits avec l’évènement.

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

Informations

dataStores

context.dataStores · 🔒 lecture seule · Magasins de données

Magasins de données de la synapp (dataStores.redy : le magasin REDY).

eventName

context.eventName · 🔒 lecture seule · String

Nom de l’évènement.

rootScene

context.rootScene · 🔒 lecture seule · Scène

Scène racine de l’acteur.

scene

context.scene · 🔒 lecture seule · Scène

Première scène parente de l’acteur émetteur de l’évènement.

stage

context.stage · 🔒 lecture seule · Stage

Scène ou composite portant l’acteur émetteur de l’évènement.

synapp

context.synapp · 🔒 lecture seule · Synapp

Synapp

target

context.target · 🔒 lecture seule · Actor.BaseActor

Acteur à l’origine de l’évènement.

utils

context.utils · 🔒 lecture seule · Utilitaires du contexte

Méthodes utilitaires pour les scripts.

Méthodes

getActor(key)

context.getActor(key) · renvoie Actor.BaseActor

Obtient l’acteur dans la même scène ou le même composite suivant sa clé.

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

Utilitaires

Fonctions accessibles par context.utils.

debounce(func, delay)

context.utils.debounce(func, delay) · renvoie Function

Retourne un méthode qui retarde les répétitions d’exécution d’une autre méthode.

  • func : Fonction a exécuter après un délai.
  • delay : Délai d’attente avant l’exécution en ms.

debouncedPromise(func, delay)

context.utils.debouncedPromise(func, delay) · renvoie Function

Retourne une méthode asynchrone qui retarde les répétitions d’exécution d’une autre méthode.

  • func : Fonction asynchrone a exécuter après un délai.
  • delay : Délai d’attente avant l’exécution en ms.

get(obj, path)

context.utils.get(obj, path) · renvoie any

Obtient la valeur d’un objet suivant un chemin.

  • obj : L’objet
  • path : Le chemin

isEmpty(value)

context.utils.isEmpty(value) · renvoie Boolean

La valeur est elle vide ?

  • value : la valeur à tester

isNone(value)

context.utils.isNone(value) · renvoie Boolean

La valeur est elle null/vide ?

  • value : la valeur à tester

isPresent(value)

context.utils.isPresent(value) · renvoie Boolean

La valeur est elle présente ?

  • value : la valeur à tester

isValuesEqual(value1, value2, isWeakComparison?)

context.utils.isValuesEqual(value1, value2, isWeakComparison?)

Compare deux valeurs de tous types.

Les tableaux sont comparés élément par élément.

  • v1 : Valeur 1 à comparer
  • v2 : Valeur 2 à comparer
  • isWeakComparison : activer la comparaison faible

notifyPropertyChange(obj, path)

context.utils.notifyPropertyChange(obj, path)

Permet de déclencher les mises à jours de liaison ou évènement de changement de propriété suivant un chemin.

  • obj : L’objet
  • path : Le chemin à notifier

set(obj, path, value)

context.utils.set(obj, path, value)

Assigne la valeur à un objet suivant un chemin.

Permet de déclencher les mises à jours de liaison ou évènement de changement de propriété.

  • obj : L’objet
  • path : Le chemin
  • value : la valeur à placer.

setProperties(obj, props)

context.utils.setProperties(obj, props)

Assigne des valeurs à un objet suivant plusieurs chemin.

Permet de déclencher les mises à jours de liaison ou évènement de changement de propriété.

  • obj : L’objet
  • props : Les valeurs à placer.

typeOf(value)

context.utils.typeOf(value) · renvoie string

Retourne le type de la valeur.

  • value : la valeur à tester

wait(delay, params?)

context.utils.wait(delay, params?) · renvoie Promise

Méthode asynchrone qui permet d’attendre un délai avant d’exécuter la suite du code.

  • delay : Délai d’attente avant l’exécution en ms.
  • params : Objet qui permet de récupérer le timeout créer pour avoir la possibilité d’annuler l’attente.
  • params.timeout : Timeout créé.