copyToken: Difference between revisions
m (Slight Clarification) |
Verisimilar (talk | contribs) m (Framed images, added See Also) |
||
Line 118: | Line 118: | ||
And now we have tumbling clones | And now we have tumbling clones | ||
[[Image:TumblingClones.jpeg]] | [[Image:TumblingClones.jpeg|frame|center|Tumbling Clones using Top-down Tokens]] | ||
The source token was configured as a Top Down token for this effect, otherwise the {{code|facing}} setting would produce a facing arrow | The source token was configured as a Top Down token for this effect, otherwise the {{code|facing}} setting would produce a facing arrow | ||
for [[Token]]s on the token or hidden layer. | for [[Token]]s on the token or hidden layer. | ||
[[Image:PointingClones.jpeg]] | [[Image:PointingClones.jpeg|frame|center|Tumbling Clones using Round Tokens and Facing Arrows]] | ||
|also= | |||
{{func|moveTokenToMap}}, | |||
{{func|moveTokenFrom}} | |||
|changes= | |changes= |
Revision as of 07:46, 2 April 2009
copyToken() Function
Note: This function can only be used in a Trusted Macro
copies of can be reside on any map. You can not make any modifications to the newly created Tokens in the macro that creates them.
As of b54 there is a new parameter that allows you to make some changes to the new tokens.Usage
copyToken(id)
copyToken(id, numCopies)
copyToken(id, numCopies, fromMap)
copyToken(id, numCopies, fromMap, updates)
Parameters
id
- The id of the token to copy.numCopies
- The number of copies to create, defaults to1
fromMap
- The name of the map to copy from, defaults to the current map.updates
- a JSON Object that contains updates to be made to the copied Tokens.
You can use an empty string ("") for fromMap
for the current map as of b54.
The return type of this function is determined by the number of copies that you are making. If you are only creating a single
copy of the token then a string containing the Tokens id, if you are making more than one copy then a JSON Array
containing the Token ids of all the newly created Tokens is returned.
Updates parameter
updates
is a JSON Object that can contain one or more of the following fields.
- name - The name of the new Token.
- label - The label for the new Token.
- gmName - The GM name for the new Token.
- layer - The layer for the new Token.
- x - The X Co-ordinate for the new Token.
- y - The Y Co-ordinate for the new Token.
- useDistance -
true
orfalse
, determines if the "Distance Per Cell" measurement for the map is used for the x,y Co-ordinates. - facing - Sets the facing for the Token. If the Token is on the background or object layer this sets the rotation.
- size - Sets the size of the Token.
The values for all of these fields are evaluated so all text within {}
or []
goes through the standard macro processing.
When the name is not changed using the updates
parameter the new name for the token follows the naming method for cut and paste.
This function can copy Tokens in the token or hidden layer, objects, or background, if you do not override the destination using the
layer
field of updates
then the new copies are made in the same layer as the source. Likewise if x
and y
are not specified then these locations are the same as the source.
Example
[h:copyToken("Hero")]
Make a single copy of the Hero from another map.
[h:copyToken("Hero", 1, "Green Room")]
Or if you are playing paranoia and want to create six clones.
[h:copyToken("Hero", 6, "Clone Vat")]
But as a PC the new tokens don't get new names so we could give each of them a new name in b54+ using the following.
[h: cloneNo = 0]
[h: updates = "{
name:'Hero Clone - [r: cloneNo = cloneNo + 1]'
}"
]
[h: cloneNo = 0]
[h:copyToken("Hero", 6, "Clone Vat", updates)]
This will copy all our clones to the current map but they are all on top of each other, to line them up
[h: cloneNo = 0]
[h: x = 0]
[h: updates = "{
name:'Hero Clone - [r: cloneNo = cloneNo + 1]',
x:'[r: x = x + 2]',
y:0
}"
]
[h: cloneNo = 0]
[h:copyToken("Hero", 6, "Clone Vat", updates)]
Or combining rotation
[h: cloneNo = 0]
[h: x = 0]
[h: facing = 0]
[h: updates = "{
name:'Hero Clone - [r: cloneNo = cloneNo + 1]',
x:'[r: x = x + 2]',
y:0,
facing: '[r: facing = facing + 40]'
}"
]
[h: cloneNo = 0]
[h:copyToken("Hero", 6, "Clone Vat", updates)]
And now we have tumbling clones
The source token was configured as a Top Down token for this effect, otherwise the facing
setting would produce a facing arrow
for Tokens on the token or hidden layer.
See Also
Version Changes
- 1.3b54 - Added optional
updates
parameter.