library.getInfo: Difference between revisions
Jump to navigation
Jump to search
(Created page with "{{MacroFunction |name=library.getInfo |proposed=true |trusted=false |version=1.11.0 |description= Retrieves various information about a loaded Add-On library. Information is r...") |
m (Oops, it's "source" that should be replaced with "syntaxhighlight") |
||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{MacroFunction | {{MacroFunction | ||
|name=library.getInfo | |name=library.getInfo | ||
|proposed= | |proposed=false | ||
|trusted=false | |trusted=false | ||
|version=1.11.0 | |version=1.11.0 | ||
| Line 39: | Line 39: | ||
|also= | |also= | ||
{{func|library.getContents}}, {{func|library.listAddOnLibraries}}, {{func|library.listTokenLibraries}} | {{func|library.getContents}}, {{func|library.listAddOnLibraries}}, {{func|library.listTokenLibraries}} | ||
|changes= | |changes= | ||
* '''1.11.0''' - Function added | * '''1.11.0''' - Function added | ||
}} | }} | ||
[[Category:Library Function]] | [[Category:Library Function]] | ||
[[Category:Add-on Library Functions]] | |||
Latest revision as of 04:19, 11 February 2024
library.getInfo() Function
• Introduced in version 1.11.0
Retrieves various information about a loaded Add-On library. Information is returned as a JSON object.
- For
.mtlibAdd-On libraries this information comes from thelibrary.jsonfile inside of the.mtlibfile. Information is the same as that returned by library.listAddOnLibraries(). - For lib:token Add-On libraries this information comes from the Token Properties of the lib:token. Information is the same as that returned by library.listTokenLibraries().
Usage
library.getInfo(namespace)Parameters
namespace- The namespace of the library.
Example
Retrieves the info for the
.mtlib library net.rptools.addon.some-lib.
<pre>[r: json.indent(library.getInfo("net.rptools.addon.some-lib"),2)]</pre>Returns:
[{
"name": "some-lib",
"namespace": "net.rptools.addon.some-lib",
"version": "1.0.0",
"website": "www.rptools.net",
"gitUrl": "github.com/RPTools/maptool",
"authors": ["RPTools Team"],
"license": "GPL 3.0",
"description": "My new test library for stuff",
"shortDescription": "test library",
"allowsUrlAccess": true
}]
See Also
Version Changes
- 1.11.0 - Function added