diff --git a/mods/Interactable Exfils API/BepInEx/plugins/InteractableExfilsAPI.dll b/mods/Interactable Exfils API/BepInEx/plugins/InteractableExfilsAPI.dll new file mode 100644 index 0000000..6e6f4a9 Binary files /dev/null and b/mods/Interactable Exfils API/BepInEx/plugins/InteractableExfilsAPI.dll differ diff --git a/mods/Interactable Exfils API/User/Mods/JEHREE-InteractableExfilsAPI-LICENSE.txt b/mods/Interactable Exfils API/User/Mods/JEHREE-InteractableExfilsAPI-LICENSE.txt new file mode 100644 index 0000000..7f67dfa --- /dev/null +++ b/mods/Interactable Exfils API/User/Mods/JEHREE-InteractableExfilsAPI-LICENSE.txt @@ -0,0 +1 @@ +Interactable Exfils API © 2024 by Jehree is licensed under Creative Commons Attribution-NoDerivatives 4.0 International. To view a copy of this license, visit https://creativecommons.org/licenses/by-nd/4.0/ diff --git a/mods/Interactable Exfils API/User/Mods/JEHREE-InteractableExfilsAPI-README.md b/mods/Interactable Exfils API/User/Mods/JEHREE-InteractableExfilsAPI-README.md new file mode 100644 index 0000000..5c54724 --- /dev/null +++ b/mods/Interactable Exfils API/User/Mods/JEHREE-InteractableExfilsAPI-README.md @@ -0,0 +1,103 @@ +# Interactable Exfils API + +The main purpose of this api mod is to expose the ability to conveniently add custom interaction options to the interactable areas that this mod creates. + +## API Usage + +### Initial setup in your project +The only thing you need to do to start development with Interactable Exfils API is to reference the dll in your `.csproj` file: + +```xml + + + $(PathToSPT)\BepInEx\plugins\InteractableExfilsAPI.dll + + +``` + +Then you have to create at least one handler and register it with the instance of the `InteractableExfilsService` + +### Create your custom handler + +```cs +// This example will add an enabled static action to every single extract in the game +public static class Examples +{ + // this static function is an exfil actions handler you can register with the InteractableExfilsService + public static OnActionsAppliedResult SimpleExample(ExfiltrationPoint exfil, CustomExfilTrigger customExfilTrigger, bool exfilIsAvailableToPlayer) + { + // This part of the code is ran everytime the prompt is created/refreshed + // It occurs when: + // 1. the player enter the exfil zone + // 2. the player interact with the prompt (i.e. press the "F" key) + // 3. the player changed a BepInEx config in InteractableExfilsAPI + // 4. the customExfilTrigger.RefreshPrompt() method has been invoked + // 5. the InteractableExfilsService.RefreshPrompt() method has been invoked + + bool isDisabled = false; + + // This represent the definition of 1 prompt item + CustomExfilAction customExfilAction = new CustomExfilAction( + "Example Interaction", + isDisabled, + () => { + // This part of the code is ran when the player interact with this prompt item + NotificationManagerClass.DisplayMessageNotification("Simple Interaction Example Selected!"); + } + ); + + // Here you have control over the ordering of the actions + List actions = [customExfilAction]; + + return new OnActionsAppliedResult(actions); + } +} +``` + +Take a look to the [Examples class](./Examples.cs) for more. + +### Register your actions + +You can do this whenever you want but the recommended way for doing it as early as possible is in the `Start()` method of your plugin class + +```cs +public class Plugin : BaseUnityPlugin { + private void Awake() { + // enable your patches here + } + private void Start() { + // retrieve the interactable exfil singleton service + InteractableExfilsService ieService = InteractableExfilsService.Instance(); + + // register SimpleExample handler + ieService.OnActionsAppliedEvent += Examples.SimpleExample; + } +} +``` + +### Disable vanilla actions +If you don't want to let Interactable Exfils API show the car exfils and labs elevator exfils prompts, it's possible to disable them. Be aware that in this situation your mod should handle the extraction logic by itself otherwise the player couldn't extract. + +```cs +public static void DisableVanillaAction() +{ + // e.g. disable vanilla action (for cars and labs elevator) + InteractableExfilsService.Instance().DisableVanillaActions = true; +} +``` + +### Retrieve all active exfils + +If you need a list of all the active exfils in raid, you can get it via the `InteractableExfilsSession` component + +```cs +public static List ExampleGetExfils() { + InteractableExfilsSession session = InteractableExfilsService.GetSession(); + return session.ActiveExfils; +} +``` + +## Mods that use Interactable Exfils API +If your mod use Interactable Exfils API, please make a PR here so we can point it as an example. + +- [Path To Tarkov](https://hub.sp-tarkov.com/files/file/569-path-to-tarkov/): used in [PTT.Services.ExfilPromptService](https://github.com/guillaumearm/PathToTarkov/blob/cc5a24140ae3acd9e212b9e73729e42b77780a7d/PTT-Plugin/Services/ExfilPromptService.cs) diff --git a/mods/Interactable Exfils API/meta.ini b/mods/Interactable Exfils API/meta.ini new file mode 100644 index 0000000..60e87f7 --- /dev/null +++ b/mods/Interactable Exfils API/meta.ini @@ -0,0 +1,28 @@ +[General] +gameName=spt +modid=0 +version=d2025.1.13.0 +newestVersion= +category="1," +nexusFileStatus=1 +installationFile=Jehree-InteractableExfilsAPI-1.5.1.zip +repository=Nexus +ignoredVersion= +comments= +notes= +nexusDescription= +url= +hasCustomURL=true +lastNexusQuery= +lastNexusUpdate= +nexusLastModified=2025-01-14T06:34:02Z +nexusCategory=0 +converted=false +validated=false +color=@Variant(\0\0\0\x43\0\xff\xff\0\0\0\0\0\0\0\0) +tracked=0 + +[installedFiles] +1\modid=0 +1\fileid=0 +size=1 diff --git a/profiles/Multiplayer/modlist.txt b/profiles/Multiplayer/modlist.txt index b0cc076..763b4fc 100644 --- a/profiles/Multiplayer/modlist.txt +++ b/profiles/Multiplayer/modlist.txt @@ -98,6 +98,7 @@ +Performance Improvements -Bug Fixes & Optimizations_separator +Custom Interactions ++Interactable Exfils API +Virtual's Custom Quest Loader +Mod Sync +Waypoints diff --git a/profiles/Server/modlist.txt b/profiles/Server/modlist.txt index 8e57f86..9c39b12 100644 --- a/profiles/Server/modlist.txt +++ b/profiles/Server/modlist.txt @@ -97,6 +97,7 @@ +Performance Improvements +Bug Fixes & Optimizations_separator -Custom Interactions +-Interactable Exfils API +Virtual's Custom Quest Loader +Mod Sync +Waypoints