- Found in:
- iEquip
intfunctionBringMeASoul(inta_reqCharge, inta_fillMethod, boola_partialFill, boola_wasteOK)NativeGlobal
Description
Documentation Comment
@brief Fetches the most optimal soulgem to fill an enchanted weapon.
@param a_reqCharge The required soul to fetch. Valid inputs 1-5.
@param a_fillMethod The method used to fill the soulgem. Valid inputs 0-1.
@param a_partialFill Determines whether partially filled soul gems can be returned.
@param a_wasteOK Determines whether soulgems exceeding the requred size can be returned.
@return Returns the soul size of the found soul. Returns -1 if the search was a failure.
@notes This function will remove the soulgem automatically.
Parameters
inta_reqCharge
inta_fillMethod
boola_partialFill
boola_wasteOK
Examples
Auto-Generated Example
int myInt__a_reqCharge
int myInt__a_fillMethod
bool myBool__a_partialFill
bool myBool__a_wasteOK
int returnedValue = iEquip_SoulSeeker.BringMeASoul(myInt__a_reqCharge, myInt__a_fillMethod, myBool__a_partialFill, myBool__a_wasteOK)