Skip to content

Trigger an Event in XComUnitPawn.PlayHitEffects#826

Merged
Musashi1584 merged 3 commits intoX2CommunityCore:masterfrom
Musashi1584:hit-effects-event
Jun 1, 2020
Merged

Trigger an Event in XComUnitPawn.PlayHitEffects#826
Musashi1584 merged 3 commits intoX2CommunityCore:masterfrom
Musashi1584:hit-effects-event

Conversation

@Musashi1584
Copy link
Contributor

Implements Issue #825

@Musashi1584 Musashi1584 added the ready-to-review A pull request is ready to be reviewed label Mar 28, 2020
@Musashi1584 Musashi1584 added ready-for-merge the pull request was reviewed and is ready to be merged. and removed ready-to-review A pull request is ready to be reviewed labels Apr 20, 2020
/// EventID: OverrideHitEffects
/// EventData: XComLWTuple {
/// Data: [
/// out bool OverrideHitEffect,
Copy link
Contributor

Choose a reason for hiding this comment

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

You should clarify in the body of the docs above what impact this value has (so modders don't need to look into the source code to find out). I know it can be inferred, but I can only be confident in the inference because I looked at the code.

A more subtle question is whether changing the event values below affects PlayHitEffects() even if OverrideHitEffect is false. One might assume the values are ignored in that case, but it is still an assumption.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@pledbrook is that more clear now with that addition?
/// If OverrideHitEffect is set to true the PlayHitEffects function will return early and the default behavior is ommited.

Copy link
Contributor

@pledbrook pledbrook left a comment

Choose a reason for hiding this comment

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

I'll leave it up to you whether you want to change the terminology for "omitted".

@Musashi1584 Musashi1584 merged commit c34949b into X2CommunityCore:master Jun 1, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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.

3 participants