src/newgrf_house.h
author truelight
Fri, 13 Jul 2007 09:18:50 +0000
branchnoai
changeset 9641 855e32c08c9b
parent 9626 79f2b5a0cdd7
child 6743 cabfaa4a0295
permissions -rw-r--r--
(svn r10533) [NoAI] -Sync with trunk r10460:r10532.
9476
1d1ed96f32ad (svn r9323) [NoAI] -Sync with trunk r9206:9322
truelight
parents:
diff changeset
     1
/* $Id$ */
1d1ed96f32ad (svn r9323) [NoAI] -Sync with trunk r9206:9322
truelight
parents:
diff changeset
     2
1d1ed96f32ad (svn r9323) [NoAI] -Sync with trunk r9206:9322
truelight
parents:
diff changeset
     3
/** @file newgrf_house.h */
1d1ed96f32ad (svn r9323) [NoAI] -Sync with trunk r9206:9322
truelight
parents:
diff changeset
     4
1d1ed96f32ad (svn r9323) [NoAI] -Sync with trunk r9206:9322
truelight
parents:
diff changeset
     5
#ifndef NEWGRF_HOUSE_H
1d1ed96f32ad (svn r9323) [NoAI] -Sync with trunk r9206:9322
truelight
parents:
diff changeset
     6
#define NEWGRF_HOUSE_H
1d1ed96f32ad (svn r9323) [NoAI] -Sync with trunk r9206:9322
truelight
parents:
diff changeset
     7
1d1ed96f32ad (svn r9323) [NoAI] -Sync with trunk r9206:9322
truelight
parents:
diff changeset
     8
#include "town.h"
1d1ed96f32ad (svn r9323) [NoAI] -Sync with trunk r9206:9322
truelight
parents:
diff changeset
     9
1d1ed96f32ad (svn r9323) [NoAI] -Sync with trunk r9206:9322
truelight
parents:
diff changeset
    10
/**
1d1ed96f32ad (svn r9323) [NoAI] -Sync with trunk r9206:9322
truelight
parents:
diff changeset
    11
 * Makes class IDs unique to each GRF file.
1d1ed96f32ad (svn r9323) [NoAI] -Sync with trunk r9206:9322
truelight
parents:
diff changeset
    12
 * Houses can be assigned class IDs which are only comparable within the GRF
1d1ed96f32ad (svn r9323) [NoAI] -Sync with trunk r9206:9322
truelight
parents:
diff changeset
    13
 * file they were defined in. This mapping ensures that if two houses have the
1d1ed96f32ad (svn r9323) [NoAI] -Sync with trunk r9206:9322
truelight
parents:
diff changeset
    14
 * same class as defined by the GRF file, the classes are different within the
1d1ed96f32ad (svn r9323) [NoAI] -Sync with trunk r9206:9322
truelight
parents:
diff changeset
    15
 * game. An array of HouseClassMapping structs is created, and the array index
1d1ed96f32ad (svn r9323) [NoAI] -Sync with trunk r9206:9322
truelight
parents:
diff changeset
    16
 * of the struct that matches both the GRF ID and the class ID is the class ID
1d1ed96f32ad (svn r9323) [NoAI] -Sync with trunk r9206:9322
truelight
parents:
diff changeset
    17
 * used in the game.
1d1ed96f32ad (svn r9323) [NoAI] -Sync with trunk r9206:9322
truelight
parents:
diff changeset
    18
 *
1d1ed96f32ad (svn r9323) [NoAI] -Sync with trunk r9206:9322
truelight
parents:
diff changeset
    19
 * Although similar to the HouseIDMapping struct above, this serves a different
1d1ed96f32ad (svn r9323) [NoAI] -Sync with trunk r9206:9322
truelight
parents:
diff changeset
    20
 * purpose. Since the class ID is not saved anywhere, this mapping does not
1d1ed96f32ad (svn r9323) [NoAI] -Sync with trunk r9206:9322
truelight
parents:
diff changeset
    21
 * need to be persistent; it just needs to keep class ids unique.
1d1ed96f32ad (svn r9323) [NoAI] -Sync with trunk r9206:9322
truelight
parents:
diff changeset
    22
 */
1d1ed96f32ad (svn r9323) [NoAI] -Sync with trunk r9206:9322
truelight
parents:
diff changeset
    23
struct HouseClassMapping {
1d1ed96f32ad (svn r9323) [NoAI] -Sync with trunk r9206:9322
truelight
parents:
diff changeset
    24
	uint32 grfid;     ////< The GRF ID of the file this class belongs to
1d1ed96f32ad (svn r9323) [NoAI] -Sync with trunk r9206:9322
truelight
parents:
diff changeset
    25
	uint8  class_id;  ////< The class id within the grf file
1d1ed96f32ad (svn r9323) [NoAI] -Sync with trunk r9206:9322
truelight
parents:
diff changeset
    26
};
1d1ed96f32ad (svn r9323) [NoAI] -Sync with trunk r9206:9322
truelight
parents:
diff changeset
    27
1d1ed96f32ad (svn r9323) [NoAI] -Sync with trunk r9206:9322
truelight
parents:
diff changeset
    28
void CheckHouseIDs();
1d1ed96f32ad (svn r9323) [NoAI] -Sync with trunk r9206:9322
truelight
parents:
diff changeset
    29
1d1ed96f32ad (svn r9323) [NoAI] -Sync with trunk r9206:9322
truelight
parents:
diff changeset
    30
HouseClassID AllocateHouseClassID(byte grf_class_id, uint32 grfid);
1d1ed96f32ad (svn r9323) [NoAI] -Sync with trunk r9206:9322
truelight
parents:
diff changeset
    31
1d1ed96f32ad (svn r9323) [NoAI] -Sync with trunk r9206:9322
truelight
parents:
diff changeset
    32
void InitializeBuildingCounts();
1d1ed96f32ad (svn r9323) [NoAI] -Sync with trunk r9206:9322
truelight
parents:
diff changeset
    33
void IncreaseBuildingCount(Town *t, HouseID house_id);
1d1ed96f32ad (svn r9323) [NoAI] -Sync with trunk r9206:9322
truelight
parents:
diff changeset
    34
void DecreaseBuildingCount(Town *t, HouseID house_id);
1d1ed96f32ad (svn r9323) [NoAI] -Sync with trunk r9206:9322
truelight
parents:
diff changeset
    35
void AfterLoadCountBuildings();
1d1ed96f32ad (svn r9323) [NoAI] -Sync with trunk r9206:9322
truelight
parents:
diff changeset
    36
1d1ed96f32ad (svn r9323) [NoAI] -Sync with trunk r9206:9322
truelight
parents:
diff changeset
    37
void DrawNewHouseTile(TileInfo *ti, HouseID house_id);
1d1ed96f32ad (svn r9323) [NoAI] -Sync with trunk r9206:9322
truelight
parents:
diff changeset
    38
void AnimateNewHouseTile(TileIndex tile);
1d1ed96f32ad (svn r9323) [NoAI] -Sync with trunk r9206:9322
truelight
parents:
diff changeset
    39
void ChangeHouseAnimationFrame(TileIndex tile, uint16 callback_result);
1d1ed96f32ad (svn r9323) [NoAI] -Sync with trunk r9206:9322
truelight
parents:
diff changeset
    40
9624
b71483f2330f (svn r9915) [NoAI] -Sync with trunk -r9815:9914
glx
parents: 9476
diff changeset
    41
uint16 GetHouseCallback(uint16 callback, uint32 param1, uint32 param2, HouseID house_id, Town *town, TileIndex tile);
9476
1d1ed96f32ad (svn r9323) [NoAI] -Sync with trunk r9206:9322
truelight
parents:
diff changeset
    42
1d1ed96f32ad (svn r9323) [NoAI] -Sync with trunk r9206:9322
truelight
parents:
diff changeset
    43
bool CanDeleteHouse(TileIndex tile);
1d1ed96f32ad (svn r9323) [NoAI] -Sync with trunk r9206:9322
truelight
parents:
diff changeset
    44
1d1ed96f32ad (svn r9323) [NoAI] -Sync with trunk r9206:9322
truelight
parents:
diff changeset
    45
bool NewHouseTileLoop(TileIndex tile);
1d1ed96f32ad (svn r9323) [NoAI] -Sync with trunk r9206:9322
truelight
parents:
diff changeset
    46
1d1ed96f32ad (svn r9323) [NoAI] -Sync with trunk r9206:9322
truelight
parents:
diff changeset
    47
#endif /* NEWGRF_HOUSE_H */