isOwner: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(missing 'player' as first parameter)
No edit summary
Line 8: Line 8:
<source lang="mtmacro" line>
<source lang="mtmacro" line>
isOwner()
isOwner()
</source>
<source lang="mtmacro" line>
isOwner(player)
isOwner(player)
</source>
<source lang="mtmacro" line>
isOwner(player, id)
isOwner(player, id)
isOwner(player, id, mapname)
</source>
</source>
'''Parameters'''
'''Parameters'''
{{param|plyer|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]]. }}
{{param|id|The token {{code|id}} 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|id|The token {{code|id}} of the token which is checked for ownership, defaults to the [[Current Token]]. {{TrustedParameter}} }}


|examples=
|examples=
Line 38: Line 36:
|changes=
|changes=
{{change|1.3b51|Added {{code|id}} parameter option.}}
{{change|1.3b51|Added {{code|id}} parameter option.}}
{{change|1.5.4|Added {{code|mapname}} parameter option.}}


}}
}}
[[Category:Token Function]]
[[Category:Token Function]]

Revision as of 19:52, 15 August 2019

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.