setOwner

setOwner() Function

• Introduced in version 1.3b48?

Changes the owners of a token (default is the Current Token) when given a string owner name or JSON Array of owner names. All other owners are removed.

Usage

setOwner(ownerName)
setOwner(ownerName, id)
setOwner(ownerName, id, mapname)
setOwner(ownerNames)
setOwner(ownerNames, id)
setOwner(ownerNames, id, mapname)

Parameters

• ownerName - The player name to set the ownership on the token. Ownership is not constrained to the client names currently connected, but only currently connected clients appear in the Token Editor Dialog. This parameter is a string. An empty string here is treated as an empty JSON array (see next parameter).
• ownerNames - The player names to set the ownership on the token. Ownership is not constrained to the client names currently connected, but only currently connected clients appear in the Token Editor Dialog. This parameter is a JSON Array.
• id - The token id of the token which has its owners changed, defaults to the Current Token. Will also work with Token Name

   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.

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.

Examples

To change the owners of the Current Token to a single user use:

[h: setOwner("Frank")]

To change the owners of the Current Token to a list of three players use:

[h: setOwner("['Peter', 'Paul', 'Mary']")]

or:

[h: list = json.append("[]", "Peter", "Paul", "Mary")]
[h: setOwner(list)]

To make all current players owners of the Current Token use:

[h: setOwner(getAllPlayerNames("json"))]

To remove all owners of the Current Token use:

[h: setOwner("")]

or:

[h: setOwner("[]")]

To display the current owners of the Current Token as checkboxes, then accept the user's changes to apply back onto the token, use the following. Note that this example does not provide for adding owners to the list, only removing them. (Adding owners would require the use of getAllPlayerNames() and would make this example even more complex.)

[h: names = getOwners("json")]
[h: input = "tab0 | OwnerList || TAB"]
[h: count = 0]
[h, foreach(name, names), code: {
    [input = input + strformat(" ## ckb_%{count}|1|%{name}|CHECK")]
    [count = count+1]
} ]
[h: cancel = input(input)]
[h: abort(cancel)]
[h: newOwners = "[]"]
[h, for(x,0,count):
    newOwners = if(eval("ckb_"+x)==0, newOwners, json.append(newOwners, json.get(names, x))) ]
[h: setOwner(newOwners)]

See Also

isOwnedByAll(),

setOwnerOnlyVisible(),

isOwner().

Version Changes

• 1.3b51 - Added id parameter option.
• 1.5.4 - Added mapname parameter option.