MTscript functions related to Add-on libraries: Difference between revisions
Jump to navigation
Jump to search
(Created page with "= MTScript Add-on Library functions = The following functions have been added to MapTool Macro Script to work with add-on libraries. * {{func|library.getInfo}} * {{func|library.listAddOnLibraries}} * {{func|library.listTokenLibraries}} * {{func|library.getContents}}") |
m (Added additional notes regarding use of add-on libraries) |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
= MTScript Add-on Considerations = | |||
There are some differences to be aware of when using library token property support for manipulating add-ons. | |||
* The name field is case-sensitive when accessing an add-on library. | |||
* The values stored do not need to be converted to or from strings like they do with library token properties, so in many cases large json values should see a speed improvement. | |||
* The default properties list for the campaign are not present for add-ons as they are not tokens. | |||
= MTScript Add-on Library functions = | = MTScript Add-on Library functions = | ||
The following functions have been added to | The following functions have been added to MTScript to query information related to [[Add-On Library|Add-On Libraries]]: | ||
* {{func|library.getInfo}} | * {{func|library.getInfo}} | ||
| Line 7: | Line 15: | ||
* {{func|library.listTokenLibraries}} | * {{func|library.listTokenLibraries}} | ||
* {{func|library.getContents}} | * {{func|library.getContents}} | ||
The following MTScript functions can be used to interact with Add-on Libraries: | |||
* To read data from files in the add-on Library: {{func|data.getStaticData}} | |||
* To run macros in the add-on Library: [[macro (roll option)]] | |||
* To add or change properties within an add-on: | |||
** {{func|setLibProperty}} | |||
** {{func|getLibProperty}} | |||
** {{func|getLibPropertyNames}} | |||
** {{func|getMatchingLibProperties}} | |||
Latest revision as of 23:59, 11 February 2024
MTScript Add-on Considerations
There are some differences to be aware of when using library token property support for manipulating add-ons.
- The name field is case-sensitive when accessing an add-on library.
- The values stored do not need to be converted to or from strings like they do with library token properties, so in many cases large json values should see a speed improvement.
- The default properties list for the campaign are not present for add-ons as they are not tokens.
MTScript Add-on Library functions
The following functions have been added to MTScript to query information related to Add-On Libraries:
The following MTScript functions can be used to interact with Add-on Libraries:
- To read data from files in the add-on Library: data.getStaticData()
- To run macros in the add-on Library: macro (roll option)
- To add or change properties within an add-on: