setOwnedByAll: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
Line 3: Line 3:
|version=1.4.2.0
|version=1.4.2.0
|description=
|description=
Allows you to set or unset the ownedByAll value of the token.
Allows changing the '''ownedByAll''' value of a token.


|usage=
|usage=
<source lang="mtmacro" line>
<source lang="mtmacro" line>
setOwnedByAll(value)
setOwnedByAll(owned)
</source>
<source lang="mtmacro" line>
setOwnedByAll(owned, id)
setOwnedByAll(owned, id)
</source>
</source>
'''Parameter'''
'''Parameter'''
{{param|owned|The value of the setting to set, {{code|true}}({{code|1}}) or {{code|false}}({{code|0}}).}}
{{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}} }}



Revision as of 04:47, 7 March 2019

setOwnedByAll() Function

Introduced in version 1.4.2.0
Allows changing the ownedByAll value of a token.

Usage

setOwnedByAll(owned)
setOwnedByAll(owned, id)

Parameter

  • owned - The value of the setting to set, true(1) or false(0).
  • id - The token id of 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

Example

[h: setOwnedByAll(1)]
[h: setOwnedByAll(0, "Dragon")]

See Also