library.getInfo

 Note: This refers to a proposed change that has not been implemented in the main code base yet.

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 .mtlib Add-On libraries this information comes from the library.json file inside of the .mtlib file. 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

library.getContents(), library.listAddOnLibraries(), library.listTokenLibraries()

Version Changes

• 1.11.0 - Function added