library.getContents

From RPTools Wiki
Revision as of 06:22, 26 March 2024 by Azhrei (talk | contribs) (Changed 'syntaxhighlight' to 'source')
Jump to navigation Jump to search

library.getContents() Function

 Note: This function can only be used in a Trusted Macro

• Introduced in version 1.11.0
Retrieves a list of the content in the specified Add-On library. Information is returned as a JSON array.
  • For .mtlib Add-On libraries this will include a list of all MTScript, HTML, JavaScript and CSS files,
  • For lib:token Add-On libraries this will include a list of all macros and all defined Token Properties.

Usage

library.getContents(namespace)

Parameters

  • namespace - Namespace for the library.

Example

Get content information for the specified library. 
<pre>
[r: json.indent(library.getContents("net.rptools.addon.some-lib"),2)]
</pre>

Returns: Output from a .mtlib library: 

[
  "mtscript/public/auto_exec.mts",
  "mtscript/public/test1.mts",
  "public/test2.html",
  "mtscript/priv1.mts",
  "mtscript/public/test2.mts",
  "public/test1.html",
  "mtscript/public/CSSTest.mts",
  "mtscript/public/call_priv1.mts",
  "public/test-img.png",
  "mtscript/public/no_auto_exec.mts",
  "public/test1.css",
  "public/test1.js",
  "mtscript/public/myUDF.mts"
]

See Also

library.getInfo()

Version Changes

  • 1.11.0 - Function added
Retrieved from "https://wiki.rptools.info/index.php?title=library.getContents&oldid=17695"