Interactable Exfils API

Jehree added a new file:

File

Interactable Exfils API

Adds interaction prompts to exfils, letting you toggle the exfil timer on and off (you can finally loot that body without extracting!) as well as API tools for modders to add their own exfil interaction options.

Jehree

Aug 29th 2024

Quote

Modders, see "Modders" tab for info on the API functions of this mod

On its own, this mod does very little.

It will:

• Make all extracts have an "Extract" prompt appear when you are inside their extraction zone. Interacting with it will toggle the extraction timer (read: loot bodies that end up in an extraction area without accidentally extracting)
• Config option exists to set whether the timer will be on immediately upon entering an exfil zone or if it will require you to interact with it first.

PLEASE DO NOT REDISTRIBUTE THIS MOD

If you are using it as a dependency to one of your projects, link it as a dependency. Do not package it with your upload.

The main purpose of this mod is to expose the ability to conveniently add custom interaction options to the interactable areas that this mod creates. I made this mod in preparation for a few upcoming projects (in raid stash, in raid traders (maybe?) etc.)

See Examples class, as well as the lines commented out in the Start method in the Plugin.cs file in the project repo to see how to set up custom interactions (more detailed docs may come later).

Sorry to remove old docs, some key things changed and I don't feel like maintaining detailed docs that may change in the near future.

If you need a list of all the active exfils in raid, you can get it via the InteractableExfilsSession component attached to the player:

Display More

Jehree added a new version:

File

Interactable Exfils API 1.1.0

Fixed issue with labs extracts (sewer and the elevators) not allowing exfil zone to be enabled

• the "Extract" prompt no longer is gray / disabled when the extract has unmet requirements (power, switch, etc.). Now, it will play an error sound and give you a notification pop up indicating what the incomplete requirements are.
• All car extracts as well as the elevators on Labs do not have a toggleable timer. Once you begin extracting, you cannot stop it. All additional exfil interactions added by

…

Jehree

Aug 26th 2024

Quote

Fixed issue with labs extracts (sewer and the elevators) not allowing exfil zone to be enabled

• the "Extract" prompt no longer is gray / disabled when the extract has unmet requirements (power, switch, etc.). Now, it will play an error sound and give you a notification pop up indicating what the incomplete requirements are.
• All car extracts as well as the elevators on Labs do not have a toggleable timer. Once you begin extracting, you cannot stop it. All additional exfil interactions added by other mods using this API will show on the car / the button inside the elevator.
• Fixed debug prompt not showing up on car extracts.

Let me know if any other extracts are broken!

Jehree added a new version:

File

Interactable Exfils API 1.2.0

Code cleanup and refactor.
End user experience is largely unchanged, but I did add this:

• Added option to display a disabled interaction prompt that says "Extract Unavailable" when in an exfil that is not available to the player (including exfils that will never be available, like scav extracts when you're on a PMC run). The setting is defaulted to false, enable it in F12 menu if desired.

API stuff:

• API now properly utilizes itself to add the interactions it adds, instead of hardcoding them in

…

Jehree

Aug 29th 2024

Quote

Code cleanup and refactor.

End user experience is largely unchanged, but I did add this:

• Added option to display a disabled interaction prompt that says "Extract Unavailable" when in an exfil that is not available to the player (including exfils that will never be available, like scav extracts when you're on a PMC run). The setting is defaulted to false, enable it in F12 menu if desired.

API stuff:

• API now properly utilizes itself to add the interactions it adds, instead of hardcoding them in weird places.
• CustomExfilTrigger is now passed into the event so that it's methods can be used if desired.
• Player Side is no longer passed through event, fetch it via Singleton<GameWorld>.Instance.MainPlayer.Side if you need it.
• Interactions are fetched every single time the interaction menu is refreshed (entering the zone for the first time, when looking at something else and looking back, etc.). This means they can be modified mid raid, and are generally just more powerful.
• API users can no longer disable the extract toggle. Having that option in felt weird and out of scope, so I removed it. If another mod wants to make an extract unavailable, it should do so via requirements or other methods.