dndutil.h

Npc Generator

 * OUTPUT:
 *   int - the number of spells known by that class of the given level, or
 *         -1 if they cannot know any spells of that level, or 0 if they
 *         may know as many spells of that level as they want, provided
 *         they can cast spells of that level.
 * ---------------------------------------------------------------------- */

int dndGetSpellsKnown( int classid, int classLevel, int spellLevel );

/* ---------------------------------------------------------------------- *
 * dndGetBonusSpellsPerDay( int relevantAbility, int spellLevel )
 *
 * INPUT:
 *   relevantAbility (int) - the value of the relevant ability score
 *   spellLevel (int) - from 0 to 9, inclusive
 *
 * OUTPUT:
 *   int - the number of bonus spells that may be cast per day given the
 *         specified ability score and spell level, or -1 if the character
 *         would be unable to cast ANY spells, given the specified ability
 *         score.
 * ---------------------------------------------------------------------- */

int dndGetBonusSpellsPerDay( int relevantAbility, int spellLevel );

/* ---------------------------------------------------------------------- *
 * dndGetDomainName( int id )
 *
 * INPUT:
 *   id (int) - one of the dm-- constants.
 *
 * OUTPUT:
 *   char* - a static buffer containing the name of the domain, or NULL if
 *           the domain is not known.
 * ---------------------------------------------------------------------- */

char* dndGetDomainName( int id );

/* ---------------------------------------------------------------------- *
 * dndGetForbiddenAlignmentsForDomain( int id )
 *
 * INPUT:
 *   id (int) - one of the dm-- constants.
 *
 * OUTPUT:
 *   int - a bit field containing zero or more al--- constants or'ed
 *         together, representing the set of alignments for which this
 *         domain is forbidden.
 * ---------------------------------------------------------------------- */

int dndGetForbiddenAlignmentsForDomain( int id );

/* ---------------------------------------------------------------------- *
 * dndGetArmorName( int id )
 *
 * INPUT:
 *   id (int) - one of the ar-- constants.
 *
 * OUTPUT:
 *   char* - a static buffer containing the name of the given armor, or
 *           NULL if the armor is not known.
 * ---------------------------------------------------------------------- */

char* dndGetArmorName( int id );

/* ---------------------------------------------------------------------- *
 * dndGetArmorType( int id )
 *
 * INPUT:
 *   id (int) - one of the ar-- constants.
 *
 * OUTPUT:
 *   int - one of the at-- constants.
 * ---------------------------------------------------------------------- */

int dndGetArmorType( int id );

/* ---------------------------------------------------------------------- *
 * dndGetArmorCost( int id )
 *
 * INPUT:
 *   id (int) - one of the ar-- constants.
 *
 * OUTPUT:
 *   int - the cost of the given armor in copper pieces (gp x 100).
 * ---------------------------------------------------------------------- */

int dndGetArmorCost( int id );

/* ---------------------------------------------------------------------- *
 * dndGetArmorACBonus( int id )
 *
 * INPUT:
 *   id (int) - one of the ar-- constants.
 *
 * OUTPUT:
 *   int - the armor class bonus of the given armor.
 * ---------------------------------------------------------------------- */

int dndGetArmorACBonus( int id );

/* ---------------------------------------------------------------------- *
 * dndGetArmorMaxDexterity( int id )
 *
 * INPUT:
 *   id (int) - one of the ar-- constants.
 *
 * OUTPUT:
 *   int - the maximum dexterity bonus available while using this armor.
 * ---------------------------------------------------------------------- */

int dndGetArmorMaxDexterity( int id );

/* ---------------------------------------------------------------------- *
 * dndGetArmorCheckPenalty( int id )
 *
 * INPUT:
 *   id (int) - one of the ar-- constants.
 *
 * OUTPUT:
 *   int - the penalty to certain skill checks while wearing this armor.
 * ---------------------------------------------------------------------- */

int dndGetArmorCheckPenalty( int id );

/* ---------------------------------------------------------------------- *
 * dndGetArmorArcaneSpellFailure( int id )
 *
 * INPUT:
 *   id (int) - one of the ar-- constants.
 *
 * OUTPUT:
 *   int - the chance in 100 (d%) of an arcane spell failing while the
 *         caster is wearing the given armor.
 * ---------------------------------------------------------------------- */

int dndGetArmorArcaneSpellFailure( int id );

/* ---------------------------------------------------------------------- *
 * dndGetFortitudeSave( int classType, int level )
 *
 * INPUT:
 *   classType (int) - one of the pc--, npc--, or prc-- constants.
 *   level (int) - from 1 to 20, inclusive
 *
 * OUTPUT:
 *   int - the base fortitude saving throw for the given class at the
 *         given level.
 * ---------------------------------------------------------------------- */

int dndGetFortitudeSave( int classType, int level );

/* ---------------------------------------------------------------------- *
 * dndGetReflexSave( int classType, int level )
 *
 * INPUT:
 *   classType (int) - one of the pc--, npc--, or prc-- constants.
 *   level (int) - from 1 to 20, inclusive
 *
 * OUTPUT:
 *   int - the base reflex saving throw for the given class at the
 *         given level.
 * ---------------------------------------------------------------------- */

int dndGetReflexSave( int classType, int level );

/* ---------------------------------------------------------------------- *
 * dndGetWillSave( int classType, int level )
 *
 * INPUT:
 *   classType (int) - one of the pc--, npc--, or prc-- constants.
 *   level (int) - from 1 to 20, inclusive
 *
 * OUTPUT:
 *   int - the base will saving throw for the given class at the
 *         given level.
 * ---------------------------------------------------------------------- */

int dndGetWillSave( int classType, int level );

/* ---------------------------------------------------------------------- *
 * dndGetNPCGearValue( int level )
 *
 * INPUT:
 *   level (int) - from 1 to 20, inclusive
 *
 * OUTPUT:
 *   int - the value of the gear of an NPC of the given character level,
 *         in gold pieces.
 * ---------------------------------------------------------------------- */

int dndGetNPCGearValue( int level );

/* ---------------------------------------------------------------------- *
 * dndGetRacialHeightWeight( int race, int gender, DNDRACIALHEIGHTWEIGHT* data )
 *
 * INPUT:
 *   race (int) - one of the rc--- constants
 *   gender (int) - one of the g--- constants
 *   data (DNDRACIALHEIGHTWEIGHT*) - where to put the data
 *
 * OUTPUT:
 *   boolean - 1 if the race exists, 0 if it does not.
 *
 * ---------------------------------------------------------------------- */

int dndGetRacialHeightWeight( int race, int gender, DNDRACIALHEIGHTWEIGHT* data );

/* ---------------------------------------------------------------------- *
 * dndGetRaceAlignment( int race )
 *
 * INPUT:
 *   race (int) - one of the rc--- constants
 *
 * OUTPUT:
 *   int - 0, or a combination of the al--- constants.
 *
 * ---------------------------------------------------------------------- */

int dndGetRaceAlignment( int race );

/* ---------------------------------------------------------------------- *
 * dndGetRacePreferredClass( int race )
 *
 * INPUT:
 *   race (int) - one of the rc--- constants
 *
 * OUTPUT:
 *   int - 0, or one of the pc---, npc---, or prc--- constants.
 *
 * ---------------------------------------------------------------------- */

int dndGetRacePreferredClass( int race );

/* ---------------------------------------------------------------------- *
 * dndGetRaceExtraHitDice( int race, int* count, int* type )
 *
 * INPUT:
 *   race (int) - one of the rc--- constants
 *   count (int*) - will contain the number of extra hit dice to use
 *   type (int*) - will contain the type of extra hit dice to use
 *
 * OUTPUT:
 *   boolean - 1 if the race has extra hit dice, 0 otherwise.
 *
 * ---------------------------------------------------------------------- */

int dndGetRaceExtraHitDice( int race, int* count, int* type );

/* ---------------------------------------------------------------------- *
 * dndGetRaceBonusOfType( int race, int gender, int type, int* data, int* bonus, char** next )
 *
 * INPUT:
 *   id (int) - one of the rc-- constants.
 *   gender (int) - on of the g--- constants.
 *   type (int) - one of the rbt-- constants.
 *   data (int) - where the data corresponding to the 'type' field will be
 *                placed.
 *   bonus (int*) - where the requested bonus will be placed.
 *   next (char**) - a place holder for iteration
 *
 * OUTPUT:
 *   int - 0 if there are not more bonuses of the given type, 1 otherwise.
 *
 * ---------------------------------------------------------------------- */

int dndGetRaceBonusOfType( int race, int gender, int type, int* data, int* bonus, char** next );

/* ---------------------------------------------------------------------- *
 * dndGetLanguageName( int id )
 *
 * INPUT:
 *   id (int) - one of the ln--- constants
 *
 * OUTPUT:
 *   char* - a static buffer containing the name of the indicated language
 *           or NULL if the language is unknown.
 * ---------------------------------------------------------------------- */

char* dndGetLanguageName( int id );

/* ---------------------------------------------------------------------- *
 * dndGetGivenLanguages( int id, char** next )
 *
 * INPUT:
 *   id (int) - one of the rc--- constants
 *   next (char**) - a placeholder 
 *
 * OUTPUT:
 *   int - the next language in the series, or 0 if there are no more
 *         languages given to the indicated race.
 * ---------------------------------------------------------------------- */

int dndGetGivenLanguages( int id, char** next );

/* ---------------------------------------------------------------------- *
 * dndGetBonusLanguages( int id, char** next )
 *
 * INPUT:
 *   id (int) - one of the rc--- constants
 *   next (char**) - a placeholder 
 *
 * OUTPUT:
 *   int - the next language in the series, or 0 if there are no more
 *         languages that the indicated race gains as a bonus.
 * ---------------------------------------------------------------------- */

int dndGetBonusLanguages( int id, char** next );

/* ---------------------------------------------------------------------- *
 * dndGetRelativeWeaponSize( int raceid, int weapon )
 *
 * INPUT:
 *   raceid (int) - one of the rc--- constants
 *   weapon (int) - one of the wp--- constants
 *
 * OUTPUT:
 *   int - one of the wt--- constants (wtLIGHT, wtONEHANDED, wtTWOHANDED)
 * ---------------------------------------------------------------------- */

int dndGetRelativeWeaponSize( int raceid, int weapon );

/* ---------------------------------------------------------------------- *
 * dndGetMonkSpeedForRace( int raceid, int level )
 *
 * INPUT:
 *   raceid (int) - one of the rc--- constants
 *   level (int) - from 1 to 20, inclusive
 *
 * OUTPUT:
 *   int - the base speed of the monk
 * ---------------------------------------------------------------------- */

int dndGetMonkSpeedForRace( int raceid, int level );

#ifdef __cplusplus
}
#endif

#endif /* __DNDUTIL_H__ */