| regen.inc Functions | |
| Includes | |
| The following inc files are included in regen.inc | |
| none | |
| AP_SetVitalRegenRateMod |
|
| Parameters | |
| (mobile, vital_name, number) | |
| Name | Type |
| mobile | Mobile reference to set the modifier on. |
| vital_name | Name of the vital to set the regen modifier for. |
| number | Modifier (+/-) points to set for the regen rate. |
| Explanation | |
| Sets the regeneration rate modifier for an attribute. Base values are in settings.cfg (multiply by 100) |
|
| Return Values | |
| Returns 1 | |
| AP_GetVitalRegenRateMod |
|
| Parameters | |
| (mobile, vital_name) | |
| Name | Type |
| mobile | Mobile reference to get the regen information from. |
| vital_name | Name of the vital to get the regeneration rate for. |
| Explanation | |
| Gets the regeneration rate modifier for a vital. | |
| Return Values | |
| Returns an integer. | |
| AP_LoadVitalRegenRateProp |
|
| Parameters | |
| (mobile) | |
| Name | Type |
| mobile | Mobile reference to get the regen information from. |
| Explanation | |
| Loads the dictionary of regeneration settings from a mobile. | |
| Return Values | |
| Returns a dictionary | |
| AP_SaveVitalRegenRateProp | |
| Parameters | |
| (mobile, byref regen_prop) | |
| Name | Type |
| mobile | Mobile reference to save the regen information on. |
| regen_prop | Dictionary containing regeneration modifier values. |
| Explanation | |
| Saves the dictionary of regeneration settings on a mobile. Updates the regeneration rate on the mobile. | |
| Return Values | |
| Returns the result of saving the property. | |