inventory.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	inventory
	Inventory structure represents the player inventory. More...

Macros
#define	INVENTORY_SIZE   10

Typedefs
typedef struct item	Item
typedef struct state	State
typedef struct inventory	Inventory
	Inventory structure represents the player inventory. More...

Functions
Inventory *	initInventory ()
	Initializes a new inventory. Allocates memory for a new inventory and initializes its fields. More...
void	addItem (Inventory *i, Item *item)
	Adds an item to the inventory. More...
void	removeItem (Inventory *i, Item *item)
	Removes an item from the inventory. More...
void	sellEquippedItem (State *st, Inventory *i)
	Sells the equipped item. More...
void	switchEquippedItem (Inventory *i)
	Switches the equipped item on a inventory. More...
void	freeInventory (void *p)
	Frees the memory allocated for an inventory. More...
void	useEquippedItem (State *st)
	Uses the equipped item. More...

Macro Definition Documentation

INVENTORY_SIZE

#define INVENTORY_SIZE   10

Typedef Documentation

Inventory

typedef struct inventory Inventory

Inventory structure represents the player inventory.

This struct represents the player inventory. It contains the items the player has picked up, the equipped item and is index in the inventory, and the amount of gold.

Parameters

items	the items in the inventory
nr_items	the number of items in the inventory
equipped_item	the equipped item
equiped_index	the index of the equipped item
equipped_sword	the equipped sword
equipped_armor	the equipped armor
gold	the amount of gold in the inventory

Item

typedef struct item Item

State

typedef struct state State

Function Documentation

addItem()

void addItem	(	Inventory *	i,
		Item *	item
	)

Adds an item to the inventory.

Adds an item to the inventory. If the inventory is full, the item is not added. If the item is a rock, the number of rocks is increased. // free item

Parameters

i	Inventory to add item to
item	Item to add

Returns

void

freeInventory()

void freeInventory

(

void *

p

)

Frees the memory allocated for an inventory.

Frees the memory allocated for an inventory.

Parameters

p	Inventory to free

Returns

void

initInventory()

Inventory* initInventory

(

)

Initializes a new inventory. Allocates memory for a new inventory and initializes its fields.

Returns

Inventory* Initialized inventory

removeItem()

void removeItem	(	Inventory *	i,
		Item *	item
	)

Removes an item from the inventory.

Removes an item from the inventory. If the item is not in the inventory, nothing happens.

Parameters

i	Inventory to remove item from
item	Item to remove

Returns

void

sellEquippedItem()

void sellEquippedItem	(	State *	st,
		Inventory *	i
	)

Sells the equipped item.

Sells the equipped item. If the equipped item is NULL, nothing happens.

Parameters

i	Inventory to sell equipped item
st	State to send menu message (Other option send msg before calling this function)

Returns

void

switchEquippedItem()

void switchEquippedItem

(

Inventory *

i

)

Switches the equipped item on a inventory.

Switches the equipped item on a inventory. If there is no possible equipable item, nothing happens.

Parameters

i	Inventory to switch equipped item

Returns

void

useEquippedItem()

void useEquippedItem

(

State *

st

)

Uses the equipped item.

Uses the equipped item. If the equipped item is a potion of healing, the player's health is increased. Receives a State struct as argument because needs to update the player, the map and game stats.

Parameters

st	State to use the equipped item

Returns

void