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.

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

Add docs for Issue #359 - Photobooth Enums #1403

Merged
merged 2 commits into from
Dec 16, 2024
Merged

Add docs for Issue #359 - Photobooth Enums #1403

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fc7fe60
Add docs
BlackDog86 Nov 2, 2024
cb0ff2f
Update X2Photobooth.uc
Iridar Dec 10, 2024
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
12 changes: 9 additions & 3 deletions X2WOTCCommunityHighlander/Src/XComGame/Classes/X2Photobooth.uc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,15 @@ enum Photobooth_ParticleEffectType
ePPET_TemplarBladeLeft,
ePPET_TemplarShield,
// Start Issue #359
// Similar to above, but we don't need any sort of special marker
// enums here as these are never used in code (only config)
// Still going to use buffers though!
/// HL-Docs: feature:PhotoboothParticleEffectEnums; issue:359; tags:strategy
/// This feature provides additional enum values for Photobooth particle effects. To use it,
/// modmakers are required to submit a Pull Request where they will add new enum names,
/// which can then be used when defining particle effects for the Photobooth in `XComContent.ini`
/// by specifying `ParticleEffectTypes = ePPET_NAME` within an `m_arrAnimationPoses` entry,
/// and `ParticleEffectType = ePPET_NAME` within a `ParticleEffects` entry.
/// The enum value will then be used by the game to connect the two entries.
/// Note that it's also possible to add particle effects to Photobooth poses by adding them
/// directly to AnimSequences via PlayParticleEffect AnimNotifies, like TLP poses do.
ePPET_Buffer04,
ePPET_Buffer05,
ePPET_Buffer06,
Expand Down
Loading