Difference between revisions of "Batclient triggers bard play helper"

Latest revision as of 16:12, 13 April 2017

SCRIPT_NAME = "bard_play_helper";
SCRIPT_DESC = "Bat client Script to help with BatMud bard plays.";

// ------------------------------------------------------------
// Author: I forget who originally authored this.
// Bogle/Pisano made modifications and wrote this usage.
// Questions/Comments to Pisano / Bogle in game.
// ------------------------------------------------------------

// ------------------------------------------------------------
// INSTRUCTIONS
// 0. Save this as bard_play_helper.bcs in the batclient/scripts directory. 
// 1. Go to the stage in Skeep and read the instructions there.
// 2. Write a play/performance/fight scene, whatever tickles your fancy.
// 3. Add the lines from your play to the bootup method, read the comments
//    for examples of different kinds of lines you can write.
// 4. Do a test run or two to find bugs.  Go to the room, wear your costume,
//    start your play and do a run through.  It is best to do this once solo
//    and then to get a friend to watch and make notes for fixes and
//    improvements.
// 5. To actually step through your lines type $bard_play_helper, this will
//    invoke the run() method which will execute one of the lines you added
//    in the bootup method.
// 6. If you want to restart from the beginning you can reload and boot up
//    scripts using the standard bat client macros /scriptreload then
//    /scriptbootup.  Seee http://batwiki.wx.fi/wiki/Triggers for details.
// ------------------------------------------------------------

void bootup() {
  clientGUI.printText("general", "LOADED: " + SCRIPT_NAME + " ('$"+SCRIPT_NAME+".help' for more info.)\n");
  counter = 0;

  // ------------------------------------------------------------
  // Begin writing your play here using say, emote and so on. These should
  // all be commands that work on the stage in Shadowkeep.
  // ------------------------------------------------------------
  // A command to start the play.
  lines.add("start play");

  // You can add lines to wear or change costumes.
  lines.add("enter curtain;ne;wear Jester;sw;e");

  // You can do emotes too.
  lines.add("emote strides onto the stage.");

  lines.add("say Friends, Romans, countrymen, lend me your ears.");
  lines.add("say Bob said, \"you must escape quotes.\"");

  // If you want to refer to yourself use <ME>.
  // This line will replace <ME> with the short name of your current costume.
  lines.add("emote Without a word <ME> pulls out three colorful juggling pins.");

  // You can whisper too:
  lines.add("whisper (a voice from off stage) hmm, I don't want to lose the crowd.");

  // A command to stop the play.
  lines.add("stop play");
}

// ------------------------------------------------------------
// You should not need to modify anything below here.
// ------------------------------------------------------------

void help() {
  clientGUI.printText("general", "*************************\n");
  clientGUI.printText("general", "Batmud Bard Play Helper Script\n");
  clientGUI.printText("general", "\nOpen this file in a text editor and read the top of the file for instructions.\n");
  clientGUI.printText("general", "*************************\n");
}

int counter = 0;
List lines = new ArrayList();

void showLine() {
    if (counter < lines.size()) {
        clientGUI.doCommand( lines.get(counter) );
        counter++;
    } else {
        clientGUI.printText("general", SCRIPT_NAME + ": Play is over, be sure to stop your play.\n" );
    }
}

void run() {
    showLine();
}