data.getStaticData: Difference between revisions
m (Apparently, the 'syntaxhighlight' tag must not have a leading space) |
Cold Ankles (talk | contribs) (New Category) |
||
Line 40: | Line 40: | ||
[[Category:Macro Function]] | [[Category:Macro Function]] | ||
[[Category:Add-on Library Functions]] | [[Category:Add-on Library Functions]] | ||
[[Category:Data Functions]] |
Revision as of 02:46, 4 May 2024
data.getStaticData() Function
Note: This function can only be used in a Trusted Macro
asset://
format so they can be used in image tags.Usage
[data.getStaticData(namespace, path)]
If called from outside of an add-on, getStaticData()
can only access files in the library/public/
directory.
Refer to Technical definition of Add-on Libraries for a description of the internal file structure of the add-on.
Example
my.name.space/library/public/testData.txt
file contained within the add-on library and display it in the chat panel.
Text will always be read as UTF-8, so ensure that you use that encoding when creating the content.
[r: data.getStaticData("my.name.space", "public/testData.txt")]
Returns the contents of the file, possibly with embedded control codes, such as \n
or similar.
This example retrieves the content of the my.name.space/library/example/testData2.txt
file from the my.name.space
add-on. This will only succeed when executed from within the add-on.
[r: data.getStaticData("my.name.space", "example/testData2.txt")]
Returns the contents of the file.
When called from within the code of the add-on, getStaticData()
can only access files in the library/
directory and subdirectories. For example, to display the contents of a testData2.txt
file in a directory library/example/
from one of the add-on's macros, use this line is the macro:
- Do NOT include the
library/
directory prefix when retrieving content. - The context menu for library tokens has the Export Library Token as Addon... option. This option creates a separate file in the add-on's
library/property/
directory for each non-empty property on the token. Given that they are not underlibrary/public
, they will not be accessible outside from the add-on. Move them intolibrary/public/
if you want them to be available. - If
getStaticData()
is unable to access the file, the result will be an empty string. - The full namespace of the add-on must be used (as defined by the
name
property in the add-on'slibrary.json
file). You cannot usethis
as the namespace — trying to do so will produce the error, "Library with namespace 'this' does not exist."