findToken: Difference between revisions
Jump to navigation
Jump to search
(Function also accepts token ID as parameter.) |
(Added info on 2nd parameter map name.) |
||
| Line 8: | Line 8: | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
findToken(name/ID) | findToken(name/ID) | ||
findToken(name/ID,mapname) | |||
</source> | </source> | ||
'''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.}} | ||
{{param|mapname|Optional name of the map to search for the token on.}} | |||
|example= | |example= | ||
Search for token on current map | |||
<source lang="mtmacro" line> | <source 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. | |||
<source lang="mtmacro" line> | |||
<!-- 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()]. | |||
}] | |||
</source> | |||
}} | }} | ||
[[Category:Find Function]][[Category:Token Function]] | [[Category:Find Function]][[Category:Token Function]] | ||
Revision as of 13:05, 29 July 2019
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 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()].
}]