isOwnedByAll: Difference between revisions

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


Returns 1 if the [[Token:token|token]] has the [[Token:owned by all|owned by all]] check box checked.
|usage=
<syntaxhighlight lang="mtmacro" line>
isOwnedByAll()
isOwnedByAll(tokenRef)
isOwnedByAll(tokenRef, mapRef)
</syntaxhighlight>
'''Parameter'''
{{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|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.}}


===Usage===
|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.
[h: byAll = isOwnedByAll()]
<syntaxhighlight lang="mtmacro" line>
</source>
[r, if(isOwnedByAll()): "Anyone can edit me"]
</syntaxhighlight>


|also=
[[getOwners|getOwners()]],
[[isOwner|isOwner()]]


===Examples===
|changes=
<source lang="mtmacro" line>
{{change|1.3b51|Added {{code|id}} parameter option.}}
[r, if(isOnwedByAll()): "Anyone can edit me"]
{{change|1.5.4|Added {{code|mapname}} parameter option.}}
</source>
}}
[[Category:Token Function]]

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

getOwners(), isOwner()

Version Changes

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