API : Objets

Remarque :la propriétéidd'un objet est un identifiant unique au niveau mondial : deux objets ne peuvent pas avoir le même identifiant, même s'ils sont de types différents. De plus, étant donné que l'identifiant d'un objet est fréquemment utilisé et ne change jamais, il existe un raccourci qui vous permet d'y accéder en utilisantobj.idau lieu deobj.get("_id")si vous le souhaitez (les deux fonctionnent).

Pathv2 (disponible sur la dernière version du moteur VTV)

La propriété shape peut prendre les valeurs suivantes :

• « pol »- Polyligne. Une ligne droite est tracée entre chaque point consécutif. Si le point de départ et le point d'arrivée sont identiques, cela crée une forme fermée.
• « gratuit »- À main levée. Une courbe est tracée en utilisant les points comme guides. Si le point de départ et le point d'arrivée sont identiques, cela crée une forme fermée.
• « eli » - Ellipse. Une ellipse est dessinée à l'aide des points pour définir un cadre de sélection. Seuls les deux premiers points sont utilisés.
• « rec » - Rectangle. Un rectangle est dessiné à l'aide des points pour définir un cadre de sélection. Seuls les deux premiers points sont utilisés.

La propriété points est une chaîne JSON contenant un tableau de points. Les points sont représentés sous la forme d'un tableau à deux positions correspondant à un emplacement x et y. Un triangle allant de (0,0) à (0,70) puis à (70,0), et revenant à (0,0) serait représenté comme suit : "[[0,0],[0,70],[70,0],[0,0]]".

Les propriétés x etypermettent de positionner l'objet PathV2 sur la page. Ils indiquent où doit se trouver le centre du dessin. Pour certaines formes (ellipses et rectangles), cela est relativement simple à déterminer. Pour les formes plus complexes (polylignes et formes libres), il est nécessaire de déterminer les valeurs minimales et maximales à partir de la propriété des pointset d'utiliser le point équidistant entre eux.

Chemin (Sur table classique)

Pour plus d'informations sur le format des données_path, veuillez consulter la section consacrée aux chemins d'accès.

Fenêtre

Remarque : les fenêtres et les portes utilisent un axe inversé par rapport aux autres types d'objets. Par exemple, une variable supérieure qui serait de 100 pour un autre objet est de y -100 pour une fenêtre ou une porte.

Exemple

on('chat:message', function(msg) {
    if (msg.type === 'api' && msg.content === '!cw') {
        const currentPageID = Campaign().get('playerpageid');
        const win = createObj('window', {
            x: 70,
            y: -70,
            pageid: currentPageID,
            path: {
		        handle0: {
        			x: -70,
        			y: 0,
        		},
        		handle1: {
        			x: 35,
        			y: 0,
        		},
        	},
            color: '#000000'
        });
    }

    if (msg.type === 'api' && msg.content === '!mw') {
        const win = getObj('window', '-NG38yUgghBBoV8YR0y1');
        win.set({
           x: 240,
           y: -139
        });
    }

    if (msg.type === 'api' && msg.content === '!dw') {
        const win = getObj('window', '-NG38yUgghBBoV8YR0y1');
        win.remove();
    }
});

Porte

Remarque : les fenêtres et les portes d's utilisent un axe inversé par rapport aux autres types d'objets. Par exemple, une variable supérieure qui serait de 100 pour un autre objet est de y -100 pour une fenêtre ou une porte.

Texte

Graphique (Jeton/Carte/Carte/etc.)

Exemple d'icônes de jeton

{
          "id":59, // l'identifiant de la base de données pour l'
          "name":"Bane", // le nom (non unique) du marqueur
          "tag":"Bane::59", // la manière dont le jeton est réellement référencé
          // cela inclura l'identifiant pour les marqueurs personnalisés, mais pas
          // pour les marqueurs par défaut.
          « url » : « https://s3.amazonaws.com/files.d20.io/images/59/yFnKXmhLTtbMtaq-Did1Yg/icon.png?1575153187 »

          // ^l'URL de l'image de l'icône de jeton
          }

Remarques importantes concernant les personnages liés et les jetons

Veuillez noter que pour les jetons liés à des personnages, le champcontrolledbydu jeton est remplacé par le champcontrolledbydu personnage.

Pour les barres de jeton (par exemple,bar1_valueetbar1_max) où le jeton est lié à un attribut (par exemple,bar1_linkest défini), le fait de définir une valeur pour la barre mettra automatiquement à jour les valeursactuelleset/oumaximalesde l'attribut sous-jacent, vous évitant ainsi de devoir les définir manuellement.

De plus, lorsque l'attributs (ou la barre de jetons) est modifié en cours de partie, vous entendrez un événementchange:attributs(et spécifique à la propriété, par exemplechange:attributs:current), suivi d'un événementchange:graphic(etchange:graphic:bar1_value). Vous pouvez choisir de répondre à l'un ou l'autre événement, mais les valeurs des barres sous-jacentes ne seront pas encore mises à jour lorsque l'événement d'attribut se déclenchera, car il se déclenche en premier.

Remarques importantes concernant les indicateurs d'état

À compter du 6 août 2013, la manière dont les marqueurs de statut sur les jetons sont gérés a été modifiée. La propriété « statusmarkers » de l'objet graphique est désormais une liste séparée par des virgules de toutes les couleurs/icônes de marqueurs d'état qui devraient être actives sur le jeton. Le format est le suivant :

//Séparé par des virgules (utilisez join pour créer ou split pour convertir en tableau). 
//Si une icône/couleur d'état est suivie du symbole « @ », le nombre après 
//« @ » s'affichera sous forme de badge sur l'icône
statusmarkers = « red,blue,skull,dead,brown@2,green@6 »

Bien que vous puissiez accéder directement à la propriétéstatusmarkers, afin de maintenir la rétrocompatibilité avec les scripts existants et de faciliter l'utilisation des marqueurs d'état sans avoir à écrire de code pour gérer vous-même le fractionnement et l'analyse de la chaîne, nous fournissons un ensemble de propriétés « virtuelles » sur l'objet que vous pouvez définir/obtenir pour utiliser les marqueurs d'état. Chaque marqueur d'état possède une propriété « status_<markername>». Par exemple :

obj.get("status_red"); //Renvoie false si le marqueur n'est pas actif, true s'il l'est, et une chaîne (par exemple « 2 » ou « 5 ») si un badge est actuellement défini sur le marqueur
obj.get('status_bluemarker'); //Toujours pris en charge pour des raisons de compatibilité ascendante, équivalent à obj.get("status_blue");
obj.set("status_red", false); //Supprimerait le marqueur
obj.set("status_skull", "2"); //Définirait un badge « 2 » sur l'icône du crâne et l'ajouterait au jeton s'il n'est pas déjà actif.

Veuillez noter que ces propriétés virtuelles ne disposent pas d'événements. Il est donc nécessaire d'utiliserchange:graphic:statusmarkerspour surveiller les modifications apportées aux marqueurs d'état d'un jeton. Par exemple,change:graphic:status_redn'est PAS un événement valide et ne se déclenchera jamais.

La liste complète des marqueurs d'état disponibles (dans le même ordre que celui dans lequel ils apparaissent dans le bac à marqueurs) :

« rouge », « bleu », « vert », « marron », « violet », « rose », « jaune », « mort », « crâne », « somnolent », « demi-cœur », « demi-brume », « interdiction », « escargot », « hélice de foudre », « clé à molette », « cœur enchaîné », « boulon chimique », « zone mortelle », « bois-moi », « fissure », « masque de ninja », « chronomètre », « filet de pêche », « surrégime », « fort », « poing », « cadenas », « trois feuilles », « aile duveteuse », « martelé », « empreinte », « fléché », « aura », « mal de dos », « drapeau noir », « œil ensanglanté », « bouclier boulonné », « cœur brisé », « toile d'araignée », « bouclier brisé », « drapeau flottant », « radioactif », « trophée », « crâne brisé », « orbe gelé », « bombe roulante », « tour blanche », « saisir », « crier », « grenade », « mitrailleuse », « tous pour un », « tenue d'ange », « cible de tir à l'arc »

Page

Campagne

 Ordre des tours

L'ordre des tours est une chaîne JSON représentant la liste actuelle des tours. Il s'agit d'un ensemble d'objets. Actuellement, l'ordre des tours ne peut contenir que des objets provenant d'une seule page à la fois. L'ID de page actuel pour l'ordre des tours est l'attribut « initiativepage ». Veuillez vous assurer qu'ils restent synchronisés, sinon vous pourriez obtenir des résultats inattendus.

Pour manipuler l'ordre des tours, il est recommandé d'utiliserJSON.parse()afin d'obtenir un objet représentant l'état actuel de l'ordre des tours (REMARQUE : veuillez d'abord vérifier qu'il ne s'agit pas d'une chaîne vide""... Si c'est le cas, veuillez l'initialiser vous-même avec un tableau vide). Voici un exemple d'objet d'ordre des tours :

    {
     "id":"36CA8D77-CF43-48D1-8682-FA2F5DFD495F", //L'ID de l'objet graphique. Si cette option est activée, la liste de l'ordre des tours affichera automatiquement le nom et l'icône correspondant à la liste basée sur le graphisme de la table.
     « pr » : « 0 », //Valeur actuelle de l'article dans la liste. Il peut s'agir d'un nombre ou d'un texte.
     « custom » : « » //Titre personnalisé pour l'article. Sera ignoré si l'ID est défini sur une valeur autre que « -1 ».
    },
    {
     "id":"-1", //Pour les articles personnalisés, l'ID DOIT être défini sur "-1" (veuillez noter qu'il s'agit d'une CHAÎNE et non d'un NOMBRE).
     « pr » : « 12 »,
     « custom » : « Test personnalisé » //Nom à afficher pour les articles personnalisés.
    

Pour modifier l'ordre des tours, veuillez modifier l'objet d'ordre des tours actuel, puis utiliserJSON.stringify()pour modifier l'attribut dans la campagne. Veuillez noter que l'ordre des tours dans la liste correspond à l'ordre du tableau. Par exemple,la fonction push()ajoute un élément à la fin de la liste, tandis quela fonction unshift()l'ajoute au début, etc.

var turnorder ;
if(Campaign().get("turnorder") == "") turnorder = []; //REMARQUE : nous vérifions d'abord que turnorder n'est pas simplement une chaîne vide. Si c'est le cas, veuillez le traiter comme un tableau vide.
Sinon, turnorder = JSON.parse(Campaign().get("turnorder"));

//Ajouter une nouvelle entrée personnalisée à la fin de l'ordre des tours.
turnorder.push({
    id: "-1",
    pr: "15",
    custom: "Compteur de tours"
});
Campaign().set("turnorder", JSON.stringify(turnorder));

Joueur

Macro

Table de jet

Article du tableau 

Personnage

Attributs

 Important : veuillez consulter la remarque ci-dessous concernant l'utilisation des feuilles de personnage pour obtenir des informations sur la manière dont les valeurs par défaut des feuilles de personnage influencent l'utilisation des attributs.

Caractéristique

Document

Remarque :L'API n'a pas accès à la hiérarchie des dossiers. Les documents créés par l'API seront placés au niveau racine.

Pont

Veuillez noter qu'il existe des méthodes API d'assistance pour « tirer », « distribuer » ou « mélanger » les cartes du jeu. Veuillez consulterle message publié sur le forum concernant la mise à jour de l'API en mars 2018.

Carte

Main

Veuillez noter que chaque joueur ne doit avoir qu'UNE seule main.

Morceau du Jukebox

Effets spéciaux personnalisés

Restrictions relatives aux propriétés imgsrc et avatar

Bien que vous puissiez désormais modifier les propriétésimgsrcetavatar, afin d'assurer la sécurité de tous les utilisateurs de Roll20, nous avons mis en place les restrictions suivantes pour ces propriétés :

• Veuillez utiliser un fichier image qui a été téléchargé dans votre bibliothèque Roll20, et non à partir d'un site externe (tel qu'Imgur) ou du Roll20 Marketplace. Il commencera par« https://s3.amazonaws.com/files.d20.io/images/ »pour les images téléchargées sur le serveur principal, ou« https://s3.amazonaws.com/files.staging.d20.io/images/ »pour les images téléchargées sur le serveur de développement. Vous pouvez consulter l'URL source d'une image à l'aide des outils de développement de votre navigateur.

• Il est nécessaire d'inclure la chaîne de requête dans l'URL, par exemple« https://s3.amazonaws.com/files.staging.d20.io/images/123456/med.png?12345678 », et non simplement «https://s3.amazonaws.com/files.staging.d20.io/images/123456/med.png ».

• Pour les objets graphiques (jetons), il est nécessaire d'utiliser la taille « miniature » de l'image. Cela devrait ressembler à «https://s3.amazonaws.com/files.staging.d20.io/images/123456/thumb.png?12345678 ».

À l'avenir, nous pourrions ajouter un outil permettant de télécharger des images spécifiquement destinées à être utilisées avec les scripts Mod (API), mais pour l'instant, veuillez utiliser les images téléchargées dans votre propre bibliothèque. Veuillez noter que si vous supprimez une image de votre bibliothèque, elle sera supprimée de tous les jeux qui utilisent cette image, y compris les jeux utilisant vos scripts Mod (API).

Utilisation des champs Notes, GMNotes et Bio Asynchrone

Afin d'accéder aux champs « notes », « gmnotes » ou « bio » des personnages et des documents, il est nécessaire de passer une fonction de rappel en tant que deuxième argument à la fonction get(). Voici un exemple :

var personnage = getObj("personnage", "-JMGkBaMgMWiQdNDwjjS");
personnage.get("bio", function(bio) {
    log(bio); //effectuer une action avec la biographie du personnage ici.
});

Vous pouvez définir la valeur de ces champs comme d'habitude. Veuillez noter qu'il existe actuellement (à la date du 09/05/2016) un bug avec ces champs asynchrones, qui fait que leur définition en passant des valeurs à createObj échoue silencieusement, laissant l'objet dans un état inhabituel. Il est recommandé de ne définir ces valeurs qu'à l'aide de .set jusqu'à ce que ce problème soit résolu. Informations détaillées sur le forum. Il existe également un bug (au 05/11/2016) qui fait que lorsque l'on tente de définir les propriétés notes et gmnotes dans le même appel set(), la deuxième propriété de l'appel est définie de manière erronée. Informations détaillées sur le forum.

Utilisation des feuilles de personnage

La fonctionnalité Feuilles de personnage influe sur l'utilisation du type d'objet Attributs, car les feuilles permettent de spécifier une valeur par défaut pour chaque attribut de la feuille. Cependant, si l'attribut est défini sur la valeur par défaut, aucun objet Attributs n'a encore été créé dans le jeu pour ce personnage. Nous mettons à votre disposition une fonctionnalité pratique qui vous évite d'avoir à gérer cette complexité. Il est recommandé d'utiliser cette fonction pour obtenir la valeur d'un attribut à l'avenir, en particulier si vous savez qu'un jeu utilise une feuille de personnage.

getAttrByName(identifiant_caractère, nom_attribut, type_valeur)

Veuillez simplement indiquer l'ID du personnage, lenom(et non l'ID) de l'attribut (par exemple « PV » ou « Str »), puis si vous souhaitez obtenir la valeur « actuelle » ou « maximale » pour value_type. Voici un exemple :

var personnage = getObj("personnage", "-JMGkBaMgMWiQdNDwjjS");
getAttrByName(personnage.id, "str"); // la valeur actuelle de str, par exemple "12"
getAttrByName(personnage.id, "str", "max"); //la valeur maximale de str, par exemple « [[floor(@{STR}/2-5)]] »

Veuillez noter que les champs dont les valeurs sont calculées automatiquement renverront la formule plutôt que le résultat de la valeur. Vous pouvez ensuite transmettre cette formule à sendChat() afin que le moteur de dés calcule automatiquement le résultat pour vous.

Veuillez également consulter la feuille de personnage pour plus d'informations sur la manière dont les feuilles de personnage interagissent avec l'API.

getAttrByNamerécupèreuniquementla valeur de l'attribut, et non l'objet attributs lui-même. Si vous souhaitez référencer des propriétés de l'attributs autres que « current » ou « max », ou si vous souhaitez modifier les propriétés de l'attributs, il est nécessaire d'utiliser l'une des autres fonctions ci-dessus, telle quefindObjs.

Si l'attribut demandé n'existe pas,getAttrByName()renverraundefined.

Création d'objets

createObj(type, attributs)

Remarque : actuellement, vous pouvez créer des objets « graphique », « texte », « chemin », « personnage », « capacité », « attributs », « document », « table à dérouler », « élément de table » et « macro ».

Vous pouvez créer un nouvel objet dans le jeu à l'aide de la fonctioncreateObj. Vous devez transmettre le type de l'objet (l'une des propriétés_typevalides de la liste d'objets ci-dessus), ainsi qu'un objetattributscontenant une liste de propriétés pour l'objet. Veuillez noter que si l'objet possède un objet parent (par exemple, les attributs et les capacités appartiennent aux personnages, les graphiques, les textes et les chemins appartiennent aux pages, etc.), il est nécessaire de transmettre l'ID du parent dans la liste des propriétés (par exemple, il est nécessaire d'inclure la propriétécharacteridlors de la création d'un attribut). Veuillez également noter que même lors de la création de nouveaux objets, il n'est pas possible de définir des propriétés en lecture seule ; celles-ci seront automatiquement définies sur leur valeur par défaut. La seule exception à cette règle concerne la création d'un chemin. Vous devez inclure la propriété « path », mais celle-ci ne peut pas être modifiée une fois le chemin initialement créé.

createObjrenverra le nouvel objet, vous permettant ainsi de continuer à l'utiliser.

Créer un nouvel attribut Force pour tous les personnages ajoutés au jeu.
on("add:personnage", function(obj) {
    createObj("attribute", {
        name: "Force",
        current: 0,
        max: 30,
        characterid: obj.id
    });
});

Suppression d'objets

objet.supprimer()

Remarque : actuellement, vous pouvez supprimer les objets « graphique », « texte », « chemin », « personnage », « capacité », « attribut », « document », « table déroulante », « élément de table » et « macro ».

Vous pouvez supprimer des objets de jeu existants à l'aide de la fonction.remove(). La fonction .remove() s'applique à tous les objets que vous pouvez créer à l'aide de la fonction createObj. Vous appelez la fonction directement sur l'objet. Par exemple,mycharacter.remove();.

Objets globaux

Il existe plusieurs objets qui sont disponibles globalement partout dans votre script.

Campagne() (fonction)

Une fonction qui renvoie l'objetCampagne. Étant donné qu'il n'existe qu'une seule campagne, cette variable globale fait toujours référence à la seule campagne du jeu. Utile pour vérifier si un objet se trouve sur la page active à l'aide deCampaign().get("playerpageid").

état

La variabled'étatest un objet dans la portée globale accessible à tous les scripts exécutés dans un jeu. Vous pouvez accéder à l'objetstateà partir de n'importe quelle fonction ou rappel à tout moment en utilisant simplement la variable globale nomméestate. De plus, l'objetd'étatest conservé entre les exécutions du Bac à sable, vous pouvez donc l'utiliser pour stocker les informations dont vous aurez besoin lors des prochaines exécutions de votre script.

Remarque :il est recommandé d'utiliser l'objet d'état pour stocker les informations qui ne sont nécessaires qu'à l'API, car elles ne sont pas envoyées aux ordinateurs des joueurs et n'augmentent pas la taille de votre fichier de jeu. Veuillez enregistrer les valeurs nécessaires au jeu dans les propriétés des objets Roll20.

Types stockables

L'objetd'étatne peut conserver que des types de données simples, tels que pris en charge par le format JSON. norme JSON .

Avertissement :bien que les fonctions semblent fonctionner lorsqu'elles sont initialement stockées dans l'état, elles disparaîtront lors de la première restauration del'étatà partir de la persistance, par exemple lors du redémarrage d'un bac à sable.

• Remarque :cela inclut les objets Roll20 que vous obtenez à partir d'événements ou des fonctionsfindObjs(),getObj(),filterObjs(),createObj(), etc.

Rappels importants

L'objetd'étatest partagé entre tous les scripts d'un bac à sable. Afin d'éviter de perturber le fonctionnement d'autres scripts, il est important de respecter quelques consignes simples :

• Ne jamais n'assignez jamais directement à l'objetd'étatracine.

état = { break: 'all the things' }; // Veuillez ne jamais procéder ainsi.

• Veuillez éviter d'utiliser des variables locales nommées « state » dans vos scripts. d'utiliser des variables locales nommées «state» dans vos scripts. Bien que cela fonctionne, cela pourrait prêter à confusion pour les utilisateurs ultérieurs de vos scripts et entraîner des problèmes si le code est modifié de manière imprudente.

function turn(){
    var state = Campaign().get('turnorder');  // Mauvaise pratique, à éviter !
    // ...
}

• Veuillez toujours placez vos propriétés sous au moins une propriété d'espace de noms. Veuillez vous assurer d'utiliser une propriété d'espace de noms suffisamment descriptive. Veuillez éviter les noms tels quescriptouparamètres. Il est préférable d'utiliser soit le nom de votre module, soit votre propre nom ou pseudonyme.

si( ! state.MyModuleNamespace ) {
    state.MyModuleNamespace = { module: 'mon module', ok: 'tout est en ordre !', count: 0 };
}
state.MyModuleNamespace.count++;

Exemple d'utilisation

Voici un exemple fonctionnel qui utilise correctement l'objetd'état.

on('ready',function() {
    "use strict";

    // Vérifier si la propriété namespaced existe, la créer si ce n'est pas le cas
    if( ! state.MyModuleNS ) {
        state.MyModuleNS = {
            version: 1.0,
            config: {
                color1: '#ff0000',
                color2: '#0000ff'
            },
            count: 0
        };
    }

    // Utilisation des propriétés d'état pour configurer un message à envoyer au chat. 
    sendChat(
        'Module de test',
        '<span style="color: '+state.MyModuleNS.config.color1+';">'+
            'Test d'état'+
        '</span> '+
        '<span style="color: '+state.MyModuleNS.config.color2+';">'+
            'Script v'+state.MyModuleNS.version+' démarré '+(++state.MyModuleNS.count)+' fois !'+
        '</span>'
    );
});

Recherche/filtrage d'objets

L'API fournit plusieurs fonctions d'aide qui peuvent être utilisées pour rechercher des objets.

getObj(type, id)
Cette fonction récupère un seul objet si le _type de l'objet et le _id sont transmis. Il est préférable d'utiliser cette fonction plutôt que les autres fonctions de recherche lorsque cela est possible, car c'est la seule qui ne nécessite pas de parcourir l'ensemble de la collection d'objets.

on("change:graphic:represents", function(obj) {
    if(obj.get("represents") != "") {
       var personnage = getObj("personnage", obj.get("represents"));
    }
});

findObjs(attributs)

Transmettez à cette fonction une liste d'attributs, et elle renverra tous les objets correspondants sous forme de tableau. Veuillez noter que cela s'applique à tous les objets de tous types sur toutes les pages. Par conséquent, il est recommandé d'inclure au moins un filtre pour _type et _pageid si vous travaillez avec des objets sur table.

var currentPageGraphics = findObjs({                              
  _pageid: Campaign().get("playerpageid"),                              
  _type: "graphic",                          
});
_.each(currentPageGraphics, function(obj) {    
  //Effectuer une action avec obj, qui se trouve dans la page actuelle et est un élément graphique.
});

Vous pouvez également transmettre un deuxième argument facultatif contenant un objet avec une liste d'options, notamment :

• caseInsensitive(vrai/faux) : si vrai, les propriétés de chaîne seront comparées sans tenir compte de la casse de la chaîne.

var targetTokens = findObjs({
    name: "target"
}, {caseInsensitive: true});
//Renvoie tous les jetons dont le nom est « target », « Target », « TARGET », etc.

filterObjs(callback)

Exécutera la fonction de rappel fournie sur chaque objet, et si le rappel renvoie la valeur true, l'objet sera inclus dans le tableau de résultats. Actuellement, il est déconseillé d'utiliser filterObjs() dans la plupart des cas. Étant donné que findObjs() dispose d'un index intégré pour une meilleure vitesse d'exécution, il est presque toujours préférable d'utiliser findObjs() pour obtenir d'abord les objets du type souhaité, puis de les filtrer à l'aide de la méthode native .filter() pour les tableaux.

var results = filterObjs(function(obj) {    
  if(obj.get("left") < 200 && obj.get("top") < 200) return true;    
  else return false;
});
//Results est un tableau contenant tous les objets situés dans le coin supérieur gauche de la sur table.

obtenirTousLesObjets()

Renvoie un tableau contenant tous les objets du jeu (tous types confondus). Équivaut à appeler filterObjs et à renvoyer simplementtruepour chaque objet.

getAttrByName(identifiant_caractère, nom_attribut, type_valeur)

Récupère la valeur d'un attribut, en utilisant la valeur par défaut de la feuille de personnage si l'attribut n'est pas présent. value_typeest un paramètre facultatif que vous pouvez utiliser pour spécifier « current » ou « max ».

getAttrByNamerécupèreuniquementla valeur de l'attribut, et non l'objet attributs lui-même. Si vous souhaitez référencer des propriétés de l'attributs autres que « current » ou « max », ou si vous souhaitez modifier les propriétés de l'attributs, il est nécessaire d'utiliser l'une des autres fonctions ci-dessus, telle quefindObjs.

Pour les Sections répétitives, vous pouvez utiliser le formatsection_répétitive_$n_attribute, oùncorrespond au numéro de ligne répétitive (en commençant par zéro). Par exemple,repeating_spells_$2_namerenverra la valeur denameà partir de la troisième ligne derepeating_spells.

Vous pouvez obtenir un comportement équivalent àgetAttrByName en utilisantce qui suit :

// current et max dépendent entièrement de l'attribut et du système de jeu
// en question ; il n'existe aucune fonction permettant de les déterminer automatiquement
function myGetAttrByName(character_id,
                         attribute_name,
                         attribute_default_current,
                         attribute_default_max,
                         value_type) {
    attribute_default_current = attribute_default_current || '';
    attribute_default_max = attribute_default_max || '';
    value_type = value_type || 'current';

    var attribute = findObjs({
        type: 'attribute',
        characterid: character_id,
        name: attribute_name
    }, {caseInsensitive: true}) [0];
    if (!attribute) {
        attribute = createObj('attribute', {
            characterid: character_id,
            name: attribute_name,
            current: attribute_default_current,
            max: attribute_default_max
        });
    }

    if (value_type == 'max') {
        return attribute.get('max');
    } else {
        return attribute.get('current');
    }
}