Implement new override event for starting region eligibility hook #1304
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Tedster59
force-pushed
the
1303-improved-geoscape-creation
branch
from
e5e5a02
to
9a3d6ab
Compare
Iridar
requested changes
Feb 25, 2024
X2WOTCCommunityHighlander/Src/XComGame/Classes/XComGameState_RegionLink.uc
Outdated
Show resolved
Hide resolved
X2WOTCCommunityHighlander/Src/XComGame/Classes/XComGameState_RegionLink.uc
Outdated
Show resolved
Hide resolved
| /// NewGameState: none | ||
| /// ``` | ||
| // | ||
| // **NOTE** This function is public so that it can be called from `XComGameState_WorldRegion`. |
There was a problem hiding this comment.
You can still make it final.
Tedster59
force-pushed
the
1303-improved-geoscape-creation
branch
from
54b90dd
to
fdb2876
Compare
Tedster59
force-pushed
the
1303-improved-geoscape-creation
branch
2 times, most recently
from
b3d556e
to
cbb869a
Compare
Iridar
requested changes
Feb 25, 2024
| @@ -228,10 +228,13 @@ static function RandomizeLinks(XComGameState StartState) | |||
| } | |||
|
|
|||
| //--------------------------------------------------------------------------------------- | |||
| static function bool IsEligibleStartRegion(XComGameState StartState, XComGameState_WorldRegion RegionState) | |||
| static final function bool IsEligibleStartRegion(XComGameState StartState, XComGameState_WorldRegion RegionState) | |||
There was a problem hiding this comment.
Sorry, I wasn't clear enough. You can't change the function definition of a function that already exists, especially one that's not a private Highlander API. I meant making the TriggerOverrideEligibleStartingRegion() final.
|
|
||
| // Start Issue #1303 | ||
| /// HL-Docs: feature:OverrideEligibleStartingRegion; issue:1303; tags:strategy | ||
| // |
There was a problem hiding this comment.
Missing a third /? Or just remove the line.
Fix review comments Fix doc errors Implement new override event for starting region eligibility hook Fixes issue X2CommunityCore#1303 Mark function final
Tedster59
force-pushed
the
1303-improved-geoscape-creation
branch
from
cbb869a
to
678fcec
Compare
|
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 119ff6b..03d8f1b 100644
--- a/target/CHL_Event_Compiletest.uc
+++ b/target/CHL_Event_Compiletest.uc
@@ -506,6 +506,24 @@ static function EventListenerReturn OnOverrideDisableReinforcementsFlare(Object
return ELR_NoInterrupt;
}
+static function EventListenerReturn OnOverrideEligibleStartingRegion(Object EventData, Object EventSource, XComGameState GameState, Name EventID, Object CallbackObject)
+{
+ local XComGameState_WorldRegion PotentialStartRegion;
+ local XComLWTuple Tuple;
+ local bool ValidStartRegion;
+
+ PotentialStartRegion = XComGameState_WorldRegion(EventSource);
+ Tuple = XComLWTuple(EventData);
+
+ ValidStartRegion = Tuple.Data[0].b;
+
+ // Your code here
+
+ Tuple.Data[0].b = ValidStartRegion;
+
+ return ELR_NoInterrupt;
+}
+
static function EventListenerReturn OnOverrideEncounterZoneAnchorPoint(Object EventData, Object EventSource, XComGameState GameState, Name EventID, Object CallbackObject)
{
local XComGameState_AIGroup AIGroup;
What? (click to expand)The Highlander documentation tool generates event listener examples from event specifications. |
Iridar
approved these changes
Feb 25, 2024
Iridar
reviewed
Feb 25, 2024
| // public API. Backwards compatibility is not guaranteed. | ||
|
|
||
| static final function bool TriggerOverrideEligibleStartingRegion( | ||
| XComGameState StartState, |
There was a problem hiding this comment.
Any particular reason you have StartState as a function argument but don't use it?
There was a problem hiding this comment.
Removed the cargo cult
Fix review comments Fix doc errors Implement new override event for starting region eligibility hook Fixes issue X2CommunityCore#1303 Mark function final
…Tedster59/X2WOTCCommunityHighlander into 1303-improved-geoscape-creation
Iridar
approved these changes
Feb 25, 2024
Iridar
added
the
ready-for-merge
|
Closing this and re-opening with a different branch in #1309 to fix github commit issues |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes issue #1303 using option #1 of an override event to allow mods to override the behavior of this function.