Character Vault
Any Concept / Any System
Your System Come To Life
Roll20 for Android
Streamlined for your Tablet
Roll20 for iPad
Streamlined for your Tablet

Personal tools

Difference between revisions of "API:Basic Examples"

From Roll20 Wiki

Jump to: navigation, search
(sendChat decisions)
Line 68: Line 68:

Revision as of 19:20, 19 August 2013

Roll20 API Getting Started


Cookbook (Examples)

Community Scripts

The Cookboox provides some examples of simple scripts that can help you get started. Feel free to take them and modify them for use in your own campaigns. There's also an API Scripts Forum where you can discuss API Scripting and share your scripts with the community.

Bloodied and Dead Status Markers

(Contributed by Ken Bauer)

This script automatically adds the Red marker to represent the "bloodied" state for any tokens that drop below half their health, and the "dead" market for any that drop to 0 or less. It's assumed that health is stored in Bar 1.

on("change:graphic", function(obj) {
    if(obj.get("bar1_max") === "") return;
    if(obj.get("bar1_value") <= obj.get("bar1_max") / 2) {
              status_redmarker: true
            status_redmarker: false

    if(obj.get("bar1_value") <= 0) {
         status_dead: true
    else {
        status_dead: false

The Darkness is Closing In...

This script reduces the light radius of a token by 10% every time that token moves. Great for simulating "lamps running out of oil" or similar high-stress situations.

on("change:token", function(obj, prev) {
    //Only do this if we actually moved.
    if(obj.get("left") == prev["left"] && obj.get("top") == prev["top"]) return;
        light_radius: Math.floor(obj.get("light_radius") * 0.90)

sendChat as a Player or Character

(Contributed by Brian Shields)

This is a few lines you can use in a chat:message event script to ensure you're sending a message with sendChat accurately as either a Player or a Character, depending on who triggered the event.

on("chat:message", function(msg) {
    var message = '';
    // Determine the contents of `message'
    var characters = findObjs({_type: 'character'});
    var speaking;
    characters.forEach(function(chr) { if(chr.get('name') == msg.who) speaking = chr; });
    if(speaking) sendChat('character|', message);
    else sendChat('player|'+msg.playerid, message);