onChangeMap: Difference between revisions
No edit summary |
m (Added Languages tag) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
{{Languages|onChangeMap}} | |||
'''• Introduced in version 1.14.0''' | '''• Introduced in version 1.14.0''' | ||
This event is triggered whenever the map is changed. | This event is triggered whenever the map is changed. | ||
Returns the {{code|map ID}} | |||
== Set up == | == Set up == | ||
| Line 15: | Line 18: | ||
The library token must have "Owner: All Players" unchecked, otherwise {{code|onChangeMap}} is not executed. To avoid permission issues with called functions, the {{code|onChangeMap}} macro should have "Options: Allow Players to Edit Macro" unchecked. | The library token must have "Owner: All Players" unchecked, otherwise {{code|onChangeMap}} is not executed. To avoid permission issues with called functions, the {{code|onChangeMap}} macro should have "Options: Allow Players to Edit Macro" unchecked. | ||
You can use {{code|macro.args}} to retrieve {{code|map ID}} map ID. | |||
You can use {{code|macro.args}} to retrieve | |||
{{code|map ID}} map ID | |||
[[Category:Special Macro]][[Category:Event]] | [[Category:Special Macro]][[Category:Event]] | ||
[[Category:Macro Function]] | [[Category:Macro Function]] | ||
{{Languages|onChangeMap}} | |||
Latest revision as of 19:35, 17 February 2024
• Introduced in version 1.14.0
This event is triggered whenever the map is changed.
Returns the map ID
Set up
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 onChangeMap 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.
You can use macro.args to retrieve map ID map ID.