isOwnedByAll: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
Tag: Reverted
No edit summary
 
(7 intermediate revisions by the same user not shown)
Line 4: Line 4:
|version=1.3b48
|version=1.3b48
|description=
|description=
Returns {{true}} if a [[Token]] has the [[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=
<syntaxhighlight lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
isOwnedByAll()
isOwnedByAll()
isOwnedByAll(id)
isOwnedByAll(tokenRef)
isOwnedByAll(id, mapname)
isOwnedByAll(tokenRef, mapRef)
</syntaxhighlight>
</syntaxhighlight>
'''Parameter'''
'''Parameter'''
{{param|id|The token {{code|id}} of the token which has its [[Introduction to Tokens|Owned by All]] status checked, defaults to the [[Current Token]]. {{TrustedParameter}} }}
{{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] 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.}}
{{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.}}


|example=
|example=

Latest revision as of 23:59, 17 May 2024

 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(tokenRef)
isOwnedByAll(tokenRef, mapRef)

Parameter

  • tokenRef - Either the token id or Token Name 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

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

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.