Add Blueprint Interfaces

Kyle Austad 2024-10-07 09:19:49 -06:00
parent 35b2317e47
commit bcd29996ce

16
Blueprint-Interfaces.md Normal file

@ -0,0 +1,16 @@
There are three Blueprint Interfaces that come with the system:
1. ***BPI_ShipCore***
2. ***BPI_Shop***
3. ***BPI_ShopUI***
![](https://git.crabinteractive.com/crabdev/MSSS-Documentation/raw/branch/main/Images/Interfaces.png)
The *ShipCore* interface is the most integral to making sure equipping and the systems functionality works correctly. It's various functions are all categorized for easy organization.
The *ShopUI* interface contains all the functions for controlling UI elements in the kit. Such as opening and closing the Shop UI or the Outfitting UI.
The *Shop* interface is not important at all. In the kit there is a very basic currency system implemented that just uses a float variable on the player pawn to track the players money. This interface just contains 3 functions to get that value, and add or subtract from it. This is easily replaceable with your own currency system. If you need to know where the function calls are for adding/subtracting or getting the players money, they are highlighted in each individual blueprint, however if you open *BPI_Shop* and right click the function you want to replace. Select *Find References/By Name (All)* this will locate all references used across the kit for that various function, which you can then replace with your own logic.
![](https://git.crabinteractive.com/crabdev/MSSS-Documentation/raw/branch/main/Images/Find.png)