findToken: Difference between revisions
Jump to navigation
Jump to search
m (Text replacement - "<source" to "<syntaxhighlight") |
|||
| Line 6: | Line 6: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
findToken(name/ID) | findToken(name/ID) | ||
findToken(name/ID,mapname) | findToken(name/ID,mapname) | ||
| Line 16: | Line 16: | ||
|example= | |example= | ||
Search for token on current map | Search for token on current map | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: id = findToken("Hero")] | [h: id = findToken("Hero")] | ||
[if (id == "", "Token not found!", "Token found")] | [if (id == "", "Token not found!", "Token found")] | ||
</source> | </source> | ||
Search for token on current map and then search the map named ''Stash'' if not found. | Search for token on current map and then search the map named ''Stash'' if not found. | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
<!-- Prompts for "TokenName" as it isn't already defined --> | <!-- Prompts for "TokenName" as it isn't already defined --> | ||
[h: name = TokenName] | [h: name = TokenName] | ||
Revision as of 17:24, 14 March 2023
findToken() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.3b48
Finds a token on the current map by the token name, GM name, or ID and returns its id. If the optional mapname parameter is supplied that map will be searched instead. If the token is not found then an empty string "" is returned.
Usage
<syntaxhighlight lang="mtmacro" line> findToken(name/ID) findToken(name/ID,mapname) </source> Parameters
name/ID- Either the name of the token or the ID.mapname- Optional name of the map to search for the token on.
Example
Search for token on current map
<syntaxhighlight lang="mtmacro" line>
[h: id = findToken("Hero")]
[if (id == "", "Token not found!", "Token found")]
</source>
Search for token on current map and then search the map named Stash if not found.
<syntaxhighlight lang="mtmacro" line>
[h: name = TokenName]
[h: id = findToken(name)]
[r, if(id == ""), code: {
Not on current map. Searching Stash.
[h: id = findToken(name, "Stash")]
[r: if(id == "", name + " not found!", name + " found in Stash")]
};{
[r: name] found on map [r: getCurrentMapName()].
}]