getLibProperty: Difference between revisions
Jump to navigation
Jump to search
m (Added reference to add-ons; cleanup of grammar/formatting) |
No edit summary |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 7: | Line 7: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getLibProperty(name) | getLibProperty(name) | ||
getLibProperty(name, lib) | getLibProperty(name, lib) | ||
</ | </syntaxhighlight > | ||
{{Note|{{Clarify|This block and its example seem to be outdated. Testing is required and this page corrected, if necessary.}} | {{Note|{{Clarify|This block and its example seem to be outdated. Testing is required and this page corrected, if necessary.}} | ||
| Line 16: | Line 16: | ||
For example, suppose a property named {{code|Weapons}} has a default value of "{{code|Shotgun, Pistol}}". | For example, suppose a property named {{code|Weapons}} has a default value of "{{code|Shotgun, Pistol}}". | ||
If you leave the value on the library token unchanged, it will appear to contain the value "{{code|Shotgun, Pistol}}" in places like the stat sheet, but this function will return an empty string. | If you leave the value on the library token unchanged, it will appear to contain the value "{{code|Shotgun, Pistol}}" in places like the stat sheet, but this function will return an empty string. | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[getLibProperty("Weapons", "lib:Compendium")] | [getLibProperty("Weapons", "lib:Compendium")] | ||
</ | </syntaxhighlight > | ||
Returns an empty string. | Returns an empty string. | ||
| Line 24: | Line 24: | ||
|examples= | |examples= | ||
To get the "init" [[Token:token property|token property]] from the [[Token:library token|library token]] that a macro is running from use | To get the "init" [[Token:token property|token property]] from the [[Token:library token|library token]] that a macro is running from use | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[getLibProperty("init")] | [getLibProperty("init")] | ||
</ | </syntaxhighlight > | ||
To get the "init" [[Token:token property|token property]] from the [[Token:library token|library token]] if the library token has such a property. If not, use a default value of "{{code|default}}". | To get the "init" [[Token:token property|token property]] from the [[Token:library token|library token]] if the library token has such a property. If not, use a default value of "{{code|default}}". | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[result = getLibProperty("init")] | [result = getLibProperty("init")] | ||
[if(result == ""): result = "default" ] | [if(result == ""): result = "default" ] | ||
</ | </syntaxhighlight > | ||
To get the "init" [[Token:token property|token property]] from a [[Token:library token|library token]] called | To get the "init" [[Token:token property|token property]] from a [[Token:library token|library token]] called {{code|lib:Attacks}} use | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[getLibProperty("init", "lib:Attacks")] | [getLibProperty("init", "lib:Attacks")] | ||
</ | </syntaxhighlight > | ||
|changes= | |changes= | ||
'''Updated in 1.11:''' | '''Updated in 1.11:''' | ||
| Line 43: | Line 43: | ||
This modification allows the namespace of the add-on library to be used where the {{code|Lib:}} token name would normally appear. For example, | This modification allows the namespace of the add-on library to be used where the {{code|Lib:}} token name would normally appear. For example, | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: getLibProperty("defaultStrength", "com.myname.mt.my-first-addon")] | [h: getLibProperty("defaultStrength", "com.myname.mt.my-first-addon")] | ||
</ | </syntaxhighlight > | ||
}} | }} | ||
[[Category:Token Library Function]] | [[Category:Token Library Function]] | ||
[[Category:Property Function]] | [[Category:Property Function]] | ||
[[Category:Add-on Library Functions]] | |||
Latest revision as of 23:59, 29 February 2024
getLibProperty() Function
• Introduced in version 1.3b48
Returns the value of a token property from a library token. If the lib argument is not specified then the token property will be retrieved from the library token that the macro is currently running from, or produce an error if the current macro is not on a library token.
Unlike getProperty(), this function will not retrieve the default value of a campaign property. Default values are generally programmed as local variables in a macro, then overridden with the result of this function if this function returns a value. An example is shown below.
Usage
getLibProperty(name)
getLibProperty(name, lib)
Needs Clarification:
This block and its example seem to be outdated. Testing is required and this page corrected, if necessary.
For example, suppose a property named Weapons has a default value of "Shotgun, Pistol".
If you leave the value on the library token unchanged, it will appear to contain the value "Shotgun, Pistol" in places like the stat sheet, but this function will return an empty string.
[getLibProperty("Weapons", "lib:Compendium")]Returns an empty string.
It may help to review some relevant functions that apply to regular token properties, getProperty(), getPropertyDefault(), and resetProperty().
Examples
To get the "init" token property from the library token that a macro is running from use
[getLibProperty("init")]To get the "init" token property from the library token if the library token has such a property. If not, use a default value of "default".
[result = getLibProperty("init")]
[if(result == ""): result = "default" ]To get the "init" token property from a library token called lib:Attacks use
[getLibProperty("init", "lib:Attacks")]Version Changes
Updated in 1.11:
MTscript functions for acting on library tokens have been modified to also work on Add-on libraries.
This modification allows the namespace of the add-on library to be used where the Lib: token name would normally appear. For example,
[h: getLibProperty("defaultStrength", "com.myname.mt.my-first-addon")]