[Script] Alter Bar on Token

Updates

• November 9th, 2014 12:01 am eastern (ver 1.1) ~ Added option to hide chat announcement and send to GM instead and option to always send to GM in addition to sending to the chat window.
  • To hide chat announcement, simply add any kind of text at the end of the macro. You CANNOT have any spaces in the value however. So you cannot do 1d8 + 4. It has to be something like 1d8+4 unless you're using a roll query like ?{Healed for|0}. Spaces will work in queries.
• November 8th, 2014 11:30 pm eastern (ver 1.0) ~ Cleaned up the script and made it smaller. Script will no longer edit the msg object and will not break other scripts that rely on the msg object.
• Old Update ~ Added variables to define the tag used to tell the script which bar to subtract from. These are Bar1Key, Bar2Key, and Bar3Key. In the script below, they are h, f, and m for (H)ealth, (F)atigue, and (M)ana.
• Old Update ~ Added a variable to define the names of the three bars. You must use this format: ["Bar1Name", "Bar2Name", "Bar3Name"] or else it will not work. These are only used if you set ANNOUNCE_CHANGE to true.
• Old Update ~ Added ANNOUNCE_CHANGE to send a message to the chat window to announce which token gained or lost points from which bar.
• Old Update ~ Added PREVENT_OVERMAX to prevent a bar from gaining enough points to go over its max value. If a max value is not set for a bar, this variable has no effect.
• Old Update ~ Added STOP_AT_ZERO to prevent the script from dropping the current value of the bar being altered to a value below zero.
• Old Update ~ Added an inline roll like look to the script. Currently not optional, but I will get to that. It has a tooltip so the GM can see the roll or value entered by the player but does NOT function like the full regular tooltip with highlighted numbers and such. That would make this script very much more complicated.

// VERSION INFO
	var AlterBars_Version = 1.1;

// FUNCTION DECLARATION
	var AlterScript = AlterScript || {};

on("chat:message", function (msg) {
	// Exit if not an api command...
	if (msg.type != "api") return;
	
	// Get the api command...
	var command = msg.content.split(" ", 1)[0];
	if (command === "!alter") AlterScript.Process(msg);
});

AlterScript.Process = function(msg, who) {
	// USER CONFIG
		// BAR CONFIGURATION - These are used to identify which bar to adjust. You can
		// also use any lowercase letters as well such as 'h' for hit points/health.
		var Bar1Key = "1";
		var Bar2Key = "2";
		var Bar3Key = "3";
		
		// BAR NAMES - These names are used if ANNOUNCE_CHANGE is set to true. The
		// format of the annoucement is: Name gained/lost # BarName.
		var BarNames = ["hit points", "hit points", "hit points"];
		
		// PREVENT OVERMAX - Set this variable to true to prevent the current value of
		// the bar from being greater than its max value. If there is no max value set,
		// it will not stop the current bar value from increasing.
		var PREVENT_OVERMAX = true;
		
		// ANNOUNCE CHANGE IN CHAT - Set to true to send a message to the chat window
		// showing which token gained or lost points and how much.
		var ANNOUNCE_CHANGE = true;
		
		// SEND TO GM - Set to true to send the results to the GM. This will also trigger
		// if a hidden change is sent.
		var ALERT_GM = false;
		
		// STOP AT ZERO - Prevents the current value of the bar from dropping below zero.
		var STOP_AT_ZERO = true;
	// END USER CONFIG
	
	// Get and/or create variables...
	var n = msg.content.split(" ");
	var who = msg.who;
	var Target = getObj("graphic", n[1]);
	var Bar = 0;
	Bar = (n[2].toLowerCase().toString() == Bar1Key) ? 1 : 0;
	Bar = (n[2].toLowerCase().toString() == Bar2Key) ? 2 : Bar;
	Bar = (n[2].toLowerCase().toString() == Bar3Key) ? 3 : Bar;
	if (Bar === 0) {
		sendChat("ERROR", "/w " + who.replace(" (GM)", "") + " That is not a valid bar.");
		return;
	}
	var AlterValue = n[3];
	var CurrentValue = parseInt(Target.get("bar" + Bar + "_value"));
	var MaxValue = parseInt(Target.get("bar" + Bar + "_max"));
	var NoAnnounce = n[4];
	
	// Check for a + or - sign...
	var Operand1 = AlterValue.charAt(0);
	var Operand2 = AlterValue.charAt(1);
	if (Operand2 === "+" || Operand2 === "-") AlterValue = AlterValue.substring(2);
	else if (Operand1 === "+" || Operand1 === "-") AlterValue = AlterValue.substring(1);
	
	// Save the value for the tooltip...
	var Expression = AlterValue;
	
	// Define CSS...
	var AddStyle = "display: inline-block; text-align: center; min-width: 1.75em; font-size: 1em; font-weight: bold; color:#040; background-color: #8C8; border: 1px solid #040; padding: -1px 2px; border-radius: 3px;";
	var MinusStyle = "display: inline-block; text-align: center; min-width: 1.75em; font-size: 1em; font-weight: bold; color:#600; background-color: #FAA; border: 1px solid #600; padding: -1px 2px; border-radius: 3px;";
	
	// Main process...
	sendChat("", "/r " + AlterValue, function(outs) {
		AlterValue = parseInt(JSON.parse(outs[0].content).total);
		var Tooltip = "Rolling " + Expression + " = " + AlterValue + "' class='a inlinerollresult showtip tipsy-n'";
		if (Operand1 != "-") {
			// Add to bar...
			if (PREVENT_OVERMAX) AlterValue = (AlterValue + CurrentValue > MaxValue) ? MaxValue - CurrentValue : AlterValue;
			if (ANNOUNCE_CHANGE && NoAnnounce == undefined) sendChat("DiceBot", Target.get("name") + " gained <span title='" + Tooltip + "' style='" + AddStyle + "'>" + AlterValue + "</span> " + BarNames[Bar-1] + ".");
			if (ALERT_GM || NoAnnounce != undefined) sendChat(who, "/w GM " + Target.get("name") + " gained <span title='" + Tooltip + "' style='" + AddStyle + "'>" + AlterValue + "</span> " + BarNames[Bar-1] + ".");
			Target.set("bar" + Bar + "_value", CurrentValue += AlterValue);
		} else {
			// Subtract from bar...
			if (STOP_AT_ZERO && (CurrentValue - AlterValue < 0)) AlterValue = CurrentValue;
			if (ANNOUNCE_CHANGE && NoAnnounce == undefined) sendChat("DiceBot", Target.get("name") + " lost <span title='" + Tooltip + "' style='" + MinusStyle + "'>" + AlterValue + "</span> " + BarNames[Bar-1] + ".");			
			if (ALERT_GM || NoAnnounce != undefined) sendChat(who, "/w GM " + Target.get("name") + " lost <span title='" + Tooltip + "' style='" + MinusStyle + "'>" + AlterValue + "</span> " + BarNames[Bar-1] + ".");
			Target.set("bar" + Bar + "_value", CurrentValue -= AlterValue);
		}			
	});
};

• Added an inline roll like look to the script. Currently not optional, but I will get to that. It has a tooltip so the GM can see the roll or value entered by the player but does NOT function like the full regular tooltip with highlighted numbers and such. That would make this script very much more complicated.

Updates

• November 8th, 2014 11:30pm eastern ~ Cleaned up the script and made it smaller. Script will no longer edit the msg object and will not break other scripts that rely on the msg object.

Updates

• November 9th, 2014 12:01 am eastern (ver 1.1) ~ Added option to hide chat announcement and send to GM instead and option to always send to GM in addition to sending to the chat window.
  • To hide chat announcement, simply add any kind of text at the end of the macro. You CANNOT have any spaces in the value however. So you cannot do 1d8 + 4. It has to be something like 1d8+4 unless you're using a roll query like ?{Healed for|0}. Spaces will work in queries.

The Aaron said:

When I see unexpected token errors, it's usually a copy paste problem with the script source, of a bug in the API editor that expands HTML Entities in the code. That would be the case of the error is immediate on save of the script.

If it is happening during a command, can you post the command you are running?

Try getting a fresh copy if the script. If that doesn't work, you can PM me an invite and I'll see if I can track it down.

Wade said:

Although, as a side note, this script doesn't seem to work with the Token Status Manager script.

The Aaron said:

Wade said:

Although, as a side note, this script doesn't seem to work with the Token Status Manager script.

How do you mean?

The Aaron said:

Yeah, adjusting the bars in code does not trigger an on('change:') event, so the script never gets activated.

There are ways you could fix that in the code, if it's important to you.

Wade said:

The Aaron said:

Yeah, adjusting the bars in code does not trigger an on('change:') event, so the script never gets activated.

There are ways you could fix that in the code, if it's important to you.

Nah, it's not really important. Just thought it was neat and might help me visually track things a little easier. I honestly have never used the Token Status Manager script before. Just came across it while updating the Alter script.

/**
 * Set various token markers based on bar cur/max ratios
 * 
 * The CONFIG array can have any number of configuration objects. These objects
 * are processed in order.
 * 
 * barId - The ID of the bar to look at the values for [1, 2, 3]
 * barRatio - The ratio of bar value to max value that triggers setting the status marker [0 - 1]
 * status - The name of the status marker to toggle [redmarker, bluemarker, greenmarker, brownmarker, purplemarker, dead]
 * whenLow - The state of the marker when the bar value is <= the ratio [true, false]
 */
var CONFIG = [
    // {barId: 1, barRatio: .5, status: "redmarker", whenLow: true},
    {barId: 1, barRatio: 0, status: "dead", whenLow: true}];
on("change:token", function(obj) {
    CONFIG.forEach(function(opts) {
        var maxValue = parseInt(obj.get("bar" + opts.barId + "_max"));
        var curValue = parseInt(obj.get("bar" + opts.barId + "_value"));
        //log(opts.barId + ": " + curValue + "/" + maxValue);
        if (maxValue != NaN && curValue != NaN) {
            var markerName = "status_" + opts.status;
            if (curValue <= (maxValue * opts.barRatio)) {
                obj.set(markerName, opts.whenLow);
            }
            else {
                obj.set(markerName, !opts.whenLow);
            }
        }
    });
});

The Aaron said:

You should really start a new thread for this kind of question. =D

When you do, be sure to include what you mean by "not work."