diff options
Diffstat (limited to 'src/player_face.h')
| -rw-r--r-- | src/player_face.h | 242 |
1 files changed, 121 insertions, 121 deletions
diff --git a/src/player_face.h b/src/player_face.h index 2a293e331..6f2a96ff9 100644 --- a/src/player_face.h +++ b/src/player_face.h @@ -1,9 +1,9 @@ /* $Id$ */ -/** @file player_face.h Functionality related to the player's face */ +/** @file company_manager_face.h Functionality related to the company manager's face */ -#ifndef PLAYER_FACE_H -#define PLAYER_FACE_H +#ifndef COMPANY_MANAGER_FACE_H +#define COMPANY_MANAGER_FACE_H #include "core/random_func.hpp" #include "core/bitmath_func.hpp" @@ -21,214 +21,214 @@ enum GenderEthnicity { }; DECLARE_ENUM_AS_BIT_SET(GenderEthnicity); ///< See GenderRace as a bitset -/** Bitgroups of the PlayerFace variable */ -enum PlayerFaceVariable { - PFV_GENDER, - PFV_ETHNICITY, - PFV_GEN_ETHN, - PFV_HAS_MOUSTACHE, - PFV_HAS_TIE_EARRING, - PFV_HAS_GLASSES, - PFV_EYE_COLOUR, - PFV_CHEEKS, - PFV_CHIN, - PFV_EYEBROWS, - PFV_MOUSTACHE, - PFV_LIPS, - PFV_NOSE, - PFV_HAIR, - PFV_JACKET, - PFV_COLLAR, - PFV_TIE_EARRING, - PFV_GLASSES, - PFV_END +/** Bitgroups of the CompanyManagerFace variable */ +enum CompanyManagerFaceVariable { + CMFV_GENDER, + CMFV_ETHNICITY, + CMFV_GEN_ETHN, + CMFV_HAS_MOUSTACHE, + CMFV_HAS_TIE_EARRING, + CMFV_HAS_GLASSES, + CMFV_EYE_COLOUR, + CMFV_CHEEKS, + CMFV_CHIN, + CMFV_EYEBROWS, + CMFV_MOUSTACHE, + CMFV_LIPS, + CMFV_NOSE, + CMFV_HAIR, + CMFV_JACKET, + CMFV_COLLAR, + CMFV_TIE_EARRING, + CMFV_GLASSES, + CMFV_END }; -DECLARE_POSTFIX_INCREMENT(PlayerFaceVariable); +DECLARE_POSTFIX_INCREMENT(CompanyManagerFaceVariable); -/** Information about the valid values of PlayerFace bitgroups as well as the sprites to draw */ -struct PlayerFaceBitsInfo { - byte offset; ///< Offset in bits into the PlayerFace - byte length; ///< Number of bits used in the PlayerFace +/** Information about the valid values of CompanyManagerFace bitgroups as well as the sprites to draw */ +struct CompanyManagerFaceBitsInfo { + byte offset; ///< Offset in bits into the CompanyManagerFace + byte length; ///< Number of bits used in the CompanyManagerFace byte valid_values[GE_END]; ///< The number of valid values per gender/ethnicity SpriteID first_sprite[GE_END]; ///< The first sprite per gender/ethnicity }; -/** Lookup table for indices into the PlayerFace, valid ranges and sprites */ -static const PlayerFaceBitsInfo _pf_info[] = { +/** Lookup table for indices into the CompanyManagerFace, valid ranges and sprites */ +static const CompanyManagerFaceBitsInfo _cmf_info[] = { /* Index off len WM WF BM BF WM WF BM BF */ - /* PFV_GENDER */ { 0, 1, { 2, 2, 2, 2 }, { 0, 0, 0, 0 } }, ///< 0 = male, 1 = female - /* PFV_ETHNICITY */ { 1, 2, { 2, 2, 2, 2 }, { 0, 0, 0, 0 } }, ///< 0 = (Western-)Caucasian, 1 = African(-American)/Black - /* PFV_GEN_ETHN */ { 0, 3, { 4, 4, 4, 4 }, { 0, 0, 0, 0 } }, ///< Shortcut to get/set gender _and_ ethnicity - /* PFV_HAS_MOUSTACHE */ { 3, 1, { 2, 0, 2, 0 }, { 0, 0, 0, 0 } }, ///< Females do not have a moustache - /* PFV_HAS_TIE_EARRING */ { 3, 1, { 0, 2, 0, 2 }, { 0, 0, 0, 0 } }, ///< Draw the earring for females or not. For males the tie is always drawn. - /* PFV_HAS_GLASSES */ { 4, 1, { 2, 2, 2, 2 }, { 0, 0, 0, 0 } }, ///< Whether to draw glasses or not - /* PFV_EYE_COLOUR */ { 5, 2, { 3, 3, 1, 1 }, { 0, 0, 0, 0 } }, ///< Palette modification - /* PFV_CHEEKS */ { 0, 0, { 1, 1, 1, 1 }, { 0x325, 0x326, 0x390, 0x3B0 } }, ///< Cheeks are only indexed by their gender/ethnicity - /* PFV_CHIN */ { 7, 2, { 4, 1, 2, 2 }, { 0x327, 0x327, 0x391, 0x3B1 } }, - /* PFV_EYEBROWS */ { 9, 4, { 12, 16, 11, 16 }, { 0x32B, 0x337, 0x39A, 0x3B8 } }, - /* PFV_MOUSTACHE */ { 13, 2, { 3, 0, 3, 0 }, { 0x367, 0, 0x397, 0 } }, ///< Depends on PFV_HAS_MOUSTACHE - /* PFV_LIPS */ { 13, 4, { 12, 10, 9, 9 }, { 0x35B, 0x351, 0x3A5, 0x3C8 } }, ///< Depends on !PFV_HAS_MOUSTACHE - /* PFV_NOSE */ { 17, 3, { 8, 4, 4, 5 }, { 0x349, 0x34C, 0x393, 0x3B3 } }, ///< Depends on !PFV_HAS_MOUSTACHE - /* PFV_HAIR */ { 20, 4, { 9, 5, 5, 4 }, { 0x382, 0x38B, 0x3D4, 0x3D9 } }, - /* PFV_JACKET */ { 24, 2, { 3, 3, 3, 3 }, { 0x36B, 0x378, 0x36B, 0x378 } }, - /* PFV_COLLAR */ { 26, 2, { 4, 4, 4, 4 }, { 0x36E, 0x37B, 0x36E, 0x37B } }, - /* PFV_TIE_EARRING */ { 28, 3, { 6, 3, 6, 3 }, { 0x372, 0x37F, 0x372, 0x3D1 } }, ///< Depends on PFV_HAS_TIE_EARRING - /* PFV_GLASSES */ { 31, 1, { 2, 2, 2, 2 }, { 0x347, 0x347, 0x3AE, 0x3AE } } ///< Depends on PFV_HAS_GLASSES + /* CMFV_GENDER */ { 0, 1, { 2, 2, 2, 2 }, { 0, 0, 0, 0 } }, ///< 0 = male, 1 = female + /* CMFV_ETHNICITY */ { 1, 2, { 2, 2, 2, 2 }, { 0, 0, 0, 0 } }, ///< 0 = (Western-)Caucasian, 1 = African(-American)/Black + /* CMFV_GEN_ETHN */ { 0, 3, { 4, 4, 4, 4 }, { 0, 0, 0, 0 } }, ///< Shortcut to get/set gender _and_ ethnicity + /* CMFV_HAS_MOUSTACHE */ { 3, 1, { 2, 0, 2, 0 }, { 0, 0, 0, 0 } }, ///< Females do not have a moustache + /* CMFV_HAS_TIE_EARRING */ { 3, 1, { 0, 2, 0, 2 }, { 0, 0, 0, 0 } }, ///< Draw the earring for females or not. For males the tie is always drawn. + /* CMFV_HAS_GLASSES */ { 4, 1, { 2, 2, 2, 2 }, { 0, 0, 0, 0 } }, ///< Whether to draw glasses or not + /* CMFV_EYE_COLOUR */ { 5, 2, { 3, 3, 1, 1 }, { 0, 0, 0, 0 } }, ///< Palette modification + /* CMFV_CHEEKS */ { 0, 0, { 1, 1, 1, 1 }, { 0x325, 0x326, 0x390, 0x3B0 } }, ///< Cheeks are only indexed by their gender/ethnicity + /* CMFV_CHIN */ { 7, 2, { 4, 1, 2, 2 }, { 0x327, 0x327, 0x391, 0x3B1 } }, + /* CMFV_EYEBROWS */ { 9, 4, { 12, 16, 11, 16 }, { 0x32B, 0x337, 0x39A, 0x3B8 } }, + /* CMFV_MOUSTACHE */ { 13, 2, { 3, 0, 3, 0 }, { 0x367, 0, 0x397, 0 } }, ///< Depends on CMFV_HAS_MOUSTACHE + /* CMFV_LIPS */ { 13, 4, { 12, 10, 9, 9 }, { 0x35B, 0x351, 0x3A5, 0x3C8 } }, ///< Depends on !CMFV_HAS_MOUSTACHE + /* CMFV_NOSE */ { 17, 3, { 8, 4, 4, 5 }, { 0x349, 0x34C, 0x393, 0x3B3 } }, ///< Depends on !CMFV_HAS_MOUSTACHE + /* CMFV_HAIR */ { 20, 4, { 9, 5, 5, 4 }, { 0x382, 0x38B, 0x3D4, 0x3D9 } }, + /* CMFV_JACKET */ { 24, 2, { 3, 3, 3, 3 }, { 0x36B, 0x378, 0x36B, 0x378 } }, + /* CMFV_COLLAR */ { 26, 2, { 4, 4, 4, 4 }, { 0x36E, 0x37B, 0x36E, 0x37B } }, + /* CMFV_TIE_EARRING */ { 28, 3, { 6, 3, 6, 3 }, { 0x372, 0x37F, 0x372, 0x3D1 } }, ///< Depends on CMFV_HAS_TIE_EARRING + /* CMFV_GLASSES */ { 31, 1, { 2, 2, 2, 2 }, { 0x347, 0x347, 0x3AE, 0x3AE } } ///< Depends on CMFV_HAS_GLASSES }; -assert_compile(lengthof(_pf_info) == PFV_END); +assert_compile(lengthof(_cmf_info) == CMFV_END); /** - * Gets the player's face bits for the given player face variable - * @param pf the face to extract the bits from - * @param pfv the face variable to get the data of - * @param ge the gender and ethnicity of the face - * @pre _pf_info[pfv].valid_values[ge] != 0 + * Gets the company manager's face bits for the given company manager's face variable + * @param cmf the face to extract the bits from + * @param cmfv the face variable to get the data of + * @param ge the gender and ethnicity of the face + * @pre _cmf_info[cmfv].valid_values[ge] != 0 * @return the requested bits */ -static inline uint GetPlayerFaceBits(PlayerFace pf, PlayerFaceVariable pfv, GenderEthnicity ge) +static inline uint GetCompanyManagerFaceBits(CompanyManagerFace cmf, CompanyManagerFaceVariable cmfv, GenderEthnicity ge) { - assert(_pf_info[pfv].valid_values[ge] != 0); + assert(_cmf_info[cmfv].valid_values[ge] != 0); - return GB(pf, _pf_info[pfv].offset, _pf_info[pfv].length); + return GB(cmf, _cmf_info[cmfv].offset, _cmf_info[cmfv].length); } /** - * Sets the player's face bits for the given player face variable - * @param pf the face to write the bits to - * @param pfv the face variable to write the data of - * @param ge the gender and ethnicity of the face - * @param val the new value - * @pre val < _pf_info[pfv].valid_values[ge] + * Sets the company manager's face bits for the given company manager's face variable + * @param cmf the face to write the bits to + * @param cmfv the face variable to write the data of + * @param ge the gender and ethnicity of the face + * @param val the new value + * @pre val < _cmf_info[cmfv].valid_values[ge] */ -static inline void SetPlayerFaceBits(PlayerFace &pf, PlayerFaceVariable pfv, GenderEthnicity ge, uint val) +static inline void SetCompanyManagerFaceBits(CompanyManagerFace &cmf, CompanyManagerFaceVariable cmfv, GenderEthnicity ge, uint val) { - assert(val < _pf_info[pfv].valid_values[ge]); + assert(val < _cmf_info[cmfv].valid_values[ge]); - SB(pf, _pf_info[pfv].offset, _pf_info[pfv].length, val); + SB(cmf, _cmf_info[cmfv].offset, _cmf_info[cmfv].length, val); } /** - * Increase/Decrease the player face variable by the given amount. + * Increase/Decrease the company manager's face variable by the given amount. * If the new value greater than the max value for this variable it will be set to 0. * Or is it negativ (< 0) it will be set to max value. * - * @param pf the player face to write the bits to - * @param pfv the player face variable to write the data of - * @param ge the gender and ethnicity of the player face + * @param cmf the company manager face to write the bits to + * @param cmfv the company manager face variable to write the data of + * @param ge the gender and ethnicity of the company manager's face * @param amount the amount which change the value * - * @pre 0 <= val < _pf_info[pfv].valid_values[ge] + * @pre 0 <= val < _cmf_info[cmfv].valid_values[ge] */ -static inline void IncreasePlayerFaceBits(PlayerFace &pf, PlayerFaceVariable pfv, GenderEthnicity ge, int8 amount) +static inline void IncreaseCompanyManagerFaceBits(CompanyManagerFace &cmf, CompanyManagerFaceVariable cmfv, GenderEthnicity ge, int8 amount) { - int8 val = GetPlayerFaceBits(pf, pfv, ge) + amount; // the new value for the pfv + int8 val = GetCompanyManagerFaceBits(cmf, cmfv, ge) + amount; // the new value for the cmfv /* scales the new value to the correct scope */ - if (val >= _pf_info[pfv].valid_values[ge]) { + if (val >= _cmf_info[cmfv].valid_values[ge]) { val = 0; } else if (val < 0) { - val = _pf_info[pfv].valid_values[ge] - 1; + val = _cmf_info[cmfv].valid_values[ge] - 1; } - SetPlayerFaceBits(pf, pfv, ge, val); // save the new value + SetCompanyManagerFaceBits(cmf, cmfv, ge, val); // save the new value } /** - * Checks whether the player bits have a valid range - * @param pf the face to extract the bits from - * @param pfv the face variable to get the data of - * @param ge the gender and ethnicity of the face + * Checks whether the company manager's face bits have a valid range + * @param cmf the face to extract the bits from + * @param cmfv the face variable to get the data of + * @param ge the gender and ethnicity of the face * @return true if and only if the bits are valid */ -static inline bool ArePlayerFaceBitsValid(PlayerFace pf, PlayerFaceVariable pfv, GenderEthnicity ge) +static inline bool AreCompanyManagerFaceBitsValid(CompanyManagerFace cmf, CompanyManagerFaceVariable cmfv, GenderEthnicity ge) { - return GB(pf, _pf_info[pfv].offset, _pf_info[pfv].length) < _pf_info[pfv].valid_values[ge]; + return GB(cmf, _cmf_info[cmfv].offset, _cmf_info[cmfv].length) < _cmf_info[cmfv].valid_values[ge]; } /** - * Scales a player face bits variable to the correct scope - * @param pfv the face variable to write the data of + * Scales a company manager's face bits variable to the correct scope + * @param cmfv the face variable to write the data of * @param ge the gender and ethnicity of the face * @param val the to value to scale - * @pre val < (1U << _pf_info[pfv].length), i.e. val has a value of 0..2^(bits used for this variable)-1 + * @pre val < (1U << _cmf_info[cmfv].length), i.e. val has a value of 0..2^(bits used for this variable)-1 * @return the scaled value */ -static inline uint ScalePlayerFaceValue(PlayerFaceVariable pfv, GenderEthnicity ge, uint val) +static inline uint ScaleCompanyManagerFaceValue(CompanyManagerFaceVariable cmfv, GenderEthnicity ge, uint val) { - assert(val < (1U << _pf_info[pfv].length)); + assert(val < (1U << _cmf_info[cmfv].length)); - return (val * _pf_info[pfv].valid_values[ge]) >> _pf_info[pfv].length; + return (val * _cmf_info[cmfv].valid_values[ge]) >> _cmf_info[cmfv].length; } /** - * Scales all player face bits to the correct scope + * Scales all company manager's face bits to the correct scope * - * @param pf the player face to write the bits to + * @param cmf the company manager's face to write the bits to */ -static inline void ScaleAllPlayerFaceBits(PlayerFace &pf) +static inline void ScaleAllCompanyManagerFaceBits(CompanyManagerFace &cmf) { - IncreasePlayerFaceBits(pf, PFV_ETHNICITY, GE_WM, 0); // scales the ethnicity + IncreaseCompanyManagerFaceBits(cmf, CMFV_ETHNICITY, GE_WM, 0); // scales the ethnicity - GenderEthnicity ge = (GenderEthnicity)GB(pf, _pf_info[PFV_GEN_ETHN].offset, _pf_info[PFV_GEN_ETHN].length); // gender & ethnicity of the face + GenderEthnicity ge = (GenderEthnicity)GB(cmf, _cmf_info[CMFV_GEN_ETHN].offset, _cmf_info[CMFV_GEN_ETHN].length); // gender & ethnicity of the face /* Is a male face with moustache. Need to reduce CPU load in the loop. */ - bool is_moust_male = !HasBit(ge, GENDER_FEMALE) && GetPlayerFaceBits(pf, PFV_HAS_MOUSTACHE, ge) != 0; + bool is_moust_male = !HasBit(ge, GENDER_FEMALE) && GetCompanyManagerFaceBits(cmf, CMFV_HAS_MOUSTACHE, ge) != 0; - for (PlayerFaceVariable pfv = PFV_EYE_COLOUR; pfv < PFV_END; pfv++) { // scales all other variables + for (CompanyManagerFaceVariable cmfv = CMFV_EYE_COLOUR; cmfv < CMFV_END; cmfv++) { // scales all other variables /* The moustache variable will be scaled only if it is a male face with has a moustache */ - if (pfv != PFV_MOUSTACHE || is_moust_male) { - IncreasePlayerFaceBits(pf, pfv, ge, 0); + if (cmfv != CMFV_MOUSTACHE || is_moust_male) { + IncreaseCompanyManagerFaceBits(cmf, cmfv, ge, 0); } } } /** * Make a random new face. - * If it is for the advanced player face window then the new face have the same gender + * If it is for the advanced company manager's face window then the new face have the same gender * and ethnicity as the old one, else the gender is equal and the ethnicity is random. * - * @param pf the player face to write the bits to - * @param ge the gender and ethnicity of the old player face - * @param adv if it for the advanced player face window + * @param cmf the company manager's face to write the bits to + * @param ge the gender and ethnicity of the old company manager's face + * @param adv if it for the advanced company manager's face window * * @pre scale 'ge' to a valid gender/ethnicity combination */ -static inline void RandomPlayerFaceBits(PlayerFace &pf, GenderEthnicity ge, bool adv) +static inline void RandomCompanyManagerFaceBits(CompanyManagerFace &cmf, GenderEthnicity ge, bool adv) { - pf = InteractiveRandom(); // random all player face bits + cmf = InteractiveRandom(); // random all company manager's face bits /* scale ge: 0 == GE_WM, 1 == GE_WF, 2 == GE_BM, 3 == GE_BF (and maybe in future: ...) */ ge = (GenderEthnicity)((uint)ge % GE_END); - /* set the gender (and ethnicity) for the new player face */ + /* set the gender (and ethnicity) for the new company manager's face */ if (adv) { - SetPlayerFaceBits(pf, PFV_GEN_ETHN, ge, ge); + SetCompanyManagerFaceBits(cmf, CMFV_GEN_ETHN, ge, ge); } else { - SetPlayerFaceBits(pf, PFV_GENDER, ge, HasBit(ge, GENDER_FEMALE)); + SetCompanyManagerFaceBits(cmf, CMFV_GENDER, ge, HasBit(ge, GENDER_FEMALE)); } - /* scales all player face bits to the correct scope */ - ScaleAllPlayerFaceBits(pf); + /* scales all company manager's face bits to the correct scope */ + ScaleAllCompanyManagerFaceBits(cmf); } /** - * Gets the sprite to draw for the given player face variable - * @param pf the face to extract the data from - * @param pfv the face variable to get the sprite of - * @param ge the gender and ethnicity of the face - * @pre _pf_info[pfv].valid_values[ge] != 0 + * Gets the sprite to draw for the given company manager's face variable + * @param cmf the face to extract the data from + * @param cmfv the face variable to get the sprite of + * @param ge the gender and ethnicity of the face + * @pre _cmf_info[cmfv].valid_values[ge] != 0 * @return sprite to draw */ -static inline SpriteID GetPlayerFaceSprite(PlayerFace pf, PlayerFaceVariable pfv, GenderEthnicity ge) +static inline SpriteID GetCompanyManagerFaceSprite(CompanyManagerFace cmf, CompanyManagerFaceVariable cmfv, GenderEthnicity ge) { - assert(_pf_info[pfv].valid_values[ge] != 0); + assert(_cmf_info[cmfv].valid_values[ge] != 0); - return _pf_info[pfv].first_sprite[ge] + GB(pf, _pf_info[pfv].offset, _pf_info[pfv].length); + return _cmf_info[cmfv].first_sprite[ge] + GB(cmf, _cmf_info[cmfv].offset, _cmf_info[cmfv].length); } -void DrawPlayerFace(PlayerFace face, int color, int x, int y); -PlayerFace ConvertFromOldPlayerFace(uint32 face); -bool IsValidPlayerIDFace(PlayerFace pf); +void DrawCompanyManagerFace(CompanyManagerFace face, int color, int x, int y); +CompanyManagerFace ConvertFromOldCompanyManagerFace(uint32 face); +bool IsValidCompanyManagerFace(CompanyManagerFace cmf); -#endif /* PLAYER_FACE_H */ +#endif /* COMPANY_MANAGER_FACE_H */ |