DOCUMENTATION: Clarify getGraftableAugmentations API (#1858)

This commit is contained in:
catloversg
2024-12-18 18:23:56 +07:00
committed by GitHub
parent 40f3d6ea7b
commit c2fe6108e1
4 changed files with 19 additions and 10 deletions

View File

@@ -5007,15 +5007,21 @@ export interface Grafting {
getAugmentationGraftTime(augName: string): number;
/**
* Retrieves a list of Augmentations that can be grafted.
* Retrieves a list of augmentations that can be grafted.
*
* @remarks
* RAM cost: 5 GB
*
* Note that this function returns a list of currently graftable Augmentations,
* based off of the Augmentations that you already own.
* Note:
*
* @returns An array of graftable Augmentations.
* - This function returns a list of currently graftable augmentations, based on the augmentations that you already
* own.
*
* - This function does not check your current money and prerequisite augmentations. For example, it returns
* "Augmented Targeting II" even when you don't have enough money to graft that augmentation or don't have the
* prerequisite augmentation ("Augmented Targeting I").
*
* @returns An array of graftable augmentations.
*/
getGraftableAugmentations(): string[];