openttd-mini: comparison src/town

equal deleted inserted replaced

-:8be3ef428116
+:cbfd00fc5d88
 }
 /* Initialize the town-pool */
 DEFINE_OLD_POOL(Town, Town, TownPoolNewBlock, NULL)
+/**
+* Removes a specific town as well as all industries
+* under its "juridiction"
+* @param t Town to remove
+*/
 void DestroyTown(Town *t)
 {
 	Industry *i;
 	TileIndex tile;
 	variant -= y >> 6;
 	variant &= 3;
 	return variant;
 }
+/**
+* House Tile drawing handler.
+* Part of the tile loop process
+* @param ti TileInfo of the tile to draw
+*/
 static void DrawTile_Town(TileInfo *ti)
 {
 	const DrawBuildingsTileStruct *dcts;
 	SpriteID image;
 	SpriteID pal;
 static Slope GetSlopeTileh_Town(TileIndex tile, Slope tileh)
 {
 	return SLOPE_FLAT;
 }
+/**
+* Animate a tile for a town
+* Only certain houses can be animated
+* The newhouses animation superseeds regular ones
+* @param tile TileIndex of the house to animate
+*/
 static void AnimateTile_Town(TileIndex tile)
 {
 	int pos, dest;
 	if (GetHouseType(tile) >= NEW_HOUSE_OFFSET) {
 	MarkTileDirtyByTile(tile);
 }
 static void UpdateTownRadius(Town *t);
+/**
+* Determines if a town is close to a tile
+* @param tile TileIndex of the tile to query
+* @param dist maximum distance to be accepted
+* @returns true if the tile correspond to the distance criteria
+*/
 static bool IsCloseToTown(TileIndex tile, uint dist)
 {
 	const Town* t;
 	FOR_ALL_TOWNS(t) {
 		if (DistanceManhattan(tile, t->xy) < dist) return true;
 	}
 	return false;
 }
+/**
+* Marks the town sign as needing a repaint
+* @param t Town requesting repaint
+*/
 static void MarkTownSignDirty(Town *t)
 {
 	MarkAllViewportsDirty(
 		t->sign.left - 6,
 		t->sign.top - 3,
 		t->sign.left + t->sign.width_1 * 4 + 12,
 		t->sign.top + 45
 	);
 }
+/**
+* Resize the sign(label) of the town after changes in
+* population (creation or growth or else)
+* @param t Town to update
+*/
 void UpdateTownVirtCoord(Town *t)
 {
 	Point pt;
 	MarkTownSignDirty(t);
 	UpdateViewportSignPos(&t->sign, pt.x, pt.y - 24,
 		_patches.population_in_label ? STR_TOWN_LABEL_POP : STR_TOWN_LABEL);
 	MarkTownSignDirty(t);
 }
+/**
+* Change the towns population
+* @param t Town which polulation has changed
+* @param mod polulation change (can be positive or negative)
+*/
 static void ChangePopulation(Town *t, int mod)
 {
 	t->population += mod;
 	InvalidateWindow(WC_TOWN_VIEW, t->index);
 	UpdateTownVirtCoord(t);
 	if (_town_sort_order & 2) _town_sort_dirty = true;
 }
+/**
+* Determines the world population
+* Basically, count population of all towns, one by one
+* @return uint32 the calculated population of the world
+*/
 uint32 GetWorldPopulation()
 {
 	uint32 pop;
 	const Town* t;
 	pop = 0;
 	FOR_ALL_TOWNS(t) pop += t->population;
 	return pop;
 }
+/**
+* Helper function for house completion stages progression
+* @param tile TileIndex of the house (or parts of it) to "grow"
+*/
 static void MakeSingleHouseBigger(TileIndex tile)
 {
 	assert(IsTileType(tile, MP_HOUSE));
+	/* means it is completed, get out. */
 	if (LiftHasDestination(tile)) return;
+	/* progress in construction stages */
 	IncHouseConstructionTick(tile);
 	if (GetHouseConstructionTick(tile) != 0) return;
+	/* Check and/or  */
 	if (HASBIT(GetHouseSpecs(GetHouseType(tile))->callback_mask, CBM_CONSTRUCTION_STATE_CHANGE)) {
 		uint16 callback_res = GetHouseCallback(CBID_CONSTRUCTION_STATE_CHANGE, 0, GetHouseType(tile), GetTownByTile(tile), tile);
 		if (callback_res != CALLBACK_FAILED) ChangeHouseAnimationFrame(tile, callback_res);
 	}
 		ChangePopulation(GetTownByTile(tile), GetHouseSpecs(GetHouseType(tile))->population);
 	}
 	MarkTileDirtyByTile(tile);
 }
+/** Make the house advances in its construction stages until completion
+* @param tile TileIndex of house
+*/
 static void MakeTownHouseBigger(TileIndex tile)
 {
 	uint flags = GetHouseSpecs(GetHouseType(tile))->building_flags;
 	if (flags & BUILDING_HAS_1_TILE)  MakeSingleHouseBigger(TILE_ADDXY(tile, 0, 0));
 	if (flags & BUILDING_2_TILES_Y)   MakeSingleHouseBigger(TILE_ADDXY(tile, 0, 1));
 	if (flags & BUILDING_2_TILES_X)   MakeSingleHouseBigger(TILE_ADDXY(tile, 1, 0));
 	if (flags & BUILDING_HAS_4_TILES) MakeSingleHouseBigger(TILE_ADDXY(tile, 1, 1));
 }
+/**
+* Periodic tic handler for houses and town
+* @param tile been asked to do its stuff
+*/
 static void TileLoop_Town(TileIndex tile)
 {
 	Town *t;
 	uint32 r;
 	HouseID house_id = GetHouseType(tile);
 		MakeTownHouseBigger(tile);
 		return;
 	}
 	/* If the lift has a destination, it is already an animated tile. */
-	if ((hs->building_flags & BUILDING_IS_ANIMATED) && house_id < NEW_HOUSE_OFFSET && !LiftHasDestination(tile) && CHANCE16(1, 2)) AddAnimatedTile(tile);
+	if ((hs->building_flags & BUILDING_IS_ANIMATED) &&
+			house_id < NEW_HOUSE_OFFSET &&
+			!LiftHasDestination(tile) &&
+			CHANCE16(1, 2))
+		AddAnimatedTile(tile);
 	t = GetTownByTile(tile);
 	r = Random();
 		t->new_act_mail += moved;
 	}
 	_current_player = OWNER_TOWN;
-	if (hs->building_flags & BUILDING_HAS_1_TILE && HASBIT(t->flags12, TOWN_IS_FUNDED) && CanDeleteHouse(tile) && --t->time_until_rebuild == 0) {
+	if (hs->building_flags & BUILDING_HAS_1_TILE &&
+			HASBIT(t->flags12, TOWN_IS_FUNDED) &&
+			CanDeleteHouse(tile) &&
+			--t->time_until_rebuild == 0) {
 		t->time_until_rebuild = GB(r, 16, 8) + 192;
 		ClearTownHouse(t, tile);
 		/* Rebuild with another house? */
 	}
 	_current_player = OWNER_NONE;
 }
+/**
+* Unused handler
+* @param tile unused
+*/
 static void ClickTile_Town(TileIndex tile)
 {
 	/* not used */
 }

changeset 6534	cbfd00fc5d88
parent 6525	a21429c6f16f
child 6547	f5ae0269d236