getLibProperty

From RPTools Wiki
Jump to navigationJump to search

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. 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)

Important Note As mentioned in the introduction, if the value of the property on the Token equals the default value, the function will return nothing! This means that if e.g. you set the default property to

Weapons : Shotgun, Pistol, Revolver

And you leave the e.g. the value on the token lib:Compendium unchanged, so it will also contain the value "Shotgun, Pistol, Revolver", then

[getLibProperty("Weapons", "lib:Compendium")]

will return nothing!

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")]