Prise en charge de l'APL pour l'éclairage dynamique

Es-tu un magicien de la programmation, ou aimes-tu travailler avec l'API Roll20? Si oui, nous avons une excellente nouvelle pour toi - L'éclairage dynamique est maintenant intégré à l'API Roll20! Découvrez toutes les fonctions et fonctionnalités impressionnantes d'éclairage et de vision que vous pouvez utiliser dans votre code personnalisé. N'oubliez pas que l'accès à l'API est uniquement disponible pour les abonnés Pro, alors mettez à niveau votre compte si vous ne l'avez pas déjà fait.


Paramètres du jeton

Syntaxe Contexte Stéréotype
has_bright_light_vision  Active la vision pour le jeton. Booléen
has_night_vision Active la vision nocturne pour le jeton.  Booléen
night_vision_distance Définit la portée de la vision nocturne de l'élément.  Entier
émits_bright_light Active la lumière vive pour l'élément.  Booléen
bright_light_distance Définit la portée de la quantité de lumière vive émise par l'élément.  Entier
émits_low_light Active la lumière faible pour l'élément. Cela serait utile pour une torche ou une source avec une faible quantité de lumière. Utilisez les booléens true pour activer ou false pour désactiver. Booléen
low_light_distance Définit la portée de la quantité de lumière faible émise par l'élément. Lors de la définition de cette valeur, vous devez inclure toute Distance de Lumière Vive que vous avez définie. La raison en est que la Distance de faible luminosité est calculée à partir du centre du jeton. Donc, si vous avez défini la Distance de lumière vive sur 10 et que vous souhaitez ajouter 10 pieds supplémentaires de Distance de faible luminosité, la valeur de low_light_distance doit être de 20. Entier 
light_sensitivity_multiplier Multiplicateur de l'efficacité des sources de lumière. A multiplier of 200 would allow the token to see twice as far as a token with a multiplier of 100, with the same light source. Entier
effet_vision_de_nuit
Changes the Night Vision Effect. Other options include “Dimming” and “Nocturnal” Chaîne de caractères

 

Vision et Éclairage directionnels

Syntaxe Contexte Stéréotype
has_limit_field_of_vision Bascule le champ de vision limité pour le jeton. Booléen
limit_field_of_vision_center Définit la valeur à partir de laquelle le centre du champ de vision commence. Entier
limit_field_of_vision_total Set the value for the total size of the field of vision. Integer

has_limit_field_of_night_vision

Toggles limit field of night vision for the token. Booléen
limit_field_of_night_vision_center Sets the value for where the center of the field of night vision starts. Integer 
limit_field_of_night_vision_total Set the value for the total size of the field of night vision. Integer
has_directional_bright_light Toggles directional bright light for the token. Booléen

centre_de_lumière_vive_directionnelle

Définit la valeur à laquelle le centre du champ de lumière vive commence. Entier
lumière_vive_directionnelle_totale Définit la valeur pour la taille totale du champ de lumière vive. Entier 

a_de_la_lumière_atténuée_directionnelle

Active la lumière tamisée directionnelle pour le token. Booléen
centre_de_lumière_atténuée_directionnelle Définit la valeur à laquelle le centre du champ de lumière tamisée commence. Entier
lumière_atténuée_directionnelle_totale Définit la valeur pour la taille totale du champ de lumière tamisée. Entier

 


Paramètres de page

Syntaxe Contexte Stéréotype
éclairage_dynamique Permet de mettre à jour l'éclairage dynamique de la page.  Booléen
mode_lumière_du_jour activé Bascule le mode lumière du jour pour la page. Cette fonction ne doit pas être activée si l'option dynamic_lighting_enabled n'est pas activée.  Booléen
mode_explorateur

Bascule le mode explorateur pour la page. Cette fonction ne doit pas être activée si l'option dynamic_lighting_enabled n'est pas activée.

Utilisez les chaînes "basic" pour allumer ou "off" pour éteindre. 

Chaîne de caractères

force_lighting_refresh

Déclenche une actualisation de tous les symboles d'éclairage/de vision sur une page. Peut être utilisé en un seul appel après avoir placé plusieurs jetons sur une page. (Sera obsolète dans les prochains mois !) 

Booléen

opacité_brouillard

Opacité du brouillard de guerre pour le GM.

Booléen

lightupdatedrop

Ne mettre à jour l'éclairage dynamique que lorsqu'un objet est déposé.

Booléen

 


Exemples 

on("change:graphic", function(obj) {
  obj.set({
    has_bright_light_vision: true,
    emits_bright_light: true,
    bright_light_distance: 10
  });
});

Cela ajoutera les valeurs ci-dessus à un jetondans deux instances :

  • lors de l'ajout d'un nouveau jetonauVTT
  • déplacer un jetonqui existe déjà sur leVTT, avec ou sansjetonparamètres déjà définis.

Cependant, l'utilisation de on("change" est dangereuse car si vous mettez à jour les paramètres du jetonpour un jetonspécifique, cela déclenche un événement de changement, qui déclenchera cette API. Donc, si vous avez quelque chose comme ceci dans votre script API, votrejetonparamètres resteront toujours de cette façon pour chaquejeton, à moins que vous n'ajoutiez des déclarations conditionnelles pour que ça fonctionne comme vous le souhaitez.

on("change:graphic", function(obj) {
  obj.set({
    has_bright_light_vision: true,
    emits_bright_light: true,
    bright_light_distance: 10,
    emits_low_light: true,
    low_light_distance: 25
  });
});

Cet exemple définira la Vision de n'importe queljetonqui a changé (déplacé, mis à jour, ajouté auVTT, etc). Lejetonémettra également 10 pieds de Distance lumineuse intense, ainsi que 15 pieds de Distance lumineuse faible.

Remarquez commentlow_light_distanceest réglé sur25. En effet, la valeur delow_light_distancedoit être la somme debright_light_distanceet de la quantité de lumière émise par le jeton- dans ce cas, il s'agit de15.

 

Cet article vous a-t-il été utile ?
Utilisateurs qui ont trouvé cela utile : 43 sur 69