findToken: Difference between revisions
Jump to navigation
Jump to search
m (Text replacement - "<source" to "<syntaxhighlight") |
m (Text replacement - "source>" to "syntaxhighlight>") |
||
| Line 9: | Line 9: | ||
findToken(name/ID) | findToken(name/ID) | ||
findToken(name/ID,mapname) | findToken(name/ID,mapname) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
{{param|name/ID|Either the name of the token or the ID.}} | {{param|name/ID|Either the name of the token or the ID.}} | ||
| Line 19: | Line 19: | ||
[h: id = findToken("Hero")] | [h: id = findToken("Hero")] | ||
[if (id == "", "Token not found!", "Token found")] | [if (id == "", "Token not found!", "Token found")] | ||
</ | </syntaxhighlight> | ||
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> | <syntaxhighlight lang="mtmacro" line> | ||
| Line 33: | Line 33: | ||
[r: name] found on map [r: getCurrentMapName()]. | [r: name] found on map [r: getCurrentMapName()]. | ||
}] | }] | ||
</ | </syntaxhighlight> | ||
}} | }} | ||
[[Category:Find Function]][[Category:Token Function]] | [[Category:Find Function]][[Category:Token Function]] | ||
Revision as of 17:48, 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
findToken(name/ID)
findToken(name/ID,mapname)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
[h: id = findToken("Hero")]
[if (id == "", "Token not found!", "Token found")]Search for token on current map and then search the map named Stash if not found.
<!-- Prompts for "TokenName" as it isn't already defined -->
[h: name = TokenName]
[h: id = findToken(name)]
[r, if(id == ""), code: {
Not on current map. Searching Stash.<br>
<!-- Search on the map named "Stash" -->
[h: id = findToken(name, "Stash")]
[r: if(id == "", name + " not found!", name + " found in Stash")]
};{
[r: name] found on map [r: getCurrentMapName()].
}]