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

Difference between revisions of "Script:Table Export"

From Roll20 Wiki

Jump to: navigation, search
(update to 0.2.4, add instructions)
m
 
Line 7: Line 7:
  
 
A script for exporting Rollable Tables between accounts.
 
A script for exporting Rollable Tables between accounts.
<br clear="all">
 
  
 
This script dumps commands to the chat for reconstructing a rollable table on another campaign. While this can be done on your own campaigns via the transmogrifier, this script allows you to pass those commands to a friend and thus share your own creative works with others.
 
This script dumps commands to the chat for reconstructing a rollable table on another campaign. While this can be done on your own campaigns via the transmogrifier, this script allows you to pass those commands to a friend and thus share your own creative works with others.
Line 43: Line 42:
  
 
* --<Avatar URL> — This is the URL for the avatar image of the table item.
 
* --<Avatar URL> — This is the URL for the avatar image of the table item.
 
 
  
 
=== Changelog ===
 
=== Changelog ===
 
{{changelog version|0.2.4|2019-12-19|* [https://github.com/Roll20/roll20-api-scripts/pull/889 link] }}
 
{{changelog version|0.2.4|2019-12-19|* [https://github.com/Roll20/roll20-api-scripts/pull/889 link] }}
 
{{changelog version|0.11|2015-02-01|* Release}}
 
{{changelog version|0.11|2015-02-01|* Release}}

Latest revision as of 14:07, 17 June 2020

API ScriptAuthor: Aaron C. M.
Version: 0.2.4
Last Modified: 2019-12-19
Code: TableExport
Dependencies: IsGM
Conflicts: None

A script for exporting Rollable Tables between accounts.

This script dumps commands to the chat for reconstructing a rollable table on another campaign. While this can be done on your own campaigns via the transmogrifier, this script allows you to pass those commands to a friend and thus share your own creative works with others.

Caveat: Avatar images that are not in your own library will be ignored by the API on import, but will not prevent creation of the table and table items.

Note: Running any of the following commands without any arguments will display help.

[edit] Commands

!export-table --<Table Name> [ --<Table Name> ...]

For all table names, case is ignored and you may use partial names so long as they are unique. For example, "King Maximillian" could be called "max" as long as "max" does not appear in any other table names. Exception: An exact match will trump a partial match. In the previous example, if a table named "Max" existed, it would be the only table matched for --max.

  • -- — This is the name of a table to export. You can specify as many tables as you like in a single command.


    !import-table --<Table Name> --<[ show | hide ]>

    This is the command output by !export-table to create the new table. You likely will not need issue these commands directly.

    • --
    — This is the name of the table to be create.
  • --<[ show | hide ]> — This whether to show the table to players or hide it.

  • !import-table-item --<Table Name> --<Table Item Name> --<Weight> --<Avatar URL>

    This is the command output by !export-table to create the new table. You likely will not need issue these commands directly.

    • --
    — This is the name of the table to add items to. Note: unlike for !export-table, this must be an exact name match to the created table.
    • --
    — This is the name of the table item to create. Note: Because the string -- may occur in a table item name, you may see [TABLEEXPORT:ESCAPE] show up as a replacement in these commands. This value is corrected internally to the correct -- sequence on import.
    • --<Weight> — This is the weight for this table item and should be an integer value.
    • --<Avatar URL> — This is the URL for the avatar image of the table item.

    [edit] Changelog

    v0.2.4 (2019-12-19)


    v0.11 (2015-02-01)

    • Release