removeFromInitiative

removeFromInitiative() Function

Removes the Current Token from the Initiative Panel. Additional parameters allow you to specify the token.

Usage

removeFromInitiative()
removeFromInitiative(tokenRef)
removeFromInitiative(tokenRef, mapRef)

Parameters

• tokenRef - Either the token id or Token Name of the token to be removed from the initiative. Defaults to the Current Token.

   Note: This parameter can only be used in a Trusted Macro. 

• mapRef - The Name or ID of the map to find the token. Defaults to the current map.
• return - Returns 1 if removed from the initiative, 0 if did not.

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.

Example

To remove the token with the name "Dragon" in current map from the initiative panel.

[h: removeFromInitiative("Dragon")]

See Also

addToInitiative() removeAllFromInitiative() removeAllNPCsFromInitiative() removeAllPCsFromInitiative()

Version Changes

• 1.5.7 - Added id and mapname parameter options.