Hades 2 Mod Wiki

website·Indexed 29 days ago

https://sgg-modding.github.io/Hades2ModWiki

Documentation for Hades 2 modding, featuring in-game definitions and scripting functions from Lua modules such as UtilityLogic.lua, TraitLogic.lua, UpgradeChoiceLogic.lua, and TalentScreenLogic.lua.

Tokens: 331.8K
Snippets: 3.7K
Records: 5.3K
Agent score: 75%

What's inside Hades 2 Mod Wiki

Overview of Weapon Aspect components in Hades 2
A Weapon Aspect is a trait that builds upon a base weapon to modify its appearance and attacks. Creating a custom Weapon Aspect involves several key components:
- TraitData: The core table defining the aspect and its associated traits.
- Weapon Changes: Modifying or replacing existing weapon attacks.
- God Effects: Implementing god-tier effects and visual effects (VFX) into attacks.
- Traits: Creating unique abilities that scale with the aspect's rank.
- Art: Generating aspect icons and modifying 3D models or textures.
- Text: Creating textid entries for in-game descriptions and hammer text.
- Shop/Upgrades: Integrating the aspect into the in-game shop and upgrade menus.
- Hammers: Managing hammer compatibility and restricting incompatible base aspects.
https://sgg-modding.github.io/Hades2ModWiki/docs/creating-mods/Weapon_Aspect/Overview
Trigger a test room intro with BeginTestRoomInro
The BeginTestRoomInro function, located in TestEduardo.lua, is used to initiate a test room introduction sequence. It takes no parameters and does not return any value.
```
BeginTestRoomInro()
```
https://sgg-modding.github.io/Hades2ModWiki/docs/in-game-definitions/globals/scripting-functions/TestEduardo/BeginTestRoomInro
PreDamagePresentation function parameters
The PreDamagePresentation function accepts the following parameters:
- enemy: The entity receiving the damage.
- damageAmount: The numerical value of the damage being dealt.
- damageData: Data containing details about the damage source and type.
https://sgg-modding.github.io/Hades2ModWiki/docs/in-game-definitions/globals/scripting-functions/EventPresentation/PreDamagePresentation
Trigger the Chaos Timer expiration presentation
The ChaosTimerAboutToExpirePresentation function in EventPresentation.lua is used to trigger the visual or UI presentation indicating that the Chaos Timer is about to expire. It accepts a single threshold parameter and does not return a value.
```
ChaosTimerAboutToExpirePresentation(threshold)
```
https://sgg-modding.github.io/Hades2ModWiki/docs/in-game-definitions/globals/scripting-functions/EventPresentation/ChaosTimerAboutToExpirePresentation
Reference parameters for FishingReelSequenceStartPresentation
The FishingReelSequenceStartPresentation function takes the following parameters:
- source: The calling source of the function.
- args: Additional arguments passed to the sequence.
- fishData: Data containing information about the fish involved in the sequence.
The function returns none.
https://sgg-modding.github.io/Hades2ModWiki/docs/in-game-definitions/globals/scripting-functions/FishingPresentation/FishingReelSequenceStartPresentation
Trigger the run introduction screen using ShowRunIntro
The ShowRunIntro() function in UILogic.lua is used to display the run introduction screen in Hades 2. This function takes no parameters and does not return a value.
```
ShowRunIntro()
```
https://sgg-modding.github.io/Hades2ModWiki/docs/in-game-definitions/globals/scripting-functions/UILogic/ShowRunIntro
Understand the MusicSection system for dynamic audio
The MusicSection system in Hades II is used to dynamically transition between different parts of a single audio event or control which part of a track loops. This is essential for scenarios where music styles change completely (e.g., transitioning from introductory dialogue to combat), which cannot be achieved by simply muting/unmuting stems.
Under the hood, this system utilizes a sound cue/property named Section. When the game calls SetMusicSection(section), it updates the Section parameter within the FMOD event to the specified value.
```
SetSoundCueValue({ Names = { "Section", }, Id = musicId, Value = section })
```
https://sgg-modding.github.io/Hades2ModWiki/docs/creating-mods/audio/adding-dynamic-music
PreDamageBoss function parameters and return value
The PreDamageBoss function takes the following parameters:
- enemy: The boss enemy target.
- damageAmount: The numerical value of the damage being dealt.
- damageData: Data containing details about the damage source and type.
The function returns none.
https://sgg-modding.github.io/Hades2ModWiki/docs/in-game-definitions/globals/scripting-functions/PowersLogic/PreDamageBoss
Trigger an encounter invulnerability falloff warning using EncounterInvulnerableFalloffWarning
The EncounterInvulnerableFalloffWarning function in EffectLogic.lua is used to trigger a warning notification when an encounter's invulnerability period is about to end. It takes a single parameter, effectName, and does not return a value.
```
EncounterInvulnerableFalloffWarning(effectName)
```
https://sgg-modding.github.io/Hades2ModWiki/docs/in-game-definitions/globals/scripting-functions/EffectLogic/EncounterInvulnerableFalloffWarning
Use the GetRewardsOffered function in Debug.lua
The GetRewardsOffered function is available in Debug.lua and is used to retrieve information about rewards offered in a specific room. It takes three parameters: the room, the rewards offered totals, and a separator.
```
GetRewardsOffered(room, rewardsOfferedTotals, sep)
```
https://sgg-modding.github.io/Hades2ModWiki/docs/in-game-definitions/globals/scripting-functions/Debug/GetRewardsOffered
Reference parameters for WeaponChargeStageReachedPresentation
The WeaponChargeStageReachedPresentation function accepts the following parameters:
- triggerArgs: Arguments associated with the trigger event.
- weaponData: Data object containing information about the weapon.
- args: General arguments passed to the presentation function.
- stageData: Data specific to the charge stage that was reached.
- maxStage: The maximum charge stage possible for the weapon.
The function returns no value (none).
https://sgg-modding.github.io/Hades2ModWiki/docs/in-game-definitions/globals/scripting-functions/WeaponPresentation/WeaponChargeStageReachedPresentation
Hades II Mod Wiki Site Structure Overview
The Hades II Mod Wiki is organized into the following functional sections:
- Using Mods: Installation guides for r2modman on Windows and Steam Deck.
- Creating Mods: Documentation for mod development (currently under construction).
- In-Game Definitions: A reference for scripting functions found in Hades II/Content/Scripts, including arguments and return values.
- Glossary: Reference tables for internal game names and other data.
https://sgg-modding.github.io/Hades2ModWiki/docs/intro