General Utility - kyleady/Roll20-Rogue-Trader-API GitHub Wiki

The scrips within the General Utility section will include utility functions meant to simplify programming and/or full API Commands that can be used in any Roll20 game, no matter the system of rules that is being used.

API Commands

  • Find.js - API Command that allows players to use key words to search through every handout and character sheet they can view.
  • SendTo.js - API Command which allows the GM to send the party or a specific player to a map by keywords. Can also return players to the main party.
  • Where.js - API Command that allows the GM to quickly view where the party is and where each individual player who is on their own map is.

Functions, Objects, Prototype Extensions

  • AttributeValue.js - Function which allows quick access to/editting of character attributes. Generic monsters will read and write to the individual token before checking the monster character sheet they are based on.
  • CanViewAttribute.js - Function to retrieve player ids/all that can view the character that holds the Attribute, in the form of an array.
  • CentralInput.js - Object through which all of the user API Commands can be fed through. It will warn the user if the command they input was not recognized by any of your functions it contains.
  • DefaultCharacter.js - Function which tries to find the one character in the campaign that only the specified player controls.
  • EachCharacter.js - Function built off of _.each(), it takes the user msg and your function to load up and apply your function to each selected character.
  • GetLink.js - Function which takes a name and attempts to find a handout or character sheet with that exact name, creating an HTML link.
  • MatchingObjs.js - Functions which take in key phrases and custom search criteria to return an array of matching Roll20 Objects.
  • NumberModifier.js - Function which does very simple calculations from text.
  • ReadAll.js - Function which provides an adhoc solution to the problem of Handout/Characters having empty notes/gmnotes the first time they are viewed after each spin up.
  • StatHandler.js - Function which allows players to quickly view and edit their attributes.
  • TextHash.js - Prototype which can parse a text hash of strings into an object of strings or vice versa.
  • TitleCase.js - String Prototype extension which capitalizes the first letter in each word but sets the rest of the letters to lower case.
  • Whisper.js - Function which is a short hand for whispering directly to a player, specified by their id.