isOwner: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) (Applied Template:MacroFunction) |
No edit summary |
||
| (13 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
{{MacroFunction | {{MacroFunction | ||
|name=isOwner | |name=isOwner | ||
|version=1.3b48 | |||
|description= | |description= | ||
Returns | Returns {{true}} if the given Player is an owner of a specific [[Token]]. | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
isOwner() | |||
</ | isOwner(player) | ||
isOwner(player, tokenRef) | |||
isOwner(player, tokenRef, mapRef) | |||
</syntaxhighlight> | |||
'''Parameters''' | |||
{{param|player|The name of the player to check for ownership, defaults to the [[getPlayerName|Current Player]]. }} | |||
{{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token which is checked for ownership, defaults to the [[Current Token]]. {{TrustedParameter}} }} | |||
{{param|mapRef|The Name or ID of the map to find the token. Defaults to the current map.}} | |||
{{Note|Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.}} | |||
|examples= | |examples= | ||
< | Returns {{code|You can edit me.}} if the [[getPlayerName|Current Player]] is an owner of the [[Current Token]]. | ||
<syntaxhighlight lang="mtmacro" line> | |||
[r, if(isOwner()): "You can edit me."] | [r, if(isOwner()): "You can edit me."] | ||
</ | </syntaxhighlight> | ||
Returns {{code|Azhrei can edit me.}} if the given Player is an owner of the given [[Token]]. | |||
<syntaxhighlight lang="mtmacro" line> | |||
[h: id = getSelected() ] | |||
[r, if(isOwner("Azhrei", id)): "Azhrei can edit me."] | |||
</syntaxhighlight> | |||
|also= | |||
[[getOwners|getOwners()]], | |||
[[isOwnedByAll|isOwnedByAll()]] | |||
|changes= | |||
{{change|1.3b51|Added {{code|id}} parameter option.}} | |||
{{change|1.5.4|Added {{code|mapname}} parameter option.}} | |||
}} | }} | ||
[[Category:Token Function]] | [[Category:Token Function]] | ||
Latest revision as of 23:59, 17 May 2024
isOwner() Function
• Introduced in version 1.3b48
Usage
isOwner()
isOwner(player)
isOwner(player, tokenRef)
isOwner(player, tokenRef, mapRef)Parameters
player- The name of the player to check for ownership, defaults to the Current Player.tokenRef- Either the tokenidor Token Name of the token which is checked for ownership, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
mapRef- The Name or ID of the map to find the token. Defaults to the current map.
Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.
Examples
Returns
You can edit me. if the Current Player is an owner of the Current Token.
[r, if(isOwner()): "You can edit me."]Returns Azhrei can edit me. if the given Player is an owner of the given Token.
[h: id = getSelected() ]
[r, if(isOwner("Azhrei", id)): "Azhrei can edit me."]See Also
Version Changes
- 1.3b51 - Added
idparameter option. - 1.5.4 - Added
mapnameparameter option.