isOwner: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page IsOwner to isOwner: Converting page titles to lowercase)
No edit summary
Line 6: Line 6:


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
isOwner()
isOwner()
isOwner(player)
isOwner(player)
isOwner(player, id)
isOwner(player, id)
isOwner(player, id, mapname)
isOwner(player, id, mapname)
</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 [[Current Player]]. }}
Line 20: Line 20:
|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 [[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=

Revision as of 20:14, 15 March 2023

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, id)
isOwner(player, id, mapname)

Parameters

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

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 id parameter option.
  • 1.5.4 - Added mapname parameter option.