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

Personal tools

API:A Guide to the API

From Roll20 Wiki

Revision as of 06:32, 20 May 2013 by Alex L. (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search


What This Guide is and what it isn’t!

This guide will explain what the API is, using examples give the user a basic idea of how to use the API, and lay down some best practices for its use. This guide is not here to teach you basic programming concepts; but it will cover some “advanced” ideas that will be necessary for your code to not interfere with other scripts.

What is the API?

What we as the community refer to as the API is actually acomplicated scripting system of many different parts.

Here is some terminology I will for each part of what wecall the API:

  • The Environment or Sandbox – You can think ofthis as a virtual machine that runs the code you enter into the scriptingwindow.
  • The API (Application programming interface) –The actual API is a JavaScript library that gives access to the inner workingsof Roll20.

Prior Knowledge

To understand this guide I expect you to have a basicunderstanding of general programming, without this there is no point in readingany more of this guide.

To start learning about general programming and more specificallyJavaScript please check out codecademy.