item.h

/*
    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 ITEM_H
#define ITEM_H

/** 
        An Object that acts as an item.
        This class is quite generic.  Subclasses such as TFood and TWeapon are more specific and usefull.
        TItem will normally never be created, only be used as a container class.
        
 */

@interface TItem : TObject
{
        int lvl;
        int hp;
        int hp_max;
        int price;
        int weight;
        char *weight_unit;
        
        char *name;
        char *desc;
        int *equipable_locations; /**< An array of #defined locations where this item can be equiped. */
        int len; /**< Size of the equipable_locations array */
}

- init:(int)level:(int)hp_max:(int)price:(int)weight:(char *)weight_unit:(char *)name:(char *)desc;
- free;

- (int)get_lvl;
- (char *)get_name;
- (int)get_hp;
- (int)get_hp_max;
- (char *)get_description;
- (int)get_price;
- (int)get_weight;
- (char *)get_weight_unit;
- (void)set_properties:(int)hp:(int)price;
- (void)set_description:(char *)description;

/**     
 Sets the variable equipable_locations. If there was a previous array there, it will be free'd and replaced.

 \param locations An integer array of locations that this item can be equiped at.
 \param len Size of the array.

 */
- (void)set_equipable_locations:(int *)locations:(int)len;

@end

/* Consumable Items */

/**
  An item that can be "consumed".
 */
@interface TConsumable : TItem
{
        @protected
        int lvl_mod; /**< Additive modifier for use when this item is "eaten" or "drinken" or etc. */
        int hp_mod; /**< Additive modifier for use when this item is "eaten" or "drinken" or etc. */    
        int str_mod; /**< Additive modifier for use when this item is "eaten" or "drinken" or etc. */
        int cons_mod; /**< Additive modifier for use when this item is "eaten" or "drinken" or etc. */
        int intel_mod; /**< Additive modifier for use when this item is "eaten" or "drinken" or etc. */
        int wis_mod; /**< Additive modifier for use when this item is "eaten" or "drinken" or etc. */
        int charisma_mod; /**< Additive modifier for use when this item is "eaten" or "drinken" or etc. */
        int dex_mod; /**< Additive modifier for use when this item is "eaten" or "drinken" or etc. */
        int speed_mod; /**< Additive modifier for use when this item is "eaten" or "drinken" or etc. */
        int exp_mod; /**< Additive modifier for use when this item is "eaten" or "drinken" or etc. */

}

- init:(int)level:(int)hp:(int)price:(int)weight:(char *)weight_units:(char *)name:(char *)desc:(int)lvl_mod:
(int)hp_mod:(int)str_mod:(int)cons_mod:(int)intel_mod:(int)wis_mod:(int)charisma_mod:(int)dex_mod:(int)speed_mod:(int)exp_mod;
- free;

- (int)get_lvl_mod;
- (int)get_hp_mod;
- (int)get_str_mod;
- (int)get_cons_mod;
- (int)get_intel_mod;
- (int)get_wis_mod;
- (int)get_charisma_mod;
- (int)get_dex_mod;
- (int)get_speed_mod;
- (int)get_exp_mod;

@end

/**
  An item that can be "consumed" or eaten. 
 */

@interface TFood : TConsumable
{
        @private int hunger_mod;
}

- init:(int)level:(int)hp:(int)price:(int)weight:(char *)weight_units:(char *)name:(char *)desc:(int)lvl_mod:
(int)hp_mod:(int)str_mod:(int)cons_mod:(int)intel_mod:(int)wis_mod:(int)charisma_mod:(int)dex_mod:(int)speed_mod:
(int)exp_mod:(int)hunger_mod;
- free;

- (int)get_hunger_mod;

@end

/**
  An edible item thats effect lasts for only a limited time. 
 */
@interface TDrug : TFood
{       
        int effect_timeout; /* don't know how this would be implemented atm... */
}

- init:(int)level:(int)hp:(int)price:(int)weight:(char *)weight_units:(char *)name:(char *)desc:(int)lvl_mod:
(int)hp_mod:(int)str_mod:(int)cons_mod:(int)intel_mod:(int)wis_mod:(int)charisma_mod:(int)dex_mod:(int)speed_mod:
(int)exp_mod:(int)effect_timeout;
- free;

- (int)get_effect_timeout;

@end

/**
  An item that can be "drunk".
 */

@interface TDrink : TConsumable
{
        int thirst_mod;
}

- init:(int)level:(int)hp:(int)price:(int)weight:(char *)weight_units:(char *)name:(char *)desc:(int)lvl_mod:
(int)hp_mod:(int)str_mod:(int)cons_mod:(int)intel_mod:(int)wis_mod:(int)charisma_mod:(int)dex_mod:(int)speed_mod:
(int)exp_mod:(int)thirst_mod;
- free;

- (int)get_thirst_mod;

@end

/**
  An item that can be "drunk" with an effect that lasts for a limited time. 
 */

@interface TAlcohol : TDrink
{
        int effect_timeout; /* don't know how this would be implemented atm... */
}

- init:(int)level:(int)hp:(int)price:(int)weight:(char *)weight_units:(char *)name:(char *)desc:(int)lvl_mod:
(int)hp_mod:(int)str_mod:(int)cons_mod:(int)intel_mod:(int)wis_mod:(int)charisma_mod:(int)dex_mod:(int)speed_mod:
 (int)exp_mod:(int)effect_timeout;
- free;

- (int)get_effect_timeout;

@end

/* End of Consumable Items */

/* Weapons */

/**
  An item that can be used in an attack. 
 */

@interface TWeapon : TItem
{
        int str;
        int dex;
        int speed;
}

- init:(int)level:(int)hp:(int)price:(int)weight:(char *)weight_units:(char *)name:(char *)desc:(int)str:(int)dex:(int)speed;
- free;

@end

#endif

---