setOwnedByAll: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page SetOwnedByAll to setOwnedByAll: Converting page titles to lowercase)
No edit summary
Line 6: Line 6:


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
setOwnedByAll(owned)
setOwnedByAll(owned)
setOwnedByAll(owned, id)
setOwnedByAll(owned, id)
setOwnedByAll(owned, id, mapname)
setOwnedByAll(owned, id, mapname)
</source>
</syntaxhighlight>
'''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}}.}}
Line 18: Line 18:


|example=
|example=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: setOwnedByAll(1)]
[h: setOwnedByAll(1)]
[h: setOwnedByAll(0, "Dragon")]
[h: setOwnedByAll(0, "Dragon")]
</source>
</syntaxhighlight>


|also=
|also=

Revision as of 20:47, 14 March 2023

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) 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

  • 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 mapname parameter option.