DOCS: Add type of return for 3 formulas functions. (#967)

This commit is contained in:
David Walker 2023-12-07 04:33:15 -08:00 committed by GitHub
parent b46b6e62bc
commit 019f2d6a11
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 6 additions and 6 deletions

@ -23,5 +23,5 @@ growTime(server: Server, player: Person): number;
number number
The calculated grow time. The calculated grow time, in milliseconds.

@ -23,5 +23,5 @@ hackTime(server: Server, player: Person): number;
number number
The calculated hack time. The calculated hack time, in milliseconds.

@ -23,5 +23,5 @@ weakenTime(server: Server, player: Person): number;
number number
The calculated weaken time. The calculated weaken time, in milliseconds.

@ -4240,21 +4240,21 @@ interface HackingFormulas {
* Calculate hack time. * Calculate hack time.
* @param server - Server info, typically from {@link NS.getServer | getServer} * @param server - Server info, typically from {@link NS.getServer | getServer}
* @param player - Player info, typically from {@link NS.getPlayer | getPlayer} * @param player - Player info, typically from {@link NS.getPlayer | getPlayer}
* @returns The calculated hack time. * @returns The calculated hack time, in milliseconds.
*/ */
hackTime(server: Server, player: Person): number; hackTime(server: Server, player: Person): number;
/** /**
* Calculate grow time. * Calculate grow time.
* @param server - Server info, typically from {@link NS.getServer | getServer} * @param server - Server info, typically from {@link NS.getServer | getServer}
* @param player - Player info, typically from {@link NS.getPlayer | getPlayer} * @param player - Player info, typically from {@link NS.getPlayer | getPlayer}
* @returns The calculated grow time. * @returns The calculated grow time, in milliseconds.
*/ */
growTime(server: Server, player: Person): number; growTime(server: Server, player: Person): number;
/** /**
* Calculate weaken time. * Calculate weaken time.
* @param server - Server info, typically from {@link NS.getServer | getServer} * @param server - Server info, typically from {@link NS.getServer | getServer}
* @param player - Player info, typically from {@link NS.getPlayer | getPlayer} * @param player - Player info, typically from {@link NS.getPlayer | getPlayer}
* @returns The calculated weaken time. * @returns The calculated weaken time, in milliseconds.
*/ */
weakenTime(server: Server, player: Person): number; weakenTime(server: Server, player: Person): number;
} }