From eb46e4d15695d70ae5818ec9901a5e95f88071bd Mon Sep 17 00:00:00 2001
From: Staszek Welsh <stalefishies@gmail.com>
Date: Wed, 1 Jun 2022 12:59:45 +0100
Subject: [PATCH] Rename getDividends to getCycleDividends for clarity

---
 src/Corporation/Corporation.tsx       | 4 ++--
 src/Corporation/ICorporation.ts       | 2 +-
 src/Corporation/ui/Overview.tsx       | 2 +-
 src/NetscriptFunctions/Corporation.ts | 2 +-
 4 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/src/Corporation/Corporation.tsx b/src/Corporation/Corporation.tsx
index a41185372..eae2692a5 100644
--- a/src/Corporation/Corporation.tsx
+++ b/src/Corporation/Corporation.tsx
@@ -133,7 +133,7 @@ export class Corporation {
           } else {
             const totalDividends = this.dividendRate * cycleProfit;
             const retainedEarnings = cycleProfit - totalDividends;
-            player.gainMoney(this.getDividends(), "corporation");
+            player.gainMoney(this.getCycleDividends(), "corporation");
             this.addFunds(retainedEarnings);
           }
         } else {
@@ -157,7 +157,7 @@ export class Corporation {
     }
   }
 
-  getDividends(): number {
+  getCycleDividends(): number {
     const profit = this.revenue - this.expenses;
     const cycleProfit = profit * CorporationConstants.SecsPerMarketCycle;
     const totalDividends = this.dividendRate * cycleProfit;
diff --git a/src/Corporation/ICorporation.ts b/src/Corporation/ICorporation.ts
index 457f09061..b2ea08648 100644
--- a/src/Corporation/ICorporation.ts
+++ b/src/Corporation/ICorporation.ts
@@ -55,6 +55,6 @@ export interface ICorporation {
   getScientificResearchMultiplier(): number;
   getStarterGuide(player: IPlayer): void;
   updateDividendTax(): void;
-  getDividends(): number;
+  getCycleDividends(): number;
   toJSON(): any;
 }
diff --git a/src/Corporation/ui/Overview.tsx b/src/Corporation/ui/Overview.tsx
index 126408257..b6390aad3 100644
--- a/src/Corporation/ui/Overview.tsx
+++ b/src/Corporation/ui/Overview.tsx
@@ -279,7 +279,7 @@ function DividendsStats({ profit }: IDividendsStatsProps): React.ReactElement {
   const totalDividends = corp.dividendRate * profit;
   const retainedEarnings = profit - totalDividends;
   const dividendsPerShare = totalDividends / corp.totalShares;
-  const playerEarnings = corp.getDividends() / CorporationConstants.SecsPerMarketCycle;
+  const playerEarnings = corp.getCycleDividends() / CorporationConstants.SecsPerMarketCycle;
   return (
     <StatsTable
       rows={[
diff --git a/src/NetscriptFunctions/Corporation.ts b/src/NetscriptFunctions/Corporation.ts
index 18bab912b..6a8b55ec2 100644
--- a/src/NetscriptFunctions/Corporation.ts
+++ b/src/NetscriptFunctions/Corporation.ts
@@ -955,7 +955,7 @@ export function NetscriptCorporation(player: IPlayer, workerScript: WorkerScript
         sharePrice: corporation.sharePrice,
         dividendRate: corporation.dividendRate,
         dividendTax: corporation.dividendTax,
-        dividendEarnings: corporation.getDividends() / CorporationConstants.SecsPerMarketCycle,
+        dividendEarnings: corporation.getCycleDividends() / CorporationConstants.SecsPerMarketCycle,
         state: corporation.state.getState(),
         divisions: corporation.divisions.map((division): NSDivision => getSafeDivision(division)),
       };