Update docs and functionality for OverrideHitEffects event

[Iridar]

Closes #1114

This PR updates both the docs and event functionality to be in line with each other.

A mod I'm working on has a legitimate use for this event that requires overriding some of the stuff passed in the Tuple.

I opted not to make bIsUnitRuptured an out argument since I don't have personal use for it and I didn't want to deal with the whole "booleans can't be out arguments" thing.

[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 62b936b..0edabdd 100644
--- a/target/CHL_Event_Compiletest.uc
+++ b/target/CHL_Event_Compiletest.uc
@@ -608,6 +608,7 @@ static function EventListenerReturn OnOverrideHitEffects(Object EventData, Objec
 	Pawn = XComUnitPawn(EventSource);
 	Tuple = XComLWTuple(EventData);
 
+	OverrideHitEffect = Tuple.Data[0].b;
 	Damage = Tuple.Data[1].f;
 	InstigatedBy = Actor(Tuple.Data[2].o);
 	HitLocation = Tuple.Data[3].v;
@@ -620,7 +621,6 @@ static function EventListenerReturn OnOverrideHitEffects(Object EventData, Objec
 
 	Tuple.Data[0].b = OverrideHitEffect;
 	Tuple.Data[1].f = Damage;
-	Tuple.Data[2].o = InstigatedBy;
 	Tuple.Data[3].v = HitLocation;
 	Tuple.Data[4].n = DamageTypeName;
 	Tuple.Data[5].v = Momentum;

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.

[Xymanek]

I opted not to make bIsUnitRuptured an out argument since I don't have personal use for it and I didn't want to deal with the whole "booleans can't be out arguments" thing.

But the code (as it stands now) does do the bool -> int -> bool conversion?

[Iridar]

I opted not to make bIsUnitRuptured an out argument since I don't have personal use for it and I didn't want to deal with the whole "booleans can't be out arguments" thing.

But the code (as it stands now) does do the bool -> int -> bool conversion?

Yes, I decided to do it anyway, I thought you wanted it.

[Xymanek]

I definitely prefer this version - was just asking about the disconnect between code and comments