R2API Elites
API for adding custom elite types
About this mod Author’s original text
R2API.Elites - Elite, EliteDef and a Global EliteRamp implementations
About
R2API.Elites is a submodule assembly for R2API that allows mod creators to add new Elites, Elitetiers and properly working Elite Ramps for Elites in game.
Use Cases / Features
R2API.Elites is used for adding new EliteDefs, EliteTierDefs and properly working Elite Ramps to the game.
The addition of Elites is handled via the CustomElite class, which contains the following information:
EliteDef: The Elite being added
EliteRamp: A Texture2D that's going to be the Elite's Ramp, this is what makes elites such as blazing elites have a different color palette
EliteTierDefs: The Elite being added will be added to the specified EliteTierDefs.
The EliteRamp implementation is handled inside the EliteRamp class, you can use the method `AddRamp for tying a Ramp to an eliteDef, this can be useful in scenarios where you dont want to add Elites via the main EliteAPI. It also contains TryGetRamp method so you can get elite ramp texture for custom elites added via AddRamp` method.
Related Pages
Changelog
'1.1.1'
- Fixed hook getting applied too late
'1.1.0'
- Fixes for 1.4.1 Game Update. Move away from using lrapi_returns.json
1.0.8
- Dynamic implementation of CombatDirectorInitNoTimingIssue
- Vanilla CombatDirector.Init method is no longer skipped.
- Makes CombatDirector.Init IL hookable again (required for all Harmony hooks)
- To ensure backwards compatibility, the Init method may run more than once.
- Added new VanillaEliteTier enum along with GetEliteTierEnumerable methods to help with vanilla compatible elite additions.
- Updated EliteRampAPI to include more warnings/errors for invalid entries
'1.0.7'
- Fixes for 1.3.6 Game Update.
'1.0.6'
- Add EliteRamp.TryGetRamp method.
'1.0.5'
- Fixes for 1.3.5 Game Update.
'1.0.4'
- Initial fixes for SOTS DLC2 Release.
'1.0.3'
- Fix some incorrect internal code.
'1.0.2'
- Add missing BepInDependency to R2API.ContentManagement
'1.0.1'
- Fix some non working custom ramps (ramp index not properly set)
- Always enable EliteAPI hooks (potential fix for a Spikestrip elite color bug)
'1.0.0'
- Split from the main R2API.dll into its own submodule.
Install & use Install: BepInEx plugin
- The archive from playbuff is the mod itself — usually a BepInEx plugin (a .dll or a plugin folder once unzipped).
- Recommended: use a community mod manager (such as r2modman) — pick this game, import the mod, and the manager sets up BepInEx and its dependencies for you.
- Manual route: install the BepInEx loader in the game folder, then drop the unzipped .dll or plugin folder into BepInEx/plugins/.
- Launch the game — the BepInEx console logs every plugin it loads; seeing this mod in the log means it is installed.
Mods with listed dependencies need those installed too, or they will not load. Options are usually changed in-game or in the plugin's config file.
Install these first, or the mod will not work: