isOwner: Difference between revisions

Revision as of 15:49, 17 May 2024

• Introduced in version 1.3b48

Returns true(1) if the given Player is an owner of a specific Token.

isOwner()
isOwner(player)
isOwner(player, tokenRef)
isOwner(player, tokenRef, mapname)

Parameters

player - The name of the player to check for ownership, defaults to the Current Player.
tokenRef - Either the token id or 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.
mapname - The name 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.

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."]

@@ Line 9: / Line 9: @@
 isOwner()
 isOwner(player)
-isOwner(player, id)
+isOwner(player, tokenRef)
-isOwner(player, id, mapname)
+isOwner(player, tokenRef, mapname)
 </syntaxhighlight>
 '''Parameters'''
 {{param|player|The name of the player to check for ownership, defaults to the [[getPlayerName|Current Player]]. }}
-{{param|id|The token {{code|id}} of the token which is checked for ownership, defaults to the [[Current Token]]. {{TrustedParameter}} }}
+{{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|mapname|The name 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=