changeset 16041:aae197147c05 draft

(svn r20734) -Codechange: Rename GetScaledIndustryProbability() to GetScaledIndustryGenerationProbability().
author alberth <alberth@openttd.org>
date Sat, 04 Sep 2010 11:16:40 +0000
parents e8f4b3e0808c
children 51a3880d61ec
files src/industry_cmd.cpp
diffstat 1 files changed, 5 insertions(+), 5 deletions(-) [+]
line wrap: on
line diff
--- a/src/industry_cmd.cpp
+++ b/src/industry_cmd.cpp
@@ -1840,11 +1840,11 @@
 
 /**
  * Compute the appearance probability for an industry during map creation.
- * @param it Industrytype to compute for
- * @param force_at_least_one Returns whether at least one instance should be forced on map creation
- * @return relative probability for the industry to appear
+ * @param it Industry type to compute.
+ * @param [out] force_at_least_one Returns whether at least one instance should be forced on map creation.
+ * @return Relative probability for the industry to appear.
  */
-static uint32 GetScaledIndustryProbability(IndustryType it, bool *force_at_least_one)
+static uint32 GetScaledIndustryGenerationProbability(IndustryType it, bool *force_at_least_one)
 {
 	const IndustrySpec *ind_spc = GetIndustrySpec(it);
 	uint32 chance = ind_spc->appear_creation[_settings_game.game_creation.landscape] * 16; // * 16 to increase precision
@@ -1909,7 +1909,7 @@
 	uint num_forced = 0;
 
 	for (IndustryType it = 0; it < NUM_INDUSTRYTYPES; it++) {
-		industry_probs[it] = GetScaledIndustryProbability(it, force_at_least_one + it);
+		industry_probs[it] = GetScaledIndustryGenerationProbability(it, force_at_least_one + it);
 		total_prob += industry_probs[it];
 		if (force_at_least_one[it]) num_forced++;
 	}