Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Issue #917 - Update EndTacticalHealthMod() in XCGS_Unit to expose beta strike post mission healing to config #1202

Merged

Conversation

BlackDog86
Copy link
Contributor

@BlackDog86 BlackDog86 commented Jun 22, 2023

Fixes #917

Added a boolean value to CHHelpers & updated code in EndTacticalHealthMod() in XCGS_Unit to allow other mods to set a config variable in XComGame.ini to disable the additional 50% health the game automatically grants to soldiers at the end of a mission when beta strike is active.

If the variable is false, or doesn't exist , the base game behaviour is retained.

@BlackDog86 BlackDog86 changed the title Updated EndTacticalHealthMod() in XCGS_Unit Issue #917 - Update EndTacticalHealthMod() in XCGS_Unit to expose beta strike post mission healing to config Jun 24, 2023
@Iridar
Copy link
Contributor

Iridar commented Jun 24, 2023

If the first message in the PR has something like "Closes #1192" or "Fixes #1192", then the corresponding issue will be closed automatically when the PR is merged, so do that in the future, please. I've edited the post for you for now.

@Iridar Iridar assigned Iridar and BlackDog86 and unassigned Iridar Jun 24, 2023
@Iridar Iridar added the waiting-on-author A pull request is waiting on changes from the author label Jun 24, 2023
@Iridar Iridar added this to the 1.26.0 milestone Jun 24, 2023
@BlackDog86 BlackDog86 requested a review from Iridar June 24, 2023 19:03
@BlackDog86 BlackDog86 requested a review from Iridar June 25, 2023 12:23
@BlackDog86
Copy link
Contributor Author

Issues resolved - ready for review

Copy link
Contributor

@Iridar Iridar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's still a formatting issue with HL-Docs.

A HL-Docs entry must look either like this:

/// HL-Docs: feature:YourFeature; issue:1337;

or like this:

/// HL-Docs: feature:YourFeature; issue:1337; tags:tactical

Tags are optional.
Either /// or ;;; are used depending on whether this is in script or in config.

Each feature must have at least one HL-Docs entry like this, where both feature name and issue number are specified.

All other HL-Docs entries should have only the feature name with the ref keyword:

;;; HL-Docs: ref:YourFeature;

All comments under HL-Docs entry that are also prefaced with /// or ;;; get pulled into the Highlander online documentation automatically, where the entry with the feature and issue is used to generate the header, while all other entries with ref are appended to the page.

The only exception to this rule is the ref:Bugfixes, which looks like this:

HL-Docs: ref:Bugfixes; issue:644

And it has both a ref and an issue number.

@BlackDog86
Copy link
Contributor Author

Please tell me it's right this time! Changed committed & pushed :)

@Iridar
Copy link
Contributor

Iridar commented Jul 12, 2023

It looks right to me, but the docs builder still fails for some reason. We need the sempai.

@Iridar
Copy link
Contributor

Iridar commented Jul 12, 2023

Avoid trailing semicolons in the HL-Docs lines (and you should probably lowercase issue)

(c) sempai

@BlackDog86 BlackDog86 force-pushed the 917-Beta-Strike-Healing-Config branch from cd0fba8 to da7591f Compare July 12, 2023 21:01
@Iridar
Copy link
Contributor

Iridar commented Jul 13, 2023

The docs builder still fails, sorry, looks like I was wrong and the tags keyword is mandatory.

Try it like this:

/// HL-Docs: feature:BetaStrikeEndTacticalHeal; issue:917; tags:

…XComGame.ini to disable the additional 50% healing the game automatically gives to soldiers at the end of a mission when beta strike is active. Updated code in XCGS_Unit to use the new bool variable. If the variable is false, or doesn't exist , the base game behaviour will be retained.
@BlackDog86 BlackDog86 force-pushed the 917-Beta-Strike-Healing-Config branch from da7591f to 87407b2 Compare July 13, 2023 18:28
@BlackDog86
Copy link
Contributor Author

OK last time! Please work!

@Iridar Iridar added ready-for-merge the pull request was reviewed and is ready to be merged. and removed waiting-on-author A pull request is waiting on changes from the author labels Jul 13, 2023
@Iridar
Copy link
Contributor

Iridar commented Jul 13, 2023

Praise Johnny Lump!

@Iridar Iridar merged commit eccfac3 into X2CommunityCore:master Aug 10, 2023
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement ready-for-merge the pull request was reviewed and is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Config option to disable Beta Strike's end tactical heal.
2 participants