getLibProperty: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
Line 4: Line 4:
|description=Returns the value of a [[Token:token property{{!}}token property]] from a [[Token:library token{{!}}library token]]. If the lib argument is not specified then the [[Token:token property{{!}}token property]] will be retrieved from the [[Token:library token{{!}}library token]] that the macro is currently running from.
|description=Returns the value of a [[Token:token property{{!}}token property]] from a [[Token:library token{{!}}library token]]. If the lib argument is not specified then the [[Token:token property{{!}}token property]] will be retrieved from the [[Token:library token{{!}}library token]] that the macro is currently running from.


This function will CANNOT be used to retrieve a default value on a lib token. The property value on the lib must be entered manually and must be different from any default values (the use of which is discouraged on lib tokens).
Unlike {{func|getProperty}}, this function will not retrieve the default value of a campaign property. The property value on the lib must be entered manually and must be different from any default values (the use of which is discouraged on lib tokens).


|usage=
|usage=

Revision as of 20:24, 30 June 2009

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. The property value on the lib must be entered manually and must be different from any default values (the use of which is discouraged on lib tokens).

Usage

getLibProperty(name)
getLibProperty(name, lib)

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 a library token called "lib:Attacks" use.

[getLibProperty("init", "lib:Attacks")]