Changes

Jump to navigation Jump to search
→‎Custom wedding event: document wedding tokens
Line 5,679: Line 5,679:  
|-
 
|-
 
| <samp>EventScript</samp>
 
| <samp>EventScript</samp>
| The [[Modding:Event data|event]] script which plays the wedding. The default script automatically handles marrying either an NPC or player, but mods can edit it conditionally to run a custom script (e.g. if the player is marrying their custom NPC).
+
| A [[#Tokenizable string format|tokenizable string]] for the [[Modding:Event data|event script]] which plays the wedding. The default script automatically handles marrying either an NPC or player, but mods can edit it conditionally to run a custom script (e.g. if the player is marrying their custom NPC).
 +
 
 +
The script can contain three custom tokens:
 +
{| class="wikitable"
 +
|-
 +
! token
 +
! effect
 +
|-
 +
| <samp>[SetupContextualWeddingAttendees]</samp>
 +
| The concatenated <samp>Setup</samp> values for each of the <samp>Attendees</samp> present in the wedding.
 +
|-
 +
| <samp>[ContextualWeddingCelebrations]</samp>
 +
| The concatenated <samp>Celebration</samp> values for each of the <samp>Attendees</samp> present in the wedding.
 +
|-
 +
| <samp>spouseFarmer</samp><br /><small>(no square brackets)</samp>
 +
| When marrying another player, their event actor ID (like <samp>farmer2</samp>) which can be used in event commands.
 +
|}
 
|-
 
|-
 
| <samp>Attendees</samp>
 
| <samp>Attendees</samp>
translators
8,437

edits

Navigation menu