isOwner: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
VisualWikitext
m (Conversion script moved page isOwner to IsOwner without leaving a redirect: Converting page title to first-letter uppercase)
No edit summary
 
(6 intermediate revisions by 2 users not shown)
Line 3: Line 3:
|version=1.3b48
|version=1.3b48
|description=
|description=
Returns {{true}} if the given [[Player]] is an owner of a specific [[Token]].
Returns {{true}} if the given Player is an owner of a specific [[Token]].


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
isOwner()
isOwner()
isOwner(player)
isOwner(player)
isOwner(player, id)
isOwner(player, tokenRef)
isOwner(player, id, mapname)
isOwner(player, tokenRef, mapRef)
</source>
</syntaxhighlight>
'''Parameters'''
'''Parameters'''
{{param|player|The name of the player to check for ownership, defaults to the [[Current Player]]. }}
{{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.}}
{{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 [[Current Player]] is an owner of the [[Current Token]].
Returns {{code|You can edit me.}} if the [[getPlayerName|Current Player]] is an owner of the [[Current Token]].
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[r, if(isOwner()): "You can edit me."]
[r, if(isOwner()): "You can edit me."]
</source>
</syntaxhighlight>


Returns {{code|Azhrei can edit me.}} if the given [[Player]] is an owner of the given [[Token]].
Returns {{code|Azhrei can edit me.}} if the given Player is an owner of the given [[Token]].
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: id = getSelected() ]
[h: id = getSelected() ]
[r, if(isOwner("Azhrei", id)): "Azhrei can edit me."]
[r, if(isOwner("Azhrei", id)): "Azhrei can edit me."]
</source>
</syntaxhighlight>


|also=
|also=

Latest revision as of 23:59, 17 May 2024

isOwner() Function

• Introduced in version 1.3b48
Returns true(1) if the given Player is an owner of a specific Token.

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

  • 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

getOwners(), isOwnedByAll()

Version Changes

  • 1.3b51 - Added id parameter option.
  • 1.5.4 - Added mapname parameter option.
Retrieved from "https://wiki.rptools.info/index.php?title=isOwner&oldid=35181"