isOwnedByAll: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) (Applied Template:MacroFunction) |
No edit summary |
||
| (18 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 | Returns {{true}} if a [[Token]] has the [[Introduction_to_Tokens#Ownership|Owned by All]] check box checked. | ||
|usage= | |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.}} | |||
|example= | |example= | ||
< | Returns {{code|Anyone can edit me}} if the [[Current Token]] has the [[Introduction_to_Tokens#Ownership|Owned by All]] check box checked. | ||
[r, if( | <syntaxhighlight lang="mtmacro" line> | ||
</ | [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 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
Usage
isOwnedByAll()
isOwnedByAll(tokenRef)
isOwnedByAll(tokenRef, mapRef)Parameter
tokenRef- Either the tokenidor 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
idparameter option. - 1.5.4 - Added
mapnameparameter option.