Bindings
Les bindings (liaison en français) permettent aux joueurs de faire référence à un élément de leur feuille de personnage dans le chat. Grâce à cette API, vous avez un contrôle total sur les liens disponibles et la façon dont ils sont affichés.
Un binding est créé avec 4 éléments :
name
, typestring
: Le nom utilisé dans le chat pour faire référence au bindingcomponentId
, typestring
: L'id du composant référencé. Vous pouvez avoir plusieurs binding pour un même componentID, notamment dans le cas des repeaters.viewId
, typestring
: L'id de la view utilisée pour afficher le binding.data
, typeFunction
: Une fonction qui retourne l'objet de données transmis à la vue pour le rendu. Ces données seront disponibles dans la vue.
Les bindings sont disponibles via la constante globale Bindings
.
Bindings.add(name, componentId, viewId, dataCallback)
name
, typestring
requis
: Le nom utilisé dans le chat.componentId
, typestring
requis
: L'id du composant utilisé.viewId
, typestring
requis
: L'id de la vue utilisée pour le rendu.dataCallback
, typeFunction
: Une fonction qui retourne l'objet de données transmis à la vue pour le rendu. L'objet doit être sérialisé en JSON.
Bindings.send(sheet, name)
sheet
, typeSheet
requis
: La fiche liée au binding.name
, typestring
requis
: Le nom du binding.
Envoie un binding dans le chat. Le binding doit avoir été enregistré
avec la fonction Binding.add()
.
Bindings.remove(name)
name
, typestring
requis
: Le nom du binding.
Enlève un binding à partir de son nom.
Bindings.clear(componentId)
componentId
, typestring
requis
: L'id du composant.
Enlève tous les bindings liés à un composant.