API: Objekte

Hinweis: Die Eigenschaft id eines Objekts ist eine weltweit eindeutige ID: Keine zwei Objekte sollten dieselbe ID haben, selbst über verschiedene Objekttypen hinweg nicht. Da außerdem häufig auf die ID eines Objekts zugegriffen wird und sich diese nie ändert, gibt es eine Abkürzung, mit der du darauf zugreifen kannst, indem du obj.id anstelle von obj.get("_id") verwendest, wenn du möchtest (beide funktionieren).

Pathv2 (auf der neuesten VTT-Engine verfügbar)

Die Eigenschaft Form hat die folgenden Werte:

• "pol" - Polylinie. Zwischen jedem aufeinanderfolgenden Punkt wird eine gerade Linie gezogen. Wenn der Anfangs- und der Endpunkt gleich sind, entsteht eine geschlossene Form.
• "frei" - Freihand. Es wird eine Kurve gezeichnet, wobei die Punkte als Hilfslinien dienen. Wenn der Anfangs- und der Endpunkt gleich sind, entsteht eine geschlossene Form.
• "eli" - Ellipse. Eine Ellipse wird mit Hilfe der Punkte gezeichnet, um einen Begrenzungsrahmen festzulegen. Nur die ersten beiden Punkte werden verwendet.
• "rec" - Rechteck. Ein Rechteck wird mit Hilfe der Punkte gezeichnet, um einen Begrenzungsrahmen festzulegen. Nur die ersten beiden Punkte werden verwendet.

Die Eigenschaft points ist ein JSON-String, der ein Array von Punkten enthält. Die Punkte werden als ein Array mit zwei Positionen dargestellt, das eine x- und eine y-Position enthält. Ein Dreieck von (0,0) zu (0,70) zu (70,0) und zurück zu (0,0) würde wie folgt dargestellt werden "[[0,0],[0,70],[70,0],[0,0]]".

Die Eigenschaften x und y positionieren das PathV2-Objekt auf der Seite. Sie geben an, wo die Mitte der Zeichnung sein soll. Für einige Formen (Ellipsen und Rechtecke) ist das ziemlich einfach herauszufinden. Für komplexere Formen (Polylinien und Freiflächen) musst du die Minimal- und Maximalwerte über die Punkteigenschaft ermitteln und den Punkt verwenden, der sich in gleicher Entfernung dazwischen befindet.

Pfad (Klassischer Spieltisch)

Weitere Informationen zum Format von_path-Daten finden Sie im Abschnitt zu Pfaden.

Fenster

Hinweis: Fenster und Tür verwenden im Vergleich zu anderen Objekttypen eine invertierte Achse. Zum Beispiel: Eine Variable für oben, die bei einem anderen Objekt den Wert 100 hätte, ist bei einem Fenster oder einer Tür y -100.

Beispiel

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

Tür

Hinweis: Fenster und Tür verwenden im Vergleich zu anderen Objekttypen eine umgekehrte Achse. Zum Beispiel wäre eine obere Variable, die bei einem anderen Objekt 100 beträgt, bei Fenster oder Tür y -100.

Text

Grafik (Spielmarker/Karte/Karte etc.)

Beispiel für Spielmarker

{
          "id":59, // die Datenbank-ID für
          „name“: „Bane“, // der Name (nicht eindeutig) des Markers
          ‚stichwort‘: ‚Bane::59‘, // wie der Spielmarker tatsächlich referenziert wird.
      // dies wird die ID für benutzerdefinierte Markierungen beinhalten, jedoch 
          // nicht für Standardmarkierungen.
          „url“: „https://s3.amazonaws.com/files.d20.io/images/59/yFnKXmhLTtbMtaq-Did1Yg/icon.png?1575153187“

          // ^die URL für das Bild des Spielmarkers
}

Wichtige Hinweise zu verknüpften Charakteren + Spielmarkern

Beachte, dass bei Spielmarkern, die mit Charakteren verknüpft sind, das Feld gesteuertVon für Zeichenfiguren das Feld gesteuertVon auf dem Spielmarker überschreibt.

Für Spielmarker-Leisten, die mit einem Attribut verknüpft sind, wird das Setzen eines Wertes am Spielmarker-Wert automatisch die zugrunde liegenden Attributwerte aktualisieren, sodass es nicht manuell gemacht werden muss.

Darüber hinaus werden Sie bei einer Änderung des Attributs (oder der Spielmarker-Leiste) im Spiel ein Änderung:Attribut (und eigenschaftsspezifisches Änderung:Attribut:Aktuell) Event hören, gefolgt von einem Änderung:Grafik (und Änderung:Grafik:bar1_Wert) Ereignis. Es kann auf jedes Ereignis reagiert werden, die zugrunde liegenden Werte werden jedoch beim ersten Attributfeuer nicht aktualisiert.

Wichtige Hinweise zu Status-Stichwörtern

Seit dem 6. August 2013 hat sich der Umgang mit Statusmarkierungen auf Spielmarkern geändert. Die Eigenschaft ‚statusmarkers‘ des Grafikobjekts ist jetzt eine durch Kommas getrennte Liste all der Farben und Symbole der Status-Stichwörter, die aktiv sein sollen. Das Format ist wie folgt:

//Komma getrennt (Verwenden von Verbinden um zu erstellen oder Trennen zur Wandlung in ein Array). 
//Wenn auf ein Statussymbol/eine Statusfarbe ein „@“-Symbol folgt, wird die Zahl nach 
//„@“ als Abzeichen auf dem Symbol angezeigt
Statusmarker = „rot,blau,schädel,tot,braun@“ 2,grün@6"

Sie können zwar direkt auf die Eigenschaftstatusmarkerszugreifen, um die Abwärtskompatibilität mit vorhandenen Skripten aufrechtzuerhalten und eine einfache Möglichkeit zu bieten, mit den Statusmarkierungen zu arbeiten, ohne Code schreiben zu müssen, um die Zeichenfolge selbst aufzuteilen und zu analysieren. Wir bieten jedoch eine Satz „virtueller“ Eigenschaften für das Objekt, die Sie festlegen/mit den Statusmarkierungen verwenden können. Jeder Statusmarker verfügt über die Eigenschaft „status_<markername>“. Zum Beispiel:

obj.get("status_red"); // Gibt „falsch“ zurück, wenn die Markierung nicht aktiv ist, „wahr“, wenn sie aktiv ist, und eine Zeichenfolge (z. B. „2“ oder „5“), wenn aktuell ein Abzeichen auf der Markierung gesetzt ist
obj.get('status_bluemarker'); // Wird aus Gründen der Abwärtskompatibilität weiterhin unterstützt und entspricht der Ausführung von obj.get("status_blue");
obj.set("status_red", false); // würde die Markierung entfernen
obj.set("status_skull", "2"); // würde ein Abzeichen von „2“ auf das Totenkopfsymbol setzen und es dem Spielmarker hinzufügen, wenn es nicht bereits aktiv ist.

Beachte, dass diese virtuellen Eigenschaften keine Ereignisse haben. Daher musst du change:graphic:statusmarkers verwenden, um auf Änderungen an den Statusmarkierungen eines Spielmarkers zu lauschen, und beispielsweise change:graphic:status_red ist KEIN gültiges Ereignis und wird niemals ausgelöst.

Die vollständige Liste der verfügbaren Statusmarkierungen (in der gleichen Reihenfolge, in der sie in der Markierungsleiste erscheinen):

„rot“, „blau“, „grün“, „braun“, „lila“, „rosa“, „gelb“, „tot“, „Schädel“, „schläfrig“, „halbherz“, „halbdunst“, „interdiction“, „Schnecke“, „Blitzspirale“, „Schlüssel“, „verkettetes Herz“, „chemischer Pfeil“, „Todeszone“, „trinkmich“, „Randriss“, „Ninja-Maske“, „Stoppuhr“, „Fischernetz“, „Overdrive“, „stark“, „Faust“, „Vorhängeschloss“, „Dreiblatt“, „flauschiger Flügel“, „verprügelt“, „betreten“, „gepfeilt“, „Aura“, „Rückenschmerzen“, „schwarze Flagge“, „blutendes Auge“, „Pfeilschild“, „gebrochenes Herz“, „Spinnennetz“, „zerbrochenes Schild“, „fliegende Flagge“, „radioaktiv“, „Trophäe“, „gebrochener Schädel“, „gefrorene Kugel“, „rollende Bombe“, „weißer Turm“, „zugreifen“, „schreiend“, „Granate“, „Wachgeschütz“, „Alle für einen“, „Engelskostüm“, „Zielscheibe“

Seite

Kampagne

 Zugreihenfolge

Die Zugreihenfolge ist eine JSON-Zeichenfolge, die die aktuelle Zugreihenfolgeliste darstellt. Es handelt sich um ein Array von Objekten. Derzeit kann die Zugreihenfolge jeweils nur Objekte von einer Seite enthalten – die aktuelle Seiten-ID für die Zugreihenfolge ist das Attribut „initiativepage“. Stelle sicher, dass du beide synchron hältst, da es sonst zu seltsamen Ergebnissen kommen kann.

Um mit der Zugreihenfolge zu arbeiten, solltest du JSON.parse() verwenden, um ein Objekt zu erhalten, das den aktuellen Status der Zugreihenfolge darstellt (HINWEIS: Überprüfe zunächst, ob es sich nicht um eine leere Zeichenfolge "" handelt... falls, initialisiere es selbst mit einem leeren Array). Hier ist ein Beispiel für ein Zugreihenfolge-Objekt:

[
    {
     "id":"36CA8D77-CF43-48D1-8682-FA2F5DFD495F", //Die ID des Grafikelements. Wenn dies eingestellt ist, zieht die Zugreihenfolgeliste automatisch den Namen und das Symbol für die Liste basierend auf der Grafik auf dem Spieltisch ein.
     „pr“: „0“, //Der aktuelle Wert für das Element in der Liste. Kann eine Zahl oder Text sein.
     "custom":"" // Benutzerdefinierter Titel für den Gegenstand. Wird ignoriert, wenn die ID auf einen anderen Wert als „-1“ gesetzt ist.
    },
    {
     „id“: „-1“, // Für benutzerdefinierte Elemente MUSS die ID auf „-1“ gesetzt werden (beachten Sie, dass dies ein STRING und keine ZAHL ist).
     „pr“: „12“,
     „custom“: „Test Custom“ // Der Name, der für benutzerdefinierte Elemente angezeigt werden soll.
    }
]

Um die Zugreihenfolge zu ändern, bearbeite das aktuelle Zugreihenfolge-Objekt und verwende dann JSON.stringify(), um das Attribut in der Kampagne zu ändern. Achte darauf, dass die Ordnung für die Zugreihenfolge in der Liste mit der Ordnung des Arrays übereinstimmt. Zum Beispiel fügt push() ein Element am Ende der Liste hinzu, unshift() fügt am Anfang hinzu, etc.

var zugreihenfolge;
if(Campaign().get("turnorder") == "") zugreihenfolge = []; // HINWEIS: Wir prüfen zunächst, ob die Zugreihenfolge nicht nur eine leere Zeichenfolge ist. Wenn ja, behandeln Sie es wie ein leeres Array.
else zugreihenfolge = JSON.parse(Campaign().get("turnorder"));

// Füge einen neuen benutzerdefinierten Eintrag am Ende der Zugreihenfolge hinzu.
turnorder.push({
    id: "-1",
    pr: "15",
    custom: "Turn Counter"
});
Campaign().set("turnorder", JSON.stringify(turnorder));

Spieler

Makro

Wurf-Tabelle

Tabellenelement 

Charakter

Attribut

 Wichtig: Lies den Hinweis unten zum Arbeiten mit Charakterblättern, um zu erfahren, wie sich die Standardwerte von Charakterblättern auf die Verwendung von Attributen auswirken.

Fähigkeit

Notiz

Hinweis: Die API hat keinen Zugriff auf die Ordnerhierarchie. Von der API erstellte Handouts werden auf der Stammebene platziert.

Deck

Beachte, dass es Hilfs-API-Methoden zum "Ziehen", "Austeilen" oder "Mischen" von Karten aus dem Deck gibt. SieheAPI-Update-Forumsbeitrag vom März 2018.

Karte

Hand

Beachte, dass jeder Spieler nur EINE Hand haben sollte.

Jukebox-Track

Benutzerdefinierte Effekte

imgsrc- und Avatar-Eigenschaftseinschränkungen

Auch wenn du die Eigenschaftenimgsrc und avatar jetzt bearbeiten kannst, haben wir zur Sicherheit aller Roll20-Benutzer die folgenden Einschränkungen für diese Eigenschaften eingeführt:

• Du musst eine Bilddatei verwenden, die in deine Roll20-Bibliothek hochgeladen wurde - keine externe Website (wie Imgur) und nicht den Roll20-Marktplatz. Es beginnt mit "https://s3.amazonaws.com/files.d20.io/images/" bei Bildern, die auf den Hauptserver hochgeladen wurden, oder "https://s3.amazonaws.com/files.staging.d20.io/images/" für Bilder auf dem Entwicklungsserver. Du kannst die Quell-URL eines Bildes mit den Entwicklertools deines Browsers anzeigen.

• Du musst die Abfragezeichenfolge in die URL einfügen – zum Beispiel "https://s3.amazonaws.com/files.staging.d20.io/images/123456/med.png?12345678", nicht nur "https://s3.amazonaws.com/files.staging.d20.io/images/123456/med.png"

• Für Grafikobjekte (Spielmarker) musst du die "Daumen"-Größe des Bildes verwenden. Es sollte wie folgt aussehen: "https://s3.amazonaws.com/files.staging.d20.io/images/123456/thumb.png?12345678".

In Zukunft könnten wir ein Werkzeug hinzufügen, damit Bilder speziell für die Verwendung mit Mod (API)-Skripten hochgeladen werden können, aber vorerst verwende einfach Bilder, die in deine eigene Bibliothek hochgeladen wurden. Beachte, dass wenn du ein Bild aus deiner Bibliothek löschst, es aus allen Spielen entfernt wird, die dieses Bild verwenden, einschließlich Spiele, die deine Mod (API) Skripte verwenden.

Verwendung der Felder "Notizen", "GMNotes" und "Bio" asynchron

Um auf die Felder "Notizen", "gmnotes" oder "bio" in Charakteren und Notizen zuzugreifen, musst du eine Rückruffunktion als zweites Argument an die get()-Funktion übergeben. Hier ist ein Beispiel:

var charakter = getObj("character", "-JMGkBaMgMWiQdNDwjjS");
charakter.get("bio", function(bio) {
    log(bio); // hier etwas mit der Charakterbiografie machen.
});

Du kannst den Wert dieser Felder wie gewohnt festlegen. Beachte, dass es derzeit (Stand 09.05.2016) einen Fehler bei diesen asynchronen Feldern gibt, durch den das Setzen dieser Felder durch das Übergeben von Werten an createObj stillschweigend fehlschlägt und das Objekt in einem seltsamen Zustand hinterlässt. Du solltest diese Werte nur mit .set festlegen, bis dieses Problem behoben ist. Details im Forum. Es gibt auch einen Fehler (Stand 05.11.2016), bei dem das Festlegen der Eigenschaften 'notes' und 'gmnotes' im selben set()-Aufruf dazu führt, dass die zweite Eigenschaft im Aufruf fälschlicherweise festgelegt wird. Details im Forum.

Arbeiten mit Charakterbögen

Die Funktion 'Charakterbögen' hat Einfluss auf die Verwendung des Objekttyps 'Attribut', weil die Bögen die Möglichkeit bieten, für jedes Attribut einen Standardwert anzugeben. Wenn das Attribut jedoch auf den Standardwert gesetzt ist, gibt es im Spiel noch kein tatsächliches Attribut-Objekt für diesen Charakter. Wir bieten eine einfache Funktion an, die diese Komplexität vor dir verbirgt. Du solltest diese Funktion verwenden, um den Wert eines Attributs künftig zu ermitteln, besonders wenn du weißt, dass im Spiel Charakterbögen verwendet werden.

getAttrByName(character_id, attribute_name, value_type)

Gib einfach die ID des Charakters, den Namen (nicht die ID) des Attributs (z. B. "HP" oder "Str") an und ob du den "current" oder "max" für den Werttyp möchtest. Hier ist ein Beispiel:

var Charakter = getObj("character", "-JMGkBaMgMWiQdNDwjjS");
getAttrByName(character.id, "str"); // der aktuelle Wert von str, zum Beispiel „12“
getAttrByName(character.id, "str", "max"); //der Maximalwert von str, zum Beispiel „[[floor(@{STR}/2-5)]]“

Beachte, dass Felder mit automatisch berechneten Werten die Formel und nicht das Ergebnis des Werts zurückgeben. Du kannst diese Formel dann an sendChat() übergeben, um die Dice-Engine zur automatischen Berechnung des Ergebnisses für dich zu verwenden.

Schau dir unbedingt auch die Dokumentation zum Charakterbogen an, um weitere Informationen darüber zu erhalten, wie die Charakterbögen mit der API interagieren.

getAttrByName holt nur den Wert des Attributs, nicht das Attributobjekt selbst. Wenn du auf andere Eigenschaften des Attributs als „current“ oder „max“ verweisen oder Eigenschaften des Attributs ändern möchtest, musst du eine der anderen oben genannten Funktionen verwenden, z. B. findObjs.

Falls das angeforderte Attribut nicht existiert, gibt getAttrByName() undefined zurück.

Objekte erschaffen

createObj(Typ, Attribute)

Hinweis: Derzeit kannst du die Objekte „Grafik“, „Text“, „Pfad“, „Charakter“, „Fähigkeit“, „Attribut“, „Handout“, „Rollabletable“, „Tableitem“ und „Makro“ erschaffen.

Du kannst mit der Funktion createObj ein neues Objekt im Spiel erschaffen. Du musst den Typ des Objekts (eine der gültigen _type Eigenschaften aus der obigen Objektliste) sowie ein attribute-Objekt übergeben, das eine Liste von Eigenschaften für das Objekt enthält. Beachte, dass du die ID des übergeordneten Objekts in der Liste der Eigenschaften übergeben musst, wenn das Objekt ein übergeordnetes Objekt hat (z. B. Attribute und Fähigkeiten gehören zu Charakteren, Grafiken, Texte und Pfade gehören zu Seiten usw.). Beispielsweise musst du beim Erstellen eines Attributs die Eigenschaft characterid einbeziehen. Beachte, dass du beim Erstellen neuer Objekte keine schreibgeschützten Eigenschaften festlegen kannst, diese werden automatisch auf ihren Standardwert gesetzt. Die einzige Ausnahme hiervon besteht darin, dass du beim Erschaffen eines Pfads die Eigenschaft „Pfad“ einbeziehen musst, diese jedoch nicht mehr geändert werden kann, sobald der Pfad zum ersten Mal erschaffen wurde.

createObj gibt das neue Objekt zurück, sodass du damit weiterarbeiten kannst.

// Erschaffe ein neues Stärkeattribut für alle Charaktere, die dem Spiel hinzugefügt werden.
on("add:character", function(obj) {
    createObj("attribute", {
        name: "Strength",
        current: 0,
        max: 30,
        characterid: obj.id
    });
});

Objekte löschen

object.remove()

Hinweis: Derzeit können Sie die Objekte „Grafik“, „Text“, „Pfad“, „Charakter“, „Fähigkeit“, „Attribut“, „Handout“, „Rollabletable“, „Tableitem“ und „Makro“ löschen.

Du kannst mit der Funktion .remove() vorhandene Spielobjekte löschen. Die Funktion .remove() funktioniert bei allen Objekten, die du mit der Funktion createObj erschaffen kannst. Du rufst die Funktion direkt auf dem Objekt auf. Beispiel: mycharacter.remove();.

Globale Objekte

Es gibt mehrere Objekte, die überall in deinem Skript global verfügbar sind.

Campaign() (Funktion)

Eine Funktion, die das Campaign-Objekt zurückgibt. Da es nur eine Kampagne gibt, verweist dieses global immer auf die einzige Kampagne im Spiel. Nützlich, um beispielsweise mit Campaign().get("playerpageid") zu überprüfen, ob sich ein Objekt auf der aktiven Seite befindet.

state

Die Variable state ist ein Objekt im globalen Bereich, auf das alle in einem Spiel ausgeführten Skripte zugreifen können. Du kannst jederzeit von jeder Funktion oder jedem Callback aus auf das state-Objekt zugreifen, indem du einfach die globale Variable mit dem Namen state verwendest. Zusätzlich bleibt das state-Objekt zwischen den Ausführungen der Sandbox bestehen, sodass du es verwenden kannst, um Informationen zu speichern, die in zukünftigen Ausführungen deines Skripts verfügbar sein sollen.

Hinweis: Du solltest das state-Objekt verwenden, um Informationen zu speichern, die nur von der API benötigt werden, da diese nicht an Spieler-Computer gesendet werden und deine Spieldatei nicht größer machen. Speichere Werte, die im Spiel benötigt werden, in den Eigenschaften der Roll20-Objekte.

Speicherbare Typen

Das state-Objekt ist nur in der Lage, einfache Datentypen beizubehalten, wie sie vom JSON-Standard unterstützt werden.

Warnung: Während Funktionen zunächst zu funktionieren scheinen, wenn sie im state gespeichert werden, verschwinden sie, wenn der state zum ersten Mal aus der Persistenz wiederhergestellt wird, z. B. bei einem Sandbox-Neustart.

• Hinweis: Dazu gehören Roll20-Objekte, die du aus Ereignissen oder den Funktionen findObjs(), getObj(), filterObjs(), createObj() usw. erhältst.

Wichtige Erinnerungen

Das state-Objekt wird von allen Skripten in einer Sandbox gemeinsam genutzt. Um zu verhindern, dass andere Skripte beschädigt werden, ist es wichtig, einige einfache Richtlinien zu befolgen:

• Niemals direkt dem Stamm-state-Objekt zuweisen.

state = { break: 'all the things' };  // TUN DAS NIEMALS!!!

• Vermeide die Verwendung lokaler Variablen mit dem Namen state in deinen Skripten. Dies funktioniert zwar, ist jedoch für spätere Benutzer Ihrer Skripte verwirrend und kann zu Problemen führen, wenn der Code unvorsichtig bearbeitet wird.

function turn(){
    var state = Campaign().get('turnorder'); // Schlechte Praxis, vermeide sie!
    // ...
}

• Immer platziere deine Eigenschaften unter mindestens einer Namespace-Eigenschaft. Stellen Sie sicher, dass Sie eine ausreichend beschreibende Namespace-Eigenschaft verwenden. Vermeiden Sie Namen wieSkriptoderEinstellungen. Am besten verwenden Sie entweder den Namen Ihres Moduls oder Ihren eigenen Namen bzw. Handle.

if( ! state.MyModuleNamespace ) {
    state.MyModuleNamespace = { module: 'my module', ok: 'das ist in Ordnung!', count: 0 };
}
state.MyModuleNamespace.count++;

Beispielverwendung

Dies ist ein funktionierendes Beispiel, das das state-Objekt entsprechend verwendet.

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

    // Überprüfe, ob die Namespace-Eigenschaft vorhanden ist, und erstelle sie, wenn nicht.
    if( ! state.MyModuleNS ) {
        state.MyModuleNS = {
            version: 1.0,
            config: {
                color1: '#ff0000',
                color2: '#0000ff'
            },
            count: 0
        };
    }

    // Verwendung der state-Eigenschaften zum Konfigurieren einer Nachricht an den Chat. 
    sendChat(
        'Test Module',
        '<span style="color: '+state.MyModuleNS.config.color1+';">'+
            'State test'+
        '</span> '+
        '<span style="color: '+state.MyModuleNS.config.color2+';">'+
            'Script v'+state.MyModuleNS.version+' started '+(++state.MyModuleNS.count)+' times!'+
        '</span>'
    );
});

Objekte finden/filtern

Die API stellt mehrere Hilfsfunktionen zur Verfügung, die du zum Auffinden von Objekten verwenden kannst.

getObj(type, id)
Diese Funktion ruft ein einzelnes Objekt ab, wenn der _type des Objekts und die _id übergeben werden. Es ist am besten, diese Funktion nach Möglichkeit den anderen Suchfunktionen vorzuziehen, da sie die einzige ist, die nicht die gesamte Sammlung von Objekten durchlaufen muss.

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

findObjs(attrs)

Übergebe dieser Funktion eine Liste von Attributen, und sie gibt alle übereinstimmenden Objekte als Array zurück. Beachte, dass dies für alle Objekte aller Typen auf allen Seiten gilt – daher möchtest du wahrscheinlich mindestens einen Filter für _type und _pageid einschließen, wenn du mit Tabletop-Objekten arbeitest.

var currentPageGraphics = findObjs({                              
  _pageid: Campaign().get("playerpageid"),                              
  _type: "graphic",                          
});
_.each(currentPageGraphics, function(obj) {    
  //Machen Sie etwas mit obj, das sich auf der aktuellen Seite befindet und eine Grafik ist.
});

Sie können auch ein optionales zweites Argument übergeben, das ein Objekt mit einer Liste von Optionen enthält, einschließlich:

• caseInsensitive (true/false): Wenn true, werden Zeichenfolgen-Eigenschaften ohne Rücksicht auf die Groß-/Kleinschreibung der Zeichenfolge verglichen.

var targetTokens = findObjs({
    name: "target"
}, {caseInsensitive: true});
// Gibt alle Token mit einem Namen wie 'target', 'Target', 'TARGET' usw. zurück.

filterObjs(callback)

Führt die bereitgestellte Rückruffunktion für jedes Objekt aus. Wenn der Rückruf „true“ zurückgibt, wird das Objekt in das Ergebnisarray aufgenommen. Derzeit ist es für die meisten Zwecke nicht ratsam, filterObjs() zu verwenden – da findObjs() über eine integrierte Indizierung für eine bessere Ausführungsgeschwindigkeit verfügt, ist es fast immer besser, findObjs() zu verwenden, um Objekte des gewünschten Typs abzurufen Zuerst filtern Sie sie dann mit der nativen .filter()-Methode für Arrays.

var results = filterObjs(function(obj) {    
  if(obj.get("left") < 200 && obj.get("top") < 200) return true;    
  else return false;
});
// Ergebnisse ist ein Array aller Objekte, die sich in der oberen linken Ecke des Spieltisches befinden.

getAllObjs()

Gibt ein Array aller Objekte im Spiel (alle Typen) zurück. Entspricht dem Aufruf von filterObjs und der Rückgabe von true für jedes Objekt.

getAttrByName(character_id, attribute_name, value_type)

Ruft den Wert eines Attributs ab und verwendet dabei den Standardwert aus dem Charakterbogen, wenn das Attribut nicht vorhanden ist. value_type ist ein optionaler Parameter, mit dem du 'current' oder 'max' angeben kannst.

getAttrByName holt nur den Wert des Attributs, nicht das Attributobjekt selbst. Wenn du auf andere Eigenschaften des Attributs als „current“ oder „max“ verweisen oder Eigenschaften des Attributs ändern möchtest, musst du eine der anderen oben genannten Funktionen verwenden, z. B.findObjs.

Für sich wiederholende Abschnitte kannst du das Formatrepeating_section_$n_attribute verwenden, wobeindie Nummer der sich wiederholenden Zeile ist (beginnend mit Null). Beispielsweise wird repeating_spells_$2_name den Wert von name aus der dritten Zeile von repeating_spells zurückgeben.

Du kannst ein Verhalten erreichen, das getAttrByName entspricht, indem du Folgendes tust:

// current und max sind vollständig abhängig vom Attribut und dem Spielsystem
// in Frage; Es gibt keine Funktion, um sie automatisch zu ermitteln.
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 || 'aktuell';

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