onCampaignLoad: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Moved to Special Macro category.)
Line 6: Line 6:
===How to Create an onCampaignLoad Macro===
===How to Create an onCampaignLoad Macro===
You can create an onCampaignLoad macro on any library token; simply create a macro that is specifically named {{code|onCampaignLoad}}
You can create an onCampaignLoad macro on any library token; simply create a macro that is specifically named {{code|onCampaignLoad}}
Make sure on the Options tab, you uncheck "Allow Players to Edit Macro"


[[Category:Special Macro]]
[[Category:Special Macro]]

Revision as of 04:05, 28 May 2009

onCampaignLoad Macro

• Introduced in version 1.3b51

A special macro that can be created on library tokens to have macro code automatically execute when a campaign is loaded. A campaign is considered to have been loaded if it is opened via the File menu, or upon connecting to a server running that campaign. All output from onCampaignLoad is discarded. This special macro is ideally suited for loading your defined functions via defineFunction().

How to Create an onCampaignLoad Macro

You can create an onCampaignLoad macro on any library token; simply create a macro that is specifically named onCampaignLoad Make sure on the Options tab, you uncheck "Allow Players to Edit Macro"