Skip to content

Trigger an Event in XComUnitPawn.PlayHitEffects #826

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.

Sign up for GitHub

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

Merged
Musashi1584 merged 3 commits into from
Jun 1, 2020
Merged

Trigger an Event in XComUnitPawn.PlayHitEffects #826

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
30d9f06
Implements Issue #825
Musashi1584 Mar 23, 2020
632e6f0
Update X2WOTCCommunityHighlander/Src/XComGame/Classes/XComUnitPawn.uc
Musashi1584 Apr 20, 2020
52d030a
Update documentation
Musashi1584 May 1, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions X2WOTCCommunityHighlander/Src/XComGame/Classes/XComUnitPawn.uc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -381,19 +381,20 @@ simulated function DamageTypeHitEffectContainer GetDamageTypeHitEffectContainer(
/// Allows listeners to override the default behavior of XComUnitPawn.PlayHitEffects
/// This is especially useful for preventing the hardcoded templar fx for
/// eHit_Parry, eHit_Reflect and eHit_Deflect which play for any abilities that utilizing these hit results.
/// If OverrideHitEffect is set to true the PlayHitEffects function will return early and the default behavior is ommited.
Comment thread
pledbrook marked this conversation as resolved.
///
/// ```unrealscript
/// EventID: OverrideHitEffects
/// EventData: XComLWTuple {
/// Data: [
/// out bool OverrideHitEffect,

@pledbrook pledbrook Apr 25, 2020

Copy link
Copy Markdown
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.

@Musashi1584 Musashi1584 May 1, 2020

Copy link
Copy Markdown
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.

/// inout float Damage
/// inout Actor InstigatedBy
/// inout vector HitLocation
/// inout name DamageTypeName
/// inout vector Momentum
/// inout bool bIsUnitRuptured
/// inout EAbilityHitResult HitResult
/// inout float Damage,
/// inout Actor InstigatedBy,
/// inout vector HitLocation,
/// inout name DamageTypeName,
/// inout vector Momentum,
/// inout bool bIsUnitRuptured,
/// inout EAbilityHitResult HitResult,
/// ]
/// }
/// EventSource: self (XComUnitPawn)
Expand Down