-
Notifications
You must be signed in to change notification settings - Fork 1
ModInterop Exports API
David Higueros edited this page Aug 8, 2025
·
2 revisions
This Helper includes a few things exported with ModInterop, namely:
- GetEntityChainComponent: Returns an Entity Chain Component to keep two entities's positions tied together.
- GetEntityTimerComponent: Returns an Entity Timer Component to easily execute a function on the entity added once the timer runs to completion.
- GetEntityFlaggerComponent: Returns an Entity Flagger Component to easily execute a function on the entity added to once the flag state matches the needed state.
- GetCurrentPlayerHealth: Useful to know if a Health System is active on Scene and if so, what the Player's health value is at. Returns -1 if no Health System is active.
- RecoverPlayerHealth: Makes the player recover health points as many as the value given. This can go over the PLayer's default health value.
- MakePlayerTakeDamage: Useful to extend utility from the Health System to set custom parameters to take damage.
-
GetBossHealthTrackerComponent: Returns a component that allows any entity that can track a number to use the Boss Health Bar entity display for it.
- The integer can represent anything, and can be represented in multiple ways.
-
GetGlobalSavePointChangerComponent: Returns a Global Save Point Changer Component.
- If added to an entity your mod cannot edit, it must be added with the CreateGlobalSavePointOnEntityOnMethod export, so the IL Hook can be applied.
- If added to an entity your mode is able to edit, to activate its Save Point Changing method, call the Component's
Updatemethod or make itActive. Each change or usage should do this. The component starts inactive, and calling Update will force it to be inactive. The logic is kept inUpdateso it can be called without having it be its specific type when handled.
-
CreateGlobalSavePointOnEntityOnMethod: Creates and adds a Global Save Point Changer component on the entity provided, and creates an IL hook on that entity's method that will trigger the Save Point update.
- As of current release, this IL hook has not been fully tested, but many other bugs have been fixed that an update release was needed.
The Mod Import Name is "BossesHelper".