crabdev/MSSS-Documentation
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add Blueprint Function Library - BPFL_ShipSystem

Kyle Austad 2024-10-06 13:37:09 -06:00
parent 161edb11b4
commit e50de61135
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
Blueprint Function Library - BPFL_ShipSystem.-.md Normal file

@ -0,0 +1,13 @@
# BPFL_ShipSystem
This page covers documentation on the blueprint code contained within the *Blueprint Function Library* included with the kit, *BPFL_ShipSystem*.
## Getters
This category of functions in the function library is used to retrieve variables from across various systems in the kit. I differentiated this from *Checkers* as that category generally finds if something is *True* or *False* based on a variety of parameters.
### GetModuleClassEnumValue
This function takes a module class from the enumeration *E_ModuleClasses* and assigns a value to it for comparison. Since UE has issues comparing enums directly if they are not simply numerical this allows for you to define your classes with anything such as a phonetic alphabet like *Alpha, Bravo, Charlie...Zulu, etc.*. The scoring is done in reverse, so a lower score is a better class. Therefore *None* is assigned a high value like 500 and class one is given 1 while class 2 is given a score of 2 and so on. The letter ratings following a class A-D are given the same score as a decimal of the primary class. A is 1 (as it is the best rating/subclass it has the lowest value) and D is given 4. So class 3C is scored as 3.3.
![](https://git.crabinteractive.com/crabdev/MSSS-Documentation/raw/branch/main/Images/BPFL_ShipSystem/GetModuleClassEnumValue.png)