Add a new event trigger after Mission Intro kismet has completed

[furudee]

Fixes issue #1406

[Iridar]

Don't need a HL-Docs entry here, just the standard issue tags are enough. Could even do // Single Line for Issue #1406.

[furudee]

I figured that the reference would be useful, since there are two different places where the trigger is placed and both will show the location on the documentation

[Iridar]

That's fair. Good work.

[Iridar]

HL-Docs for events have a different style, here's an example:

/// ```event
/// EventID: AllowOnCovertActionCompleteAnalytics,
/// EventData: [
///   inout bool bAllow,
///   in Object OriginalEventData,
///   in Object OriginalEventSource,
///   in XComGameState OriginalGameState,
///   in name OriginalEvent,
///   in Object OriginalCallbackData
/// ],
/// EventSource: none,
/// NewGameState: none

Also, are you sure there's no useful stuff you could pass along with the event trigger?

[furudee]

I'm not sure there is anything special to pass with the trigger, since there is no pending gamestate and you can access the ruleset normally when the event trigger is called

Also, I squashed the commits into one and revised the doc block

[Iridar]

That's fair. Good work.

[github-actions]

Pull request modifies event listener templates

Difference (click to expand)

diff --git a/target/CHL_Event_Compiletest.uc b/target/CHL_Event_Compiletest.uc
index 02ed7bd..3298ada 100644
--- a/target/CHL_Event_Compiletest.uc
+++ b/target/CHL_Event_Compiletest.uc
@@ -1178,6 +1178,13 @@ static function EventListenerReturn OnPostInventoryLoadoutApplied(Object EventDa
 	return ELR_NoInterrupt;
 }
 
+static function EventListenerReturn OnPostMissionIntroKismet(Object EventData, Object EventSource, XComGameState GameState, Name EventID, Object CallbackObject)
+{
+	// Your code here
+
+	return ELR_NoInterrupt;
+}
+
 static function EventListenerReturn OnPostSquaddieLoadoutApplied(Object EventData, Object EventSource, XComGameState GameState, Name EventID, Object CallbackObject)
 {
 	local XComGameState_Unit UnitState;

What? (click to expand)

The Highlander documentation tool generates event listener examples from event specifications.
This comment contains the modifications that would be made to the copy-pasteable event listeners in documentation, for PR authors and reviewers to inspect for correctness, and will automatically be kept up-to-date whenever this PR is updated.

[Iridar]

This is ready to go. I'll merge it when the work on 1.30 starts in earnest. Thanks for your contribution.

[Iridar]

Btw it wasn't mandatory to squash the commits, when you're not adding new files, all commits can be squashed automatically during the merging process, we require exactly two commits only when new files are added to CHL.