onChangeMap: Difference between revisions
(Created page with "==onChangeMap Macro== '''• Introduced in version 1.14.0''' A special macro that can be created on library tokens to have macro code automatically execute when the map is changed. This special macro is ideally suited for setting parameters specific to the map you've changed to. When an onChangeMap macro is executed automatically, it is considered a Trusted Macro. If you wish to use trusted functions within {{code|onCampaignLoad}} and execute it...") |
m (Taustin moved page onMapChange to onChangeMap without leaving a redirect) |
(No difference)
| |
Revision as of 03:15, 19 September 2023
onChangeMap Macro
• Introduced in version 1.14.0
A special macro that can be created on library tokens to have macro code automatically execute when the map is changed.
This special macro is ideally suited for setting parameters specific to the map you've changed to.
When an onChangeMap macro is executed automatically, it is considered a Trusted Macro. If you wish to use trusted functions within onCampaignLoad and execute it manually (e.g. while developing macros), you will have to make sure that it follows all of the rules of Trusted Macros.
How to Create an onChangeMap Macro
You can create an onChangeMap macro on any library token; simply create a macro that is specifically named onChangeMap.
The library token must have "Owner: All Players" unchecked, otherwise onChangeMap is not executed. To avoid permission issues with called functions, the onChangeMap macro should have "Options: Allow Players to Edit Macro" unchecked.