Implement Better Positive Trait UI

[BlackDog86]

Fixes #1081

Summary:

1. Modified UIAlert to use the "TrainingComplete" alert for positive traits - This has the same set of UI elements as Alert_NegativeSoldierEvent for negative traits but with a neutral colour scheme & promotion-icon.

2. Updated XcomHQPresentationLayer to check whether traits are positive or negative before calling the notifybanner function (this is the piece which places the trait notifications on the bottom left of the screen). Adjusted colours and icons to make more sense.

3. Adjusted the UIAvengerHUD OnClickTraitIcon function so that if someone clicks on a soldier walking around the avenger with a negative or positive trait icon (like the bond icon), it takes them to the correct UI Panel for that trait.

Note that I can't confirm this new code actually does anything - I can't remember seeing anyone walking around with trait icons bobbing around so probably the function is never called for, but anyway, the code now includes positive traits as well in case that behaviour is ever fixed in the future.

[RustyDios]

A quick glance, and I fully agree this looks like it fixes a lot of issues there are various places that have for example;

-var() bool							bHasSeenNegativeTraitPopup;
//Issue# 1081 - Alter bool name so it applies to both positive and negative traits
+var() bool							bHasSeenTraitPopup;

Which would break the CHL backwards compatibility policy on any mods previously reliant on the removed bool.
Rather than remove the word 'Negative' from everything, a better approach should be to duplicate the variables adding 'Positive' and make the code account for both.

[robojumper]

XComGameState_HeadquartersXCom is a native class, so property additions are disallowed. Also in general, keep property names and function names and arguments the same -- even if they have "negativeTrait" in their name, simply keep that and add a comment that this does more than what the name implies.

[BlackDog86]

A quick glance, and I fully agree this looks like it fixes a lot of issues there are various places that have for example;

-var() bool							bHasSeenNegativeTraitPopup;
//Issue# 1081 - Alter bool name so it applies to both positive and negative traits
+var() bool							bHasSeenTraitPopup;

Which would break the CHL backwards compatibility policy on any mods previously reliant on the removed bool. Rather than remove the word 'Negative' from everything, a better approach should be to duplicate the variables adding 'Positive' and make the code account for both.

BC did cross my mind when I changed that - I don't think it matters to just change it back and comment that the function does 'more than what it says on the tin' as it were. I'll modify and re-post. Thanks for the feedback :)

[BlackDog86]

Requested changes now implemented (no changes to XComGameState_HeadquartersXCom and function names kept the same for BC)

[Iridar]

Without looking at anything else, you can't change function definitions of existing functions, that breaks the BC.

The only exception are private/final internal Highlander functions that are explicitly not covered by the BC policy.

[BlackDog86]

Understood - I've now reworked the code so that all base game functions are left unmodified. Fairly happy with the code now. Let me know if this is sufficient :)

[BlackDog86]

Are there any more changes required on this or is it just a timing thing?

[Iridar]

To be clear, this feature adds just a UI, right? But no way for units to actually acquire positive traits? Docs need to specify how mod authors should take advantage of this feature.

And I'd love to see some screenshots of this UI in action from an example use case.

[Iridar]

What is this stray 1 at the end of the line? Would this even compile?

[BlackDog86]

To be clear, this feature adds just a UI, right? But no way for units to actually acquire positive traits? Docs need to specify how mod authors should take advantage of this feature.

And I'd love to see some screenshots of this UI in action from an example use case.

There are pictures of the updated UI in Issue #1081 - not sure how that 1 got in there either - it's probably a stray key-press from when I was fixing commits that had gotten a long way behind the master earlier this month. I'll fix it tonight.

It's been so long since I wrote this PR so I'll have to dig into the details again regarding the documentation, but my understanding is that the 'idea' of positive traits, their templates and the code to create the various alerts existed already but basically positive traits were finally cut from the game on release so the functions were never used.

Anyway, from a user/modder perspective, all they need to do is set bPositiveTrait on the trait template and the UI handling should take care of the rest. I'll run a few other tests later on if rquired.

The mod "More traits" contains the code and config required to add new trait templates to the game - this probably should be considered the de-facto standard for adding new traits - I don't think there are a vast amount of mods that have built many more since then.
https://steamcommunity.com/sharedfiles/filedetails/?id=1122837889

[BlackDog86]

Additionally, the base game only allows for one trait popup message to appear at a time. Personally I'd prefer if each trait brought its own popup message when its triggered but I didn't think that that was enough of a justification to comment out the block below. Also, if you use the 'starting traits' mod, it does mean it could bring up quite a few popups when you start a new campaign but I'm open to discussion on leaving the base game code as it is, or adjusting it.

> if(PopupCount > 0 && !XComHQ.bHasSeenNegativeTraitPopup)
> 				{
> 					XComHQ.bHasSeenNegativeTraitPopup = true;
> 					UINegativeTraitAlert(NewGameState, PopupUnit, StoredTraitName);
> 				}

[Iridar]

Looks mostly okay to me, but I have issues with it being a bit messy, like fixing typos or adding random empty spaces to lines.

I'm also nitpicking to docs.

The point of HL-Docs in this case is to be mod author facing, so they can get a clean and concise explanation of what this CHL feature can do for them.

Something along the lines of:

"Positive traits are a scrapped WOTC feature, on release the game had only negative traits, so there is no UI for "positive trait acquired", but X2TraitTemplate does have a bPositiveTrait flag. This feature repurposes "soldier promoted" UI to make it function as a makeshift "positive trait acquired UI". To make the game display it when the soldier acquires a positive trait, simply set bPositiveTrait = true; on your X2TraitTemplate."

This all can be done as one piece of Docs somewhere, and the rest of the changes can be marked with standard non-Docs Start/End Issue tags.

[Iridar]

I appreciate the diligence, but fixing typos in vanilla code is outside the scope of this PR.

[Iridar]

Add a none-check for the trait template pls.

[BlackDog86]

OK hopefully this is a bit better.