setOwnedByAll: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
No edit summary |
||
| Line 9: | Line 9: | ||
setOwnedByAll(owned) | setOwnedByAll(owned) | ||
setOwnedByAll(owned, id) | setOwnedByAll(owned, id) | ||
setOwnedByAll(owned, id, mapname) | |||
</source> | </source> | ||
'''Parameter''' | '''Parameter''' | ||
{{param|owned|The value of the setting to set, {{true}} or {{false}}.}} | {{param|owned|The value of the setting to set, {{true}} or {{false}}.}} | ||
{{param|id|The token {{code|id}} of the token which has its [[Owned by All]] status set, defaults to the [[Current Token]]. {{TrustedParameter}} }} | {{param|id|The token {{code|id}} of the token which has its [[Owned by All]] status set, defaults to the [[Current Token]]. {{TrustedParameter}} }} | ||
{{param|mapname|The name of the map to find the token. Defaults to the current map.}} | |||
|example= | |example= | ||
| Line 23: | Line 26: | ||
{{func|getOwners}}, {{func|isOwner}}, {{func|isOwnedByAll}} | {{func|getOwners}}, {{func|isOwner}}, {{func|isOwnedByAll}} | ||
|changes= | |||
{{change|1.5.4|Added {{code|mapname}} parameter option.}} | |||
}} | }} | ||
[[Category:Token Function]] | [[Category:Token Function]] | ||
Revision as of 20:51, 15 August 2019
setOwnedByAll() Function
• Introduced in version 1.4.2.0
Allows changing the ownedByAll value of a token.
Usage
setOwnedByAll(owned)
setOwnedByAll(owned, id)
setOwnedByAll(owned, id, mapname)Parameter
owned- The value of the setting to set,true(1) orfalse(0).id- The tokenidof the token which has its Owned by All status set, 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
[h: setOwnedByAll(1)]
[h: setOwnedByAll(0, "Dragon")]See Also
Version Changes
- 1.5.4 - Added
mapnameparameter option.