character.h

Go to the documentation of this file.

/*
    toten
    Copyright (C) 2004,2005 Toten Developers

    Toten is the legal property of its developers, whose names are
    too numerous to list here.  Please refer to the COPYRIGHT file
    for the full text of this license and to the AUTHORS file for
    the complete list of developers.

    This program is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2.1 of the License, or (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
*/

#ifndef CHARACTER_H
#define CHARACTER_H
        
/* locations to equip things */
/** \file character.h
 Defines TCharacterClass & TCharacter interfaces.
 */
#define HELMET                  (1<<0)
#define FACE                    (1<<1)
#define TUNIC                   (1<<2)
#define ARMOR                   (1<<3)
#define BELT                    (1<<4)
#define BACKPACK                (1<<5)
#define R_HAND_HOLDING          (1<<6)
#define R_HAND_INDEX_FINGER     (1<<7)
#define R_HAND_MIDDLE_FINGER    (1<<8)
#define R_HAND_RING_FINGER      (1<<9)
#define R_HAND_PINKY_FINGER     (1<<10)
#define L_HAND_HOLDING          (1<<11)
#define L_HAND_INDEX_FINGER     (1<<12)
#define L_HAND_MIDDLE_FINGER    (1<<13)
#define L_HAND_RING_FINGER      (1<<14)
#define L_HAND_PINKY_FINGER     (1<<15)
#define GLOVES                  (1<<16)
#define BOOTS                   (1<<17)

#define MALE                    (1<<0)
#define FEMALE                  (1<<1)

/**
        A character classification.

        Defines things that are specific to a "class" of characters, not one character.
        For example, you might create a character class of a Human Rogue or of an Elvish Archer.
        Note that is is specific to Race and race class.

 */
@interface TCharacterClass : TObject
{
        @protected
        char *name_race;  /* Human, Android, etc. */
        char *name_class; /* Rogue, Mage, etc. */

        @public 
        int start_lvl; /**< Starting level */
        int start_hp_max; /**< Starting max hp */
        int start_str; /**< Starting strength */
        int start_cons; /**< Starting constitution */
        int start_intel; /**< Starting intelligence */
        int start_wis; /**< Starting wisdom */
        int start_charisma; /**< Starting charisma */
        int start_dex; /**< Starting dexterity */
        int start_speed; /**< Starting speed */

        int lvl_exp_increment; /**< Ammount of exp points needed to level up */
        int exp_increment; /**< Part of the way the new lvl_exp_increment is determined after leveling up */ 
        float exp_bonus; /**< Other half of how lvl_exp_increment is determined after leveling up */
        float hp_bonus; /**< Multiplied with level and added to max_hp after leveling up */
        float str_bonus; /**< Multiplied with level and added to str after leveling up */
        float cons_bonus; /**< Multiplied with level and added to cons after leveling up */
        float intel_bonus; /**< Multiplied with level and added to intel after leveling up */
        float wis_bonus; /**< Multiplied with level and added to wis after leveling up */
        float charisma_bonus; /**< Multiplied with level and added to charisma after leveling up */
        float dex_bonus; /**< Multiplied with level and added to dex after leveling up */
        float speed_bonus; /**< Multiplied with level and added to speed after leveling up */

        int hunger_speed; /**< should be positive, how fast hunger increases */
        int thirst_speed;/**< should be positive, how fast thirst increases */
        
        TSkillSet *skillset; /**< Set of skills that can be learned by this class */
        
}

/**
        Params are copied into the respective fields in the new class.
 */

/* OMFG this is ugly :( */
- init:(char *)name_race:(char *)name_class:(int)start_lvl:(int)start_hp_max:(int)start_str:(int)start_cons:
        (int)start_intel:(int)start_wis:(int)start_charisma:(int)start_dex:(int)start_speed:(int)lvl_exp_increment:
        (int)exp_increment:(float)exp_bonus:(float)hp_bonus:(float)str_bonus:(float)cons_bonus:(float)intel_bonus:
        (float)wis_bonus:(float)charisma_bonus:(float)dex_bonus:(float)speed_bonus:(int)hunger_speed:(int)thirst_speed;

- free;

/**
        Set a new skillset for the class.
 */
- (void)setskillset:(TSkillSet *)skillset;



@end

/**
        A generic character class.

        Contains many variables for the state of the character and its characteristics.
        Contains many functions for manipulating the character and for getting and setting its state.
 */

@interface TCharacter : TObject
{       
        char *first_name;
        char *last_name;
        unsigned int height;
        unsigned int weight;
        char *eye_color;
        char *hair_color;
        unsigned short int sex; /**< Use a predefined macro for this */
        char *bio; /**< A description of this character. */

        @public
        char *height_unit; /**< Something like "Centimeters" to be displayed after the height. */
        char *weight_unit; /**< Something like "Newtons" to be displayed after the weight. */
        
        /* game elements */
        @protected
        int lvl; /**< Current level */
        int hp; /**< Current HP */
        int hp_max; /**< Maximum HP */
        int str; /**< strength */
        int cons; /**< constitution */
        int intel; /**< intelligence */
        int wis; /**< wisdom */
        int charisma;
        int dex; /**< dexterity */
        int speed; /**< speed */
        int exp; /**< experience points */
        
        @public
        int hunger; /**< 10 is dying from hunger, 0 is full */
        int thirst; /**< 10 is dying from thirst, 0 is not thirsty */
        int hunger_speed; /**< should be positive, how fast hunger increases */
        int thirst_speed; /**< should be positive, how fast thirst increases */
                
        /* basically "slots" for placing items */
        
        @protected
        
        /* head */
        TItem *helmet; /**< Slot to place an item */
        TItem *face; /**< Slot to place an item */

        /* torso */
        TItem *tunic; /**< Slot to place an item */
        TItem *armor; /**< Slot to place an item */
        TItem *belt; /**< Slot to place an item */
        TItem *backpack; /**< Slot to place an item */

        /* right hand */
        TItem *r_hand_holding; /**< Slot to place an item */
        TItem *r_hand_index_finger; /**< Slot to place an item */
        TItem *r_hand_middle_finger; /**< Slot to place an item */
        TItem *r_hand_ring_finger; /**< Slot to place an item */
        TItem *r_hand_pinky_finger; /**< Slot to place an item */

        /* left_hand */
        TItem *l_hand_holding; /**< Slot to place an item */  
        TItem *l_hand_index_finger; /**< Slot to place an item */
        TItem *l_hand_middle_finger; /**< Slot to place an item */
        TItem *l_hand_ring_finger; /**< Slot to place an item */
        TItem *l_hand_pinky_finger; /**< Slot to place an item */

        /* miscellaneous items */
        TItem *gloves; /**< Slot to place an item */
        TItem *boots; /**< Slot to place an item */

        TCharacterClass *charclass; /**< This character's Character Class */
        TSkillSet *skillset; /**< This character's Skill Set (independent from Character Class) */
        
}

/**
        Initializes the character.

        \param charclass The character class of this character.
 */
- init:(TCharacterClass *)charclass;
- free;
/**
        Set the physical properties of the character.

        Paramaters are copied into their respective fields in the class.  
        Use NULL for pointers and -1 for others to keep the current.
 */
- (void)set_phys_properties:(char *)first_name:(char *)last_name:(unsigned int)height:(unsigned int)weight:
(char *)height_unit:(char *)weight_unit:(char *)eye_color:(char *)hair_color:
                        (unsigned short int)sex: (char *)bio;

/**
        Have the character gain experience points in add_exp.
        Calls lvl_up if the new experience passes lvl_exp_increment in the character's charclass.
        
        \param add_exp Experience points to be added.
 */  
- (int)gain_exp:(int)add_exp;

/**
        Level up the character by one.
 */
- (int)lvl_up;

- (char *)get_first_name;
- (char *)get_last_name;
- (char *)get_eye_color;
- (char *)get_hair_color;
- (char *)get_bio;
- (int)get_lvl;
- (int)get_hp;
- (int)get_hp_max;
- (int)get_str;
- (int)get_cons;
- (int)get_intel;
- (int)get_wis;
- (int)get_charisma;
- (int)get_dex;
- (int)get_speed;
- (int)get_exp;

- (void)set_hp:(int)hp;

/**
        Put the item in the specified location, returning what was previously there.

        \param item Item to be equipped
        \param location Location where the item should be equipped.  This should be a macro defined in character.h
        
 */
- (TItem *)equip:(TItem *)item:(int)location;
/**
        Get item at location.

        \param location This should be a macro defined in character.h

 */
- (TItem *)get_item_equipped_at_location:(int)location;
- (void)consume:(TConsumable *)consumable;
- (void)eat:(TFood *)food;
- (void)drink:(TDrink *)drink;

@end

#endif

---