potion.h File Reference

Exposes functions for working with potions. More...

#include "../common.h"
#include "../database/database.h"
#include "../memory/memory_management.h"

Go to the source code of this file.

Data Structures
struct	potion_t
struct	potion_table_t

Enumerations
enum	potion_type_t { HEALING , MANA , STAMINA , MAX_POTION_TYPES }

Functions
potion_t *	init_potion (potion_t *potion, const char *name, potion_type_t type, int value)
	creates a potion object with the given name, type and value
potion_table_t *	init_potion_table (memory_pool_t *memory_pool, const db_connection_t *db_connection)
	initializes a potion table with potions from the database
const char *	potion_type_to_string (potion_type_t type)
	Converts a potion type to a string representation.
void	free_potion (memory_pool_t *memory_pool, potion_t *potion)
	Frees the memory allocated for a potion.
void	free_potion_table (memory_pool_t *memory_pool, potion_table_t *table)
	Frees the memory allocated for a potion table.

Detailed Description

Exposes functions for working with potions.

Definition in file potion.h.

Enumeration Type Documentation

potion_type_t

enum potion_type_t

Definition at line 12 of file potion.h.

             {
    HEALING,
    MANA,
    STAMINA,
    MAX_POTION_TYPES
} potion_type_t;

Function Documentation

free_potion()

void free_potion	(	memory_pool_t *	memory_pool,
		potion_t *	potion )

Frees the memory allocated for a potion.

Parameters

memory_pool	Memory pool to free the potion
potion	Potion object to be freed

free_potion_table()

void free_potion_table	(	memory_pool_t *	memory_pool,
		potion_table_t *	table )

Frees the memory allocated for a potion table.

Parameters

memory_pool	Memory pool to free the potion table
table	Potion table to be freed

Definition at line 53 of file potion.c.

                                                                          {
    NULL_PTR_HANDLER_RETURN(memory_pool, , "Potion", "In free_potion_table memory pool is NULL");
    NULL_PTR_HANDLER_RETURN(table, , "Potion", "In free_potion_table table is NULL");
 
    memory_pool_free(memory_pool, table);
}

init_potion()

potion_t * init_potion	(	potion_t *	potion,
		const char *	name,
		potion_type_t	type,
		int	value )

creates a potion object with the given name, type and value

Parameters

potion	Potion object to be initialized
name	Name of the potion
type	Type defines the effect of the potion
value	Value defining the strength of the effect

Definition at line 11 of file potion.c.

                                                                                                     {
    NULL_PTR_HANDLER_RETURN(name, NULL, "Potion", "In init_potion name is NULL");
 
    snprintf(potion->name, sizeof(potion->name), "%s", name);
    potion->effectType = type;
    potion->value = value;
    return potion;
}

init_potion_table()

potion_table_t * init_potion_table	(	memory_pool_t *	memory_pool,
		const db_connection_t *	db_connection )

initializes a potion table with potions from the database

Parameters

memory_pool	Memory pool to allocate the potion table
db_connection	Database connection to fetch the potions from

Returns

Pointer to the initialized potion table

Definition at line 20 of file potion.c.

                                                                                                    {
    NULL_PTR_HANDLER_RETURN(memory_pool, NULL, "Potion", "Memory pool is NULL");
 
    potion_init_t* rows = init_potion_table_from_db(db_connection);
    NULL_PTR_HANDLER_RETURN(rows, NULL, "Potion", "Could not fetch potion data from DB");
 
    potion_table_t* table = memory_pool_alloc(memory_pool, sizeof(potion_table_t));
    NULL_PTR_HANDLER_RETURN(table, NULL, "Potion", "Failed to allocate potion for potion table");
 
    for (int i = 0; i < MAX_POTION_TYPES; ++i) {
        if (rows[i].name == NULL)
            break;
 
        const int slot = rows[i].potion_type;
        init_potion(&table->potions[slot], rows[i].name, rows[i].potion_type, rows[i].value);
    }
    free_potion_table_from_db(rows, db_connection);
    return table;
}

potion_type_to_string()

const char * potion_type_to_string

(

potion_type_t

type

)

Converts a potion type to a string representation.

Parameters

type	The potion type to convert

Returns

A string representation of the potion type

Definition at line 40 of file potion.c.

                                                      {
    switch (type) {
        case HEALING:
            return "Health";
        case MANA:
            return "Mana";
        case STAMINA:
            return "Stamina";
        default:
            return "Unknown";
    }
}