API: Oggetti

Nota:la proprietàiddi un oggetto è un ID univoco a livello globale: non è possibile che due oggetti abbiano lo stesso ID, anche se appartengono a tipi diversi. Inoltre, poiché l'ID di un oggetto viene consultato frequentemente e non cambia mai, è disponibile una scorciatoia che consente di accedervi utilizzandoobj.idinvece diobj.get("_id"), se lo si desidera (entrambi funzionano).

Pathv2 (disponibile sull'ultima versione del motore VTT)

La proprietà shape presenta i seguenti valori:

• "pol"- Polilinea. Si traccia una linea retta tra ogni punto consecutivo. Se il punto iniziale e il punto finale coincidono, si crea una forma chiusa.
• "free"- A mano libera. Una curva viene tracciata utilizzando i punti come guide. Se il punto iniziale e il punto finale coincidono, si crea una forma chiusa.
• "eli" - Ellisse. Un'ellisse viene disegnata utilizzando i punti per impostare un riquadro di delimitazione. Si utilizzano solo i primi due punti.
• "rec" - Rettangolo. Si disegna un rettangolo utilizzando i punti per impostare un riquadro di delimitazione. Si utilizzano solo i primi due punti.

La proprietà points è una stringa JSON contenente un array di punti. I punti sono rappresentati come un array a due posizioni di una posizione x e y. Un triangolo che va da (0,0) a (0,70) a (70,0) e torna a (0,0) sarebbe rappresentato come "[[0,0],[0,70],[70,0],[0,0]]".

Le proprietà x eyposizionano l'oggetto PathV2 sulla pagina. Essi indicano dove dovrebbe trovarsi il centro del disegno. Per alcune forme (ellissi e rettangoli), è piuttosto semplice da determinare. Per forme più complesse (polilinee e disegni a mano libera), sarà necessario individuare i valori minimo e massimo dalla proprietà dei puntie utilizzare il punto equidistante tra essi.

Percorso (Tavolo di gioco classico)

Per ulteriori informazioni sul formato dei dati_path, consultare la sezione relativa ai percorsi.

Finestra

Nota: Finestre e porte utilizzano un asse invertito rispetto ad altri tipi di oggetti. Ad esempio, una variabile superiore che sarebbe 100 per un altro oggetto è y -100 per una finestra o una porta.

Esempio

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();
    }
});

Porta

Nota: le finestre e le porte di utilizzano un asse invertito rispetto ad altri tipi di oggetti. Ad esempio, una variabile superiore che sarebbe 100 per un altro oggetto è y -100 per una finestra o una porta.

Testo

Grafica (segnalino/mappa/carta/ecc.)

Esempio di indicatori per segnalino

{
          "id":59, // l'ID del database per l'
          "name":"Bane", // il nome (non univoco) del marcatore
          "tag":"Bane::59", // come viene effettivamente referenziato il token
          // questo includerà l'ID per i marcatori personalizzati, ma non
          // per i marcatori predefiniti.
          "url":"https://s3.amazonaws.com/files.d20.io/images/59/yFnKXmhLTtbMtaq-Did1Yg/icon.png?1575153187"

          // ^l'URL dell'immagine del marcatore del token
          }

Note importanti sui personaggi collegati e sui segnalini

Si prega di notare che per i segnalini collegati ai personaggi, il campocontrolledbysul segnalino viene sovrascritto dal campocontrolledbysul personaggio.

Per le barre del segnalino (ad esempiobar1_valueebar1_max) in cui il segnalino è collegato a un attributo (ad esempiobar1_linkè impostato), l'impostazione di un valore per la barra aggiornerà automaticamente anche i valoricorrentie/omassimidell'attributo sottostante, evitando la necessità di impostarli manualmente.

Inoltre, quando l'attributo (o la barra del segnalino) viene modificato nel gioco, si sentirà unevento change:attribute(e specifico della proprietà, ad esempiochange:attribute:current), seguito da un eventochange:graphic(echange:graphic:bar1_value). È possibile scegliere di rispondere a uno dei due eventi, ma i valori della barra sottostante non saranno ancora aggiornati quando si verifica l'evento attributo, poiché questo si verifica per primo.

Note importanti sui marcatori di stato

A partire dal 6 agosto 2013, è cambiato il modo in cui vengono gestiti gli indicatori di stato sui segnalini. La proprietà "statusmarkers" dell'oggetto grafico è ora un elenco separato da virgole di tutti i colori/icone degli indicatori di stato che dovrebbero essere attivi sul segnalino. Il formato è il seguente:

//Delimitato da virgola (utilizzare join per creare o split per trasformare in un array). 
 

Se un'icona/colore di stato è seguita dal simbolo "@", il numero dopo "@" verrà visualizzato come badge sull'icona. //Se un'icona/colore di stato è seguita dal simbolo "@", il numero dopo "@" verrà visualizzato come badge sull'icona. //Se un'icona/colore di stato è seguita dal simbolo "@", il numero dopo "@" verrà visualizzato come badge sull'icona. //Se un'icona/colore di stato è seguita dal simbolo "@", il numero dopo "@" verrà visualizzato come badge sull'icona. //Se un'icona/colore di stato è seguita dal simbolo "@", il numero dopo "@" verrà visualizzato come badge sull'icona. //Se un'icona/colore di stato è seguita dal simbolo "@", il

Sebbene sia possibile accedere direttamente alla proprietàstatusmarkers, per mantenere la retrocompatibilità con gli script esistenti e per fornire un modo semplice di lavorare con gli indicatori di stato senza dover scrivere codice per gestire la suddivisione e l'analisi della stringa, forniamo una serie di proprietà "virtuali" sull'oggetto che è possibile impostare/ottenere per lavorare con gli indicatori di stato. Ogni indicatore di stato possiede una proprietà "status_<markername>". Per esempio:

obj.get("status_red"); //Restituirà false se il marcatore non è attivo, true se lo è e una stringa (ad esempio "2" o "5") se attualmente è presente un badge impostato sul marcatore
obj.get('status_bluemarker'); //È ancora supportato per la compatibilità con le versioni precedenti ed è equivalente a obj.get("status_blue");
obj.set("status_red", false); //rimuoverebbe il marcatore
obj.set("status_skull", "2"); //impostarebbe un badge "2" sull'icona del teschio e lo aggiungerebbe al token se non è già attivo.

Si prega di notare che queste proprietà virtuali non dispongono di eventi, pertanto è necessario utilizzarechange:graphic:statusmarkersper rilevare le modifiche agli indicatori di stato di un token; ad esempio,change:graphic:status_rednon è un evento valido e non verrà mai attivato.

Di seguito è riportato l'elenco completo degli indicatori di stato disponibili (nello stesso ordine in cui appaiono nel vassoio degli indicatori):

"rosso", "blu", "verde", "marrone", "viola", "rosa", "giallo", "morto", "teschio", "assonnato", "mezzo cuore", "mezza foschia", "interdizione", "lumaca", "elica di fulmine", "chiave inglese", "cuore incatenato", "bullone chimico", "zona mortale", "bevi me", "crepa sul bordo", "maschera da ninja", "cronometro", "rete da pesca", "overdrive", "forte", "pugno", "lucchetto", "tre foglie", "ala soffice", "malconcio", "tread", "frecciato", "aura", "mal di schiena", "bandiera nera", "occhio sanguinante", "scudo a bullone", "cuore spezzato", "ragnatela", "scudo rotto", "bandiera sventolante", "radioattivo", "trofeo", "teschio rotto", "sfera congelata", "bomba rotolante", "torre bianca", "afferrare", "urlare", "granata", "mitragliatrice sentinella", "tutti per uno", "abito da angelo", "bersaglio per tiro con l'arco"

Pagina

Campagna

 ordine di turno

L'ordine di turno è una stringa JSON che rappresenta l'elenco dell'ordine di turno corrente. Si tratta di un insieme di oggetti. Attualmente, l'ordine di turno può contenere solo oggetti provenienti da una pagina alla volta: l'ID della pagina corrente per l'ordine di turno è l'attributo "initiativepage". Assicurarsi di mantenerli entrambi sincronizzati, altrimenti si potrebbero ottenere risultati inaspettati.

Per gestire l'ordine di turno, si consiglia di utilizzareJSON.parse()per ottenere un oggetto che rappresenti lo stato attuale dell'ordine di turno (NOTA: verificare innanzitutto che non si tratti di una stringa vuota""... se lo è, inizializzarla manualmente con un array vuoto). Ecco un esempio di oggetto ordine di turno:

    {
     "id":"36CA8D77-CF43-48D1-8682-FA2F5DFD495F", //L'ID dell'oggetto grafico. Se questa opzione è selezionata, l'elenco dell'ordine di turno estrarrà automaticamente il nome e l'icona per l'elenco in base alla grafica sul tavolo da gioco.
     "pr":"0", //Il valore attuale dell'articolo nell'elenco. Può essere un numero o un testo.
     "custom":"" //Titolo personalizzato per l'articolo. Verrà ignorato se l'ID è impostato su un valore diverso da "-1".
    },
    {
     "id":"-1", //Per gli articoli personalizzati, l'ID DEVE essere impostato su "-1" (si noti che si tratta di una STRINGA e non di un NUMERO).
     "pr":"12",
     "custom":"Test personalizzato" //Il nome da visualizzare per gli articoli personalizzati.
    
]

Per modificare l'ordine di turno, si prega di modificare l'oggetto dell'ordine di turno corrente e quindi utilizzareJSON.stringify()per modificare l'attributo nella campagna. Si noti che l'ordine di turno nell'elenco è lo stesso dell'ordine dell'array, quindi, ad esempio,push()aggiunge un elemento alla fine dell'elenco,unshift()lo aggiunge all'inizio, ecc.

var turnorder;
if(Campaign().get("turnorder") == "") turnorder = []; //NOTA: Verifichiamo innanzitutto che turnorder non sia solo una stringa vuota. Se è così, considerarlo come un array vuoto.
altrimenti turnorder = JSON.parse(Campaign().get("turnorder"));

//Aggiungere una nuova voce personalizzata alla fine dell'ordine di turno.
turnorder.push({
    id: "-1",
    pr: "15",
    custom: "Turn Counter"
});
Campaign().set("turnorder", JSON.stringify(turnorder));

Giocatore/trice

Macro

Tabelle di tiro

Articolo della tabella 

Personaggio

Attributo

 Importante: consultare la nota sottostante relativa all'utilizzo della scheda dei personaggi per informazioni su come i valori predefiniti della scheda dei personaggi influenzano l'uso degli attributi.

Abilità

Materiale di gioco

Nota: L'API non ha accesso alla gerarchia delle cartelle. I materiali di gioco creati dall'API saranno collocati nella directory principale.

Ponte

Si prega di notare che sono disponibili metodi API di supporto per "pescare", "distribuire" o "mescolare" le carte dal mazzo. Si prega di consultareil post sul forum relativo all'aggiornamento dell'API del marzo 2018.

Carta

Mano

Si prega di notare che ogni giocatore dovrebbe avere solo UNA mano.

Brano del Jukebox

Effetti speciali personalizzati

Restrizioni relative alle proprietà imgsrc e avatar

Sebbene ora sia possibile modificare le proprietàimgsrceavatar, al fine di garantire la sicurezza di tutti gli utenti di Roll20, abbiamo applicato le seguenti restrizioni a tali proprietà:

• È necessario utilizzare un file immagine che sia stato caricato nella propria Libreria Roll20, non da un sito esterno (come Imgur) e non dal Marketplace Roll20. Inizierà con"https://s3.amazonaws.com/files.d20.io/images/"per le immagini caricate sul server principale o"https://s3.amazonaws.com/files.staging.d20.io/images/"per le immagini caricate sul server di sviluppo. È possibile visualizzare l'URL di origine di un'immagine utilizzando gli strumenti di sviluppo del browser.

• È necessario includere la stringa di query nell'URL, ad esempio"https://s3.amazonaws.com/files.staging.d20.io/images/123456/med.png?12345678", non solo "https://s3.amazonaws.com/files.staging.d20.io/images/123456/med.png".

• Per gli oggetti grafici (segnalini), è necessario utilizzare la dimensione "thumb" dell'immagine. Dovrebbe apparire come"https://s3.amazonaws.com/files.staging.d20.io/images/123456/thumb.png?12345678".

In futuro potremmo aggiungere uno strumento che consenta di caricare immagini specificamente destinate all'uso con script Mod (API), ma per ora si prega di utilizzare solo immagini caricate nella propria libreria. Si prega di notare che se si elimina un'immagine dalla propria libreria, essa verrà rimossa da tutti i giochi che utilizzano tale immagine, compresi i giochi che utilizzano gli script Mod (API).

Utilizzo dei campi Note, GMNote e Bio Asincrono

Per accedere ai campi "notes", "gmnotes" o "bio" su personaggi e materiali di gioco, è necessario passare una funzione di callback come secondo argomento alla funzione get(). Ecco un esempio:

var character = getObj("personaggio", "-JMGkBaMgMWiQdNDwjjS");
character.get("bio", function(bio) {
    log(bio); //effettuare un'operazione con la biografia del personaggio qui.
});

È possibile impostare il valore di questi campi come di consueto. Si prega di notare che attualmente (al 09/05/2016) è presente un bug in questi campi asincroni, per cui impostarli passando valori a createObj non funziona correttamente, lasciando l'oggetto in uno stato anomalo. Si consiglia di impostare questi valori utilizzando .set solo fino a quando il problema non sarà risolto. Dettagli sul Forum. È stato inoltre riscontrato un bug (al 05/11/2016) per cui, nel tentativo di impostare entrambe le proprietà notes e gmnotes nella stessa chiamata set(), la seconda proprietà nella chiamata viene impostata in modo errato. Dettagli sul Forum.

Lavorare con le schede dei personaggi

La funzione Scheda dei personaggi influisce sull'utilizzo del tipo di oggetto Attributo, poiché le schede consentono di specificare un valore predefinito per ciascun attributo presente nella scheda. Tuttavia, se l'attributo è impostato sul valore predefinito, non esiste ancora un oggetto Attributo effettivo creato nel gioco per quel personaggio. Offriamo una funzione di comodità che nasconde questa complessità all'utente. Si consiglia di utilizzare questa funzione per ottenere il valore di un attributo in futuro, specialmente se si è a conoscenza che un gioco utilizza una scheda dei personaggi.

getAttrByName(id_carattere, nome_attributo, tipo_valore)

È sufficiente specificare l'ID del personaggio, ilnome(non l'ID) dell'attributo (ad esempio "PF" o "Str") e quindi se si desidera il valore "attuale" o "massimo" per value_type. Ecco un esempio:

var personaggio = getObj("personaggio", "-JMGkBaMgMWiQdNDwjjS");
getAttrByName(personaggio.id, "str"); // il valore attuale di str, ad esempio "12"
getAttrByName(personaggio.id, "str", "max"); //il valore massimo di str, ad esempio "[[floor(@{STR}/2-5)]]"

Si prega di notare che i campi con valori calcolati automaticamente restituiranno la formula anziché il risultato del valore. È quindi possibile trasmettere tale formula a sendChat() per utilizzare il motore dei dadi e ottenere automaticamente il risultato.

Assicurati di consultare anche la Scheda Personaggio per ulteriori informazioni su come la scheda dei personaggi interagisce con l'API.

getAttrByNamerecupereràsoloil valore dell'attributo, non l'oggetto attributo stesso. Se si desidera fare riferimento a proprietà dell'attributo diverse da "current" o "max", o se si desidera modificare le proprietà dell'attributo, è necessario utilizzare una delle altre funzioni sopra indicate, comefindObjs.

Nel caso in cui l'attributo richiesto non esista,getAttrByName()restituiràundefined.

Creazione di oggetti

creaOggetto(tipo, attributo)

Nota: attualmente è possibile creare oggetti "grafici", "testo", "percorso", "personaggio", "abilità", "attributo", "materiale di gioco", "tabella a scorrimento", "voce di tabella" e "macro".

È possibile creare un nuovo oggetto nel gioco utilizzando la funzionecreateObj. È necessario specificare il tipo dell'oggetto (una delle proprietà_typevalide dall'elenco degli oggetti sopra riportato), nonché un oggettoattributocontenente un elenco di proprietà per l'oggetto. Si prega di notare che se l'oggetto ha un oggetto padre (ad esempio, gli attributi e le abilità appartengono ai personaggi, la grafica, i testi e i percorsi appartengono alle pagine, ecc.), è necessario inserire l'ID del padre nell'elenco delle proprietà (ad esempio, è necessario includere la proprietàcharacteridquando si crea un attributo). Si prega inoltre di notare che, anche durante la creazione di nuovi oggetti, non è possibile impostare proprietà di sola lettura, poiché queste verranno automaticamente impostate sul loro valore predefinito. L'unica eccezione a questa regola si verifica quando si crea un percorso: in tal caso, è necessario includere la proprietà "path", che tuttavia non può essere modificata una volta creato il percorso.

createObjrestituirà il nuovo oggetto, consentendo di continuare a lavorarci.

//Creare un nuovo attributo Forza su tutti i personaggi aggiunti al gioco.
on("add:personaggio", function(obj) {
    createObj("attributo", {
        name: "Strength",
        current: 0,
        max: 30,
        characterid: obj.id
    });
});

Eliminazione di oggetti

rimuovi oggetto()

Nota: attualmente è possibile eliminare oggetti "grafici", "testo", "percorso", "personaggio", "abilità", "attributo", "materiale di gioco", "tabella scorrevole", "voce di tabella" e "macro".

È possibile eliminare gli oggetti di gioco esistenti utilizzando la funzione.remove(). La funzione .remove() è applicabile a tutti gli oggetti che è possibile creare con la funzione createObj. È necessario richiamare la funzione direttamente sull'oggetto. Ad esempio,mycharacter.remove();.

Oggetti globali

Esistono diversi oggetti disponibili a livello globale in qualsiasi punto dello script.

Campagna() (funzione)

Una funzione che restituisce l'oggettoCampagna. Poiché esiste una sola campagna, questo globale fa sempre riferimento all'unica campagna presente nel gioco. Utile per verificare se un oggetto si trova nella pagina attiva utilizzandoCampaign().get("playerpageid").

stato/Provincia

La variabiledi statoè un oggetto nell'ambito globale accessibile a tutti gli script in esecuzione in un gioco. È possibile accedere all'oggettostatoda qualsiasi funzione o callback in qualsiasi momento semplicemente utilizzando la variabile globale denominatastato. Inoltre, l'oggettodi statoviene mantenuto tra le esecuzioni della sandbox, pertanto è possibile utilizzarlo per memorizzare le informazioni che si desidera avere nelle future esecuzioni dello script.

Nota:si consiglia di utilizzare l'oggetto stato per memorizzare le informazioni necessarie solo all'API, poiché non vengono inviate ai computer dei giocatori e non aumentano le dimensioni del file di gioco. Si prega di memorizzare i valori necessari nel gioco nelle proprietà degli oggetti Roll20.

Tipi memorizzabili

L'oggettostatoè in grado di conservare solo tipi di dati semplici, come supportato dal standard JSON .

Attenzione:sebbene le funzioni sembrino funzionare quando vengono memorizzate nello stato iniziale, esse scompariranno la prima volta chelo statoviene ripristinato dalla persistenza, ad esempio al riavvio della sandbox.

• Nota:questo include gli oggetti Roll20 ottenuti dagli eventi o dalle funzionifindObjs(),getObj(),filterObjs(),createObj(), ecc.

Promemoria importanti

L'oggettodi statoè condiviso tra tutti gli script in una sandbox. Per evitare di danneggiare altri script, è importante seguire alcune semplici linee guida:

• Non assegnare direttamente all'oggettodello statoroot.

stato = { break: 'all the things' }; // Si prega di non procedere in questo modo.

• Si prega di evitare l'uso di variabili locali denominate "state" nei propri script. l'uso di variabili locali denominate"state" nei propri script. Sebbene questa soluzione sia efficace, potrebbe creare confusione agli utenti futuri dei vostri script e causare problemi se il codice viene modificato in modo inappropriato.

funzione turn(){
    var state = Campaign().get('turnorder'); // Pratica scorretta, da evitare!
    // ...
}

• Si prega di posizionare sempre le proprietà collocate le vostre proprietà sotto almeno una proprietà namespace. Assicurarsi di utilizzare una proprietà dello spazio dei nomi sufficientemente descrittiva. Si prega di evitare nomi comescriptoimpostazioni. Si consiglia di utilizzare il nome del proprio modulo o il proprio nome o nickname.

if( ! state.MyModuleNamespace ) {
    state.MyModuleNamespace = { module: 'my module', ok: 'this is fine!', count: 0 };
}
state.MyModuleNamespace.count++;

Esempio di utilizzo

Questo è un esempio funzionante che utilizza correttamente l'oggettostato.

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

    // Verifica se la proprietà namespaced esiste, creandola se non è presente
    if( ! state.MyModuleNS ) {
        state.MyModuleNS = {
            version: 1.0,
            config: {
                color1: '#ff0000',
                color2: '#0000ff'
            },
            count: 0
        };
    }

    // Utilizzo delle proprietà dello stato per configurare un messaggio nella chat. 
    sendChat(
        'Modulo di prova',
        '<span style="color: '+state.MyModuleNS.config.color1+';">'+
            'Prova di stato'+
        '</span> '+
        '<span style="color: '+state.MyModuleNS.config.color2+';">'+
            'Script v'+state.MyModuleNS.version+' avviato '+(++state.MyModuleNS.count)+' volte!'+
        '</span>'
    );
});

Ricerca/Filtraggio di oggetti

L'API offre diverse funzioni di supporto che possono essere impiegate per individuare gli oggetti.

getObj(tipo, id)
Questa funzione recupera un singolo oggetto se vengono passati il tipo dell'oggetto e l'id. Si consiglia di utilizzare questa funzione piuttosto che le altre funzioni di ricerca, quando possibile, poiché è l'unica che non richiede l'iterazione dell'intera collezione di oggetti.

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

trovaOggetti(attributi)

Passare a questa funzione un elenco di attributi e restituirà tutti gli oggetti corrispondenti sotto forma di array. Si prega di notare che questa funzione opera su tutti gli oggetti di tutti i tipi in tutte le pagine, pertanto si consiglia di includere almeno un filtro per _type e _pageid se si lavora con oggetti da tavolo.

var currentPageGraphics = findObjs({                              
  _paginaid: Campaign().get("playerpageid"),                              
  _type: "graphic",                          
});
_.each(currentPageGraphics, function(obj) {    
  //Eseguire un'operazione con obj, che si trova nella pagina corrente ed è un elemento grafico.
});

È inoltre possibile passare un secondo argomento facoltativo che contiene un oggetto con un elenco di opzioni, tra cui:

• caseInsensitive(vero/falso): se vero, le proprietà delle stringhe saranno confrontate senza considerare le maiuscole e le minuscole della stringa.

var targetTokens = findObjs({
    name: "target"
}, {caseInsensitive: true});
//Restituisce tutti i segnalini con nome "target", "Target", "TARGET", ecc.

filtraObj (richiamo)

Eseguirà la funzione di callback fornita su ciascun oggetto e, se la callback restituisce true, l'oggetto sarà incluso nell'array dei risultati. Attualmente, si sconsiglia di utilizzare filterObjs() per la maggior parte degli scopi: poiché findObjs() dispone di un'indicizzazione integrata che garantisce una maggiore velocità di esecuzione, è quasi sempre preferibile utilizzare findObjs() per ottenere prima gli oggetti del tipo desiderato, quindi filtrarli utilizzando il metodo nativo .filter() per gli array.

var results = filterObjs(function(obj) {    
  if(obj.get("left") < 200 && obj.get("top") < 200) return true;    
  else return false;
});
//Results è un array di tutti gli oggetti che si trovano nell'angolo in alto a sinistra del tavolo di gioco.

getAllObjs()

Restituisce un array di tutti gli oggetti presenti nel gioco (di tutti i tipi). Equivalente a chiamare filterObjs e restituire semplicementetrueper ogni oggetto.

getAttrByName(id_carattere, nome_attributo, tipo_valore)

Ottiene il valore di un attributo, utilizzando il valore predefinito dalla scheda dei personaggi se l'attributo non è presente. value_typeè un parametro facoltativo che può essere utilizzato per specificare "current" o "max".

getAttrByNamerecupereràsoloil valore dell'attributo, non l'oggetto attributo stesso. Se si desidera fare riferimento a proprietà dell'attributo diverse da "current" o "max", o se si desidera modificare le proprietà dell'attributo, è necessario utilizzare una delle altre funzioni sopra indicate, comefindObjs.

Per le sezioni ripetute, è possibile utilizzare il formatorepeating_section_$n_attribute, dovenè il numero della riga ripetuta (a partire da zero). Ad esempio,repeating_spells_$2_namerestituirà il valore dinamedalla terza riga direpeating_spells.

È possibile ottenere un comportamento equivalente agetAttrByName conquanto segue:

// current e max dipendono completamente dall'attributo e dal sistema di gioco
// in questione; non esiste una funzione disponibile per determinarli automaticamente
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 attributo = findObjs({
        type: 'attribute',
        characterid: character_id,
        name: attribute_name
    }, {caseInsensitive: true}) [0];
    if (!attributo) {
        attributo = createObj('attributo', {
            characterid: character_id,
            name: attributo_name,
            current: attributo_default_current,
            max: attributo_default_max
        });
    }

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