isOwnedByAll: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Applied Template:MacroFunction)
No edit summary
 
(16 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{stub|Examples using new functionality.}}
{{MacroFunction
{{MacroFunction
|name=isOwnedByAll
|name=isOwnedByAll
|version=1.3b48
|description=
|description=
Returns 1 if the [[Token:Current Token|Current Token]] has the [[Token:owned by all|owned by all]] check box checked.
Returns {{true}} if a [[Token]] has the [[Introduction_to_Tokens#Ownership|Owned by All]] check box checked.


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: byAll = isOwnedByAll()]
isOwnedByAll()
</source>
isOwnedByAll(id)
isOwnedByAll(id, mapname)
</syntaxhighlight>
'''Parameter'''
{{param|id|The token {{code|id}} of the token which has its [[Introduction_to_Tokens#Ownership|Owned by All]] status checked, defaults to the [[Current Token]]. {{TrustedParameter}} }}
{{param|mapname|The name of the map to find the token.  Defaults to the current map.}}


|example=
|example=
<source lang="mtmacro" line>
Returns {{code|Anyone can edit me}} if the [[Current Token]] has the [[Introduction_to_Tokens#Ownership|Owned by All]] check box checked.
[r, if(isOnwedByAll()): "Anyone can edit me"]
<syntaxhighlight lang="mtmacro" line>
</source>
[r, if(isOwnedByAll()): "Anyone can edit me"]
</syntaxhighlight>
 
|also=
[[getOwners|getOwners()]],
[[isOwner|isOwner()]]
 
|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 18:18, 25 April 2023

 This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
 This article needs: Examples using new functionality.

isOwnedByAll() Function

Introduced in version 1.3b48
Returns true(1) if a Token has the Owned by All check box checked.

Usage

isOwnedByAll()
isOwnedByAll(id)
isOwnedByAll(id, mapname)

Parameter

  • id - The token id of the token which has its Owned by All status checked, 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.

Example

Returns Anyone can edit me if the Current Token has the Owned by All check box checked.
[r, if(isOwnedByAll()): "Anyone can edit me"]

See Also

Version Changes

  • 1.3b51 - Added id parameter option.
  • 1.5.4 - Added mapname parameter option.