CRuleTables Class¶
Overview¶
Note
The CRuleTables class handles looking up externalized data stored in .ids files for use with the game engine rules: stats, classes, skills, experience, spells, proficiencies, THACO and other data that is used in the game or by the game engine.
The structure used for this class is CRuleTables
Quick Reference¶
Quick Ref |
void CRuleTables::CRuleTables() |
void CRuleTables::~CRuleTables() |
void CRuleTables::Add25StartEquipment(CGameSprite* pSprite, int forceDefault) |
void CRuleTables::AdjustStoreMarkup(unsigned char nCHR, short nReputation, unsigned long& dwMarkup) |
int CRuleTables::CanFall(unsigned long nClass, unsigned long kit) |
int CRuleTables::ClassGetsSpecializationAPR(unsigned char classID, unsigned long kitID) |
int CRuleTables::ClassUnarmedAPRDivisor(unsigned char classID, unsigned long kitID) |
int CRuleTables::ClassZeroSkillTHAC0Bonus(unsigned char classID, unsigned long kitID) |
int CRuleTables::Compare(unsigned int a, unsigned int b, int relation) |
int CRuleTables::FindSavingThrow(unsigned char nClass, unsigned char nSubClass, CDerivedStats& DStats, CString& sSavingThrow) |
int CRuleTables::FindTHAC0(unsigned char nClass, unsigned char nSubClass, CDerivedStats& DStats) |
unsigned long CRuleTables::GetAlignmentDescStringRef(unsigned char nAlignment) |
CString CRuleTables::GetAlignmentString(unsigned char nAlignment) |
void CRuleTables::GetAlignmentStringMixed(unsigned char nAlignment, CString& sAlignment) |
unsigned long CRuleTables::GetAlignmentStringRef(unsigned char nAlignment) |
int CRuleTables::GetAnimationSpeed(unsigned short animationId, int defaultSpeed) |
unsigned short CRuleTables::GetAnimationType(CAIObjectType& TypeAI) |
int CRuleTables::GetAreaCreatureNodeCount(CString areaName) |
CResRef CRuleTables::GetAutoSpellPick(unsigned char level, unsigned char index) |
int CRuleTables::GetBackstabMultiplier(CAIObjectType& TypeAI, CDerivedStats& DStats, unsigned long nKit) |
long CRuleTables::GetBanterFrequency() |
long CRuleTables::GetBanterProbability() |
long CRuleTables::GetBanterReplayDelay() |
long CRuleTables::GetBanterSpecialProbability() |
void CRuleTables::GetBardSkillPoints(unsigned char nLevel, unsigned char& nPickPockets) |
unsigned char CRuleTables::GetBaseLore(CAIObjectType& TypeAI, CDerivedStats& DStats) |
void CRuleTables::GetBaseSkillPoints(CAIObjectType& TypeAI, CDerivedStats& DStats, unsigned char& nPickPockets, unsigned char& nOpenLocks, unsigned char& nFindTraps, unsigned char& nMoveSilently, unsigned char& nHideInShadows, unsigned char& nDetectIllusion, unsigned char& nSetTraps) |
int CRuleTables::GetBountyChance(unsigned short nReputation) |
void CRuleTables::GetChapterBMP(CResRef& cResText, unsigned char nRace, unsigned char nClass, unsigned short nReputation, CResRef& cResPower, CTypedPtrList& list) |
int CRuleTables::GetChapterSong(CResRef& cResText) |
CList* CRuleTables::GetChapterText(CResRef& cResText, unsigned char nRace, unsigned char nClass, unsigned short nReputation, CResRef& cResPower) |
unsigned long CRuleTables::GetCharacterSound(CString& sCustomSlot, unsigned long nSoundSlot, unsigned char nSex) |
void CRuleTables::GetCharacterStateDescription(int nState, CString& sDescription) |
int CRuleTables::GetClassAPRBonus(CAIObjectType& TypeAI, CDerivedStats& DStats, short proficiencyLevel) |
C2DArray* CRuleTables::GetClassAbilityTable(unsigned char nClass, unsigned long nSpecialist) |
unsigned long CRuleTables::GetClassBriefDescription(int classID, int kitID, unsigned long dwFlags) |
unsigned long CRuleTables::GetClassFallenNotice(int classID, int kitID, unsigned long dwFlags) |
unsigned long CRuleTables::GetClassFromKitId(unsigned long kit) |
short CRuleTables::GetClassProficiency(unsigned char nClass, unsigned char nActiveClass, unsigned char nInactiveClass, int bInactiveUsable, unsigned long nProfType, unsigned long nSpecialist) |
CString CRuleTables::GetClassString(unsigned char nClass, unsigned long nSpecialist) |
unsigned long CRuleTables::GetClassStringLower(unsigned char nClass, unsigned long nSpecialist, unsigned long dwFlags, CString& sClass, CGameSprite* pSprite) |
void CRuleTables::GetClassStringMixed(unsigned char nClass, unsigned long nSpecialist, unsigned long dwFlags, CString& sClass, CGameSprite* pSprite) |
int CRuleTables::GetClassTHAC0Bonus(CGameSprite* pSprite) |
unsigned long CRuleTables::GetClassTextBiography(int classID, int kitID, unsigned long dwFlags) |
unsigned long CRuleTables::GetClassTextDescription(int classID, int kitID, unsigned long dwFlags) |
unsigned long CRuleTables::GetClassTextLower(int classID, int kitID, unsigned long dwFlags) |
unsigned long CRuleTables::GetClassTextMixed(int classID, int kitID, unsigned long dwFlags) |
int CRuleTables::GetConFatigueBonus(unsigned char nCON) |
unsigned char CRuleTables::GetContingencyCondition(unsigned long& strRef, unsigned long& description, unsigned short id) |
unsigned char CRuleTables::GetContingencyTarget(unsigned long& strRef, unsigned long& description, unsigned short id) |
int CRuleTables::GetCripplingStrike(CAIObjectType& TypeAI, CDerivedStats& DStats, unsigned long nKit) |
int CRuleTables::GetCustomSound(CString& end, unsigned char soundId) |
void CRuleTables::GetDefaultColours(CGameSprite* pSprite) |
CString CRuleTables::GetDefaultScript(CGameSprite* pSprite) |
unsigned char CRuleTables::GetDonateRumorChance(unsigned long dwGold) |
int CRuleTables::GetDualClass(unsigned char nClass1, unsigned char nClass2, unsigned char& nDualClass) |
void CRuleTables::GetDualClassMinAbilitiesDst(unsigned char nSubClass, unsigned long nSpecialistMage, unsigned char& nMinSTR, unsigned char& nMinDEX, unsigned char& nMinCON, unsigned char& nMinINT, unsigned char& nMinWIS, unsigned char& nMinCHR) |
void CRuleTables::GetDualClassMinAbilitiesSrc(unsigned char nSubClass, unsigned long nSpecialistMage, unsigned char& nMinSTR, unsigned char& nMinDEX, unsigned char& nMinCON, unsigned char& nMinINT, unsigned char& nMinWIS, unsigned char& nMinCHR) |
int CRuleTables::GetExtraAnimation(unsigned short animationId, char* armorMaxCode, unsigned char* bCanLieDown, unsigned char* bDetectedByInfravision, int* bDoubleBlit, int* bEquipHelmet, int* bSplitBams, unsigned char* colorBlood, unsigned char* colorChunks, int* falseColor, CString* heightCode, CString* heightCodeHelmet, CString* heightCodeShieldPaperDoll, unsigned long* nSndFreq, unsigned char* personalSpace, CString* resref, CString* resrefPaperDoll, unsigned char* resrefArmorBase, unsigned char* resrefArmorSpecific, CString* resrefShadow) |
CResRef CRuleTables::GetFamiliar(unsigned char alignment) |
void CRuleTables::GetGenderStringMixed(unsigned char nGender, CString& sGender) |
void CRuleTables::GetHPCONBonus(unsigned char nClass, unsigned char nCON, int& nBonus, int& nMinRoll) |
int CRuleTables::GetHPCONBonusTotal(CAIObjectType& TypeAI, CDerivedStats& DStats, unsigned char nCON) |
int CRuleTables::GetHitPoints(CAIObjectType& TypeAI, CDerivedStats& OldDStats, CDerivedStats& NewDStats, unsigned char nCON) |
int CRuleTables::GetInnateClassSkill(CGameSprite* pSprite, CString sSkill) |
void CRuleTables::GetIntoxicationInfo(unsigned char nCON, int& nIntoxicationRate, int& nRecoveryRate, int& nIntoxicationCap) |
unsigned long CRuleTables::GetItemAbilityDescription(CResRef& cResItem, int nAbilityNum) |
CResRef CRuleTables::GetItemDropSound(int itemtype) |
CResRef CRuleTables::GetItemTakeSound(int itemtype) |
int CRuleTables::GetItemTypeSlot(int itemtype) |
int CRuleTables::GetItemUseFlag(CString item) |
int CRuleTables::GetItemUseString(CString item) |
int CRuleTables::GetLayOnHandsAmount(CAIObjectType& TypeAI, CDerivedStats& DStats) |
CGameAbilityList* CRuleTables::GetLevelUpAbilities(CGameSprite* pSprite, int nLevel) |
void CRuleTables::GetLevelUpAbilityTableString(CGameSprite* pSprite, int nLevel, CString& sTableName) |
int CRuleTables::GetLoreBonus(unsigned char nWIS, unsigned char nINT) |
CResRef CRuleTables::GetMageSpell(int nSpellLevel, int nSpellIndex) |
int CRuleTables::GetMaxMemorizedSpellsMage(CAIObjectType& TypeAI, CDerivedStats& DStats, unsigned long nSpecialistMage, int nSpellLevel) |
int CRuleTables::GetMaxMemorizedSpellsPriest(CAIObjectType& TypeAI, CDerivedStats& DStats, int nSpellLevel, int& nBonus) |
int CRuleTables::GetMaxMemorizedSpellsRanger(CAIObjectType& TypeAI, CDerivedStats& DStats, int nSpellLevel) |
int CRuleTables::GetMaxSpellLevel(CDerivedStats& DStats) |
int CRuleTables::GetMaxSpellsPerLevel(CDerivedStats& DStats) |
int CRuleTables::GetMaximumProficiency(int nLevel, int nClass) |
CString CRuleTables::GetMonkFist(int nLevel) |
void CRuleTables::GetMovieDescription(CString& sMovie, CString& sDescription) |
C2DArray* CRuleTables::GetNPCChart() |
void CRuleTables::GetNextLevel(CAIObjectType& TypeAI, CDerivedStats& DStats) |
void CRuleTables::GetNextLevelSubClass(unsigned char nClass, unsigned char nSubClass, unsigned char nActiveClass, unsigned char nInactiveClass, CDerivedStats& DStats) |
unsigned long CRuleTables::GetNextLevelXP(unsigned char nClass, unsigned char nLevel) |
int CRuleTables::GetNumLevelUpAbilities(CAIObjectType& TypeAI, CDerivedStats& OldDStats, CDerivedStats& NewDStats, unsigned char& nLevel) |
int CRuleTables::GetNumPriestSpells(int nSpellLevel) |
int CRuleTables::GetNumQuickWeaponSlots(unsigned char nClass, unsigned char nActiveClass, unsigned char nInactiveClass, int bInactiveUsable, unsigned long nSpecialist) |
CResRef CRuleTables::GetPriestSpell(int nSpellLevel, int nSpellIndex) |
void CRuleTables::GetProfBonuses(int nProf, int nLev, int* damR, int* damL, int* thacR, int* thacL, int* ACB, int* ACM, int* speed, int* crit) |
unsigned long CRuleTables::GetProficiencyClassIndex(unsigned char nClass, unsigned long nSpecialist) |
unsigned long CRuleTables::GetProficiencyDescription(unsigned long id) |
unsigned long CRuleTables::GetProficiencyId(unsigned long index) |
unsigned long CRuleTables::GetProficiencyName(unsigned long id) |
int CRuleTables::GetProficiencySlots(CAIObjectType& TypeAI, CDerivedStats& OldDStats, CDerivedStats& NewDStats, unsigned char GetInactive) |
int CRuleTables::GetRaceFeatures(int race, int type) |
CString CRuleTables::GetRaceString(unsigned char nRace) |
void CRuleTables::GetRaceStringMixed(unsigned char nRace, CString& sRace) |
int CRuleTables::GetRaceTHAC0Bonus(int itemType, unsigned char race) |
unsigned long CRuleTables::GetRaceTextBiography(int raceID) |
unsigned long CRuleTables::GetRaceTextLower(int raceID) |
unsigned long CRuleTables::GetRaceTextMixed(int raceID) |
int CRuleTables::GetRaiseDeadCost(CAIObjectType& TypeAI, CDerivedStats& DStats) |
void CRuleTables::GetRandomItem(CString& item) |
unsigned long CRuleTables::GetRangerHatedRaceHelp(short index) |
unsigned char CRuleTables::GetRangerHatedRaceIds(short index) |
unsigned long CRuleTables::GetRangerHatedRaceStrref(short index) |
unsigned long CRuleTables::GetRangerHatedRaceStrrefFromIds(short ids) |
void CRuleTables::GetRangerSkillPoints(unsigned char nLevel, unsigned char& nStealth) |
unsigned long CRuleTables::GetReputationDescription(const short nReputation) |
int CRuleTables::GetSavingThrow(CAIObjectType& TypeAI, CDerivedStats& DStats, unsigned char nCON, CString& sSavingThrow) |
void CRuleTables::GetScriptDescription(CString& sScript, CString& sTitle, CString& sDescription) |
int CRuleTables::GetSetSnareLimit(CGameSprite* pSprite) |
void CRuleTables::GetShamanSkillPoints(unsigned char nLevel, unsigned char& nDetect) |
void CRuleTables::GetSkillBonus(CAIObjectType& TypeAI, CDerivedStats& DStats, unsigned short& nPickPockets, unsigned short& nOpenLocks, unsigned short& nFindTraps, unsigned short& nMoveSilently, unsigned short& nHideInShadows, unsigned short& nDetectIllusion, unsigned short& nSetTraps) |
void CRuleTables::GetSkillBonusValue(CAIObjectType& TypeAI, CDerivedStats& DStats, int& nPickPocketsBonus, int& nOpenLocksBonus, int& nFindTrapsBonus, int& nMoveSilentlyBonus, int& nHideInShadowsBonus, int& nDetectIllusionBonus, int& nSetTrapsBonus) |
int CRuleTables::GetSlotStealSkill(int slot) |
int CRuleTables::GetSneakAttack(CAIObjectType& TypeAI, CDerivedStats& DStats, unsigned long nKit) |
unsigned char CRuleTables::GetSoundEnvironment(CString stAreaRef, unsigned long& dwEnvironment, float& fDamping, float& fDecay, float& fVolume, float& fReverbLevel) |
int CRuleTables::GetSpecialItemPriority(CResRef& itemName, int type) |
int CRuleTables::GetSpellAbilityValue(int classID, int nAbilityColumn) |
void CRuleTables::GetSpellDescription(CString& sSpell, CString& sDescription) |
int CRuleTables::GetSpellProtectionRelation(int nRow) |
int CRuleTables::GetSpellProtectionStat(int nRow) |
int CRuleTables::GetSpellProtectionValue(int nRow) |
void CRuleTables::GetStartArea(CResRef& cResArea, CPoint& ptView) |
void CRuleTables::GetStartAreaMP(CResRef& cResArea, CPoint& ptView) |
void CRuleTables::GetStartAreaTutorial(CResRef& cResArea, CPoint& ptView) |
CPoint CRuleTables::GetStartPoint(int nCharacterSlot) |
CPoint CRuleTables::GetStartPointMP(int nCharacterSlot) |
CPoint CRuleTables::GetStartPointTutorial(int nCharacterSlot) |
CResRef CRuleTables::GetStartWeapon(unsigned char nClass) |
int CRuleTables::GetStartingGold(CGameSprite* pSprite) |
unsigned char CRuleTables::GetStartingReputation(unsigned char nAlignment) |
CString CRuleTables::GetStatName(int offset) |
float CRuleTables::GetStatValue(CString statName) |
int CRuleTables::GetSubClassProficiencySlots(int nSubClass, int nOldLevel, int nNewLevel) |
int CRuleTables::GetSubClasses(unsigned char nClass, unsigned char* aSubClass) |
int CRuleTables::GetSummonLimit(CString summonType) |
C2DArray* CRuleTables::GetSummoningTable(int index) |
CResRef CRuleTables::GetTBPStartPartyMember(int member) |
int CRuleTables::GetTHAC0(CAIObjectType& TypeAI, CDerivedStats& DStats) |
int CRuleTables::GetThiefSkillPercentage(CGameSprite* pSprite, CString sSkill, unsigned char dualingTo) |
int CRuleTables::GetThiefSkillsDual(CGameSprite* pSprite) |
int CRuleTables::GetThiefSkillsLevelUp(CGameSprite* pSprite) |
int CRuleTables::GetThiefSkillsStart(CGameSprite* pSprite) |
int CRuleTables::GetWedFogAreaSettings(CString key, int* contrast, unsigned long* innerColor, unsigned long* outerColor, float* alpha, int* preDisperseSeconds) |
bool CRuleTables::GetWedFogPointSettings(CString key, int* pointAmount, int* pointDuration, CPoint* pointPos, float* pointUForce, float* pointVForce) |
unsigned long CRuleTables::GetXPCap(CAIObjectType& TypeAI) |
int CRuleTables::IsClassRaceCompatable(unsigned char classID, unsigned char raceID) |
unsigned char CRuleTables::IsDualClassAllowed(unsigned char nActiveClass, unsigned char nSubClass, unsigned long nSpecialist) |
int CRuleTables::IsItemExclusive(CItem* pItem) |
int CRuleTables::IsProtectedFromSpell(int nRow, CGameSprite* stats, CGameSprite* mine, int value) |
int CRuleTables::IsSpellHidden(CString spellRef) |
int CRuleTables::IsSpellRemoved(CString spellRef) |
int CRuleTables::IsUsableByAlignment(unsigned long dwNotUsableBy, unsigned char alignment) |
int CRuleTables::IsValidAlignment(unsigned char nClass, unsigned char nAlignment, unsigned long nSpecialist) |
unsigned char CRuleTables::MapCharacterSpecializationToSchool(unsigned short nSpecialistMage) |
int CRuleTables::RollHitPoints(C2DArray& tHitPoints, unsigned char nOldLevel, unsigned char nNewLevel, int nCONMinRoll, int nDivisor, int bOverrideSides, int overrideSides, int bOverrideMod, int overrideMod) |
int CRuleTables::RollHitPoints(unsigned char nClass, unsigned char nSubClass, CDerivedStats& OldDStats, CDerivedStats& NewDStats, int nCONMinRoll, int nDivisor, int bIsSingleClass) |
int CRuleTables::RollHitPoints(int nSides, int nRolls, int nLevel, int nMinRoll, int nModifier) |
int CRuleTables::SetCampaign(CString campaign) |
long CRuleTables::SevenEyesImmunity(CGameSprite* sprite, unsigned long opcode, unsigned long param2, CString& resource, int& strref) |
void CRuleTables::UnsetCampaign() |
Constructors¶
Name |
Description |
Constructs a |
|
Destroys a |
CRuleTables::CRuleTables¶
Constructs a CRuleTables
object
void CRuleTables::CRuleTables();
Remarks
Constructs a CRuleTables
object
CRuleTables::~CRuleTables¶
Destroys the CRuleTables
object
virtual void CRuleTables::~CRuleTables();
Remarks
Destroys the CRuleTables
object
Methods¶
Name |
Description |
CRuleTables::Add25StartEquipment¶
void CRuleTables::Add25StartEquipment(
CGameSprite* pSprite,
int forceDefault);
Parameters
CGameSprite* pSprite -
int
forceDefault -
Remarks
CRuleTables::AdjustStoreMarkup¶
void CRuleTables::AdjustStoreMarkup(
unsigned char nCHR,
short nReputation,
unsigned long& dwMarkup);
Parameters
unsigned char
nCHR -short
nReputation -unsigned long
& dwMarkup -
Remarks
CRuleTables::CanFall¶
int CRuleTables::CanFall(
unsigned long nClass,
unsigned long kit);
Parameters
unsigned long
nClass -unsigned long
kit -
Return Value
Returns int
Remarks
CRuleTables::ClassGetsSpecializationAPR¶
int CRuleTables::ClassGetsSpecializationAPR(
unsigned char classID,
unsigned long kitID);
Parameters
unsigned char
classID -unsigned long
kitID -
Return Value
Returns int
Remarks
CRuleTables::ClassUnarmedAPRDivisor¶
int CRuleTables::ClassUnarmedAPRDivisor(
unsigned char classID,
unsigned long kitID);
Parameters
unsigned char
classID -unsigned long
kitID -
Return Value
Returns int
Remarks
CRuleTables::ClassZeroSkillTHAC0Bonus¶
int CRuleTables::ClassZeroSkillTHAC0Bonus(
unsigned char classID,
unsigned long kitID);
Parameters
unsigned char
classID -unsigned long
kitID -
Return Value
Returns int
Remarks
CRuleTables::Compare¶
int CRuleTables::Compare(
unsigned int a,
unsigned int b,
int relation);
Parameters
unsigned int
a -unsigned int
b -int
relation -
Return Value
Returns int
Remarks
CRuleTables::FindSavingThrow¶
int CRuleTables::FindSavingThrow(
unsigned char nClass,
unsigned char nSubClass,
CDerivedStats& DStats,
CString& sSavingThrow);
Parameters
unsigned char
nClass -unsigned char
nSubClass -CDerivedStats& DStats -
CString& sSavingThrow -
Return Value
Returns int
Remarks
CRuleTables::FindTHAC0¶
int CRuleTables::FindTHAC0(
unsigned char nClass,
unsigned char nSubClass,
CDerivedStats& DStats);
Parameters
unsigned char
nClass -unsigned char
nSubClass -CDerivedStats& DStats -
Return Value
Returns int
Remarks
CRuleTables::GetAchievement¶
CString CRuleTables::GetAchievement(CString global);
Parameters
CString global -
Return Value
Returns CString
Remarks
CRuleTables::GetAlignmentDescStringRef¶
unsigned long CRuleTables::GetAlignmentDescStringRef(unsigned char nAlignment);
Parameters
unsigned char
nAlignment -
Return Value
Returns unsigned long
Remarks
CRuleTables::GetAlignmentString¶
CString CRuleTables::GetAlignmentString(unsigned char nAlignment);
Parameters
unsigned char
nAlignment -
Return Value
Returns CString
Remarks
CRuleTables::GetAlignmentStringMixed¶
void CRuleTables::GetAlignmentStringMixed(
unsigned char nAlignment,
CString& sAlignment);
Parameters
unsigned char
nAlignment -CString& sAlignment -
Remarks
CRuleTables::GetAlignmentStringRef¶
unsigned long CRuleTables::GetAlignmentStringRef(unsigned char nAlignment);
Parameters
unsigned char
nAlignment -
Return Value
Returns unsigned long
Remarks
CRuleTables::GetAnimationSpeed¶
int CRuleTables::GetAnimationSpeed(
unsigned short animationId,
int defaultSpeed);
Parameters
unsigned short
animationId -int
defaultSpeed -
Return Value
Returns int
Remarks
CRuleTables::GetAnimationType¶
unsigned short CRuleTables::GetAnimationType(CAIObjectType& TypeAI);
Parameters
CAIObjectType& TypeAI -
Return Value
Returns unsigned short
Remarks
CRuleTables::GetAreaCreatureNodeCount¶
int CRuleTables::GetAreaCreatureNodeCount(CString areaName);
Parameters
CString areaName -
Return Value
Returns int
Remarks
CRuleTables::GetAutoSpellPick¶
CResRef CRuleTables::GetAutoSpellPick(
unsigned char level,
unsigned char index);
Parameters
unsigned char
level -unsigned char
index -
Return Value
Returns CResRef
Remarks
CRuleTables::GetBackstabMultiplier¶
int CRuleTables::GetBackstabMultiplier(
CAIObjectType& TypeAI,
CDerivedStats& DStats,
unsigned long nKit);
Parameters
CAIObjectType& TypeAI -
CDerivedStats& DStats -
unsigned long
nKit -
Return Value
Returns int
Remarks
CRuleTables::GetBanterDialogFile¶
CString CRuleTables::GetBanterDialogFile(CString& name);
Parameters
CString& name -
Return Value
Returns CString
Remarks
CRuleTables::GetBanterFrequency¶
long CRuleTables::GetBanterFrequency();
Return Value
Returns long
Remarks
CRuleTables::GetBanterProbability¶
long CRuleTables::GetBanterProbability();
Return Value
Returns long
Remarks
CRuleTables::GetBanterReplayDelay¶
long CRuleTables::GetBanterReplayDelay();
Return Value
Returns long
Remarks
CRuleTables::GetBanterSpecialProbability¶
long CRuleTables::GetBanterSpecialProbability();
Return Value
Returns long
Remarks
CRuleTables::GetBardSkillPoints¶
void CRuleTables::GetBardSkillPoints(
unsigned char nLevel,
unsigned char& nPickPockets);
Parameters
unsigned char
nLevel -unsigned char
& nPickPockets -
Remarks
CRuleTables::GetBaseLore¶
unsigned char CRuleTables::GetBaseLore(
CAIObjectType& TypeAI,
CDerivedStats& DStats);
Parameters
CAIObjectType& TypeAI -
CDerivedStats& DStats -
Return Value
Returns unsigned char
Remarks
CRuleTables::GetBaseSkillPoints¶
void CRuleTables::GetBaseSkillPoints(
CAIObjectType& TypeAI,
CDerivedStats& DStats,
unsigned char& nPickPockets,
unsigned char& nOpenLocks,
unsigned char& nFindTraps,
unsigned char& nMoveSilently,
unsigned char& nHideInShadows,
unsigned char& nDetectIllusion,
unsigned char& nSetTraps);
Parameters
CAIObjectType& TypeAI -
CDerivedStats& DStats -
unsigned char
& nPickPockets -unsigned char
& nOpenLocks -unsigned char
& nFindTraps -unsigned char
& nMoveSilently -unsigned char
& nHideInShadows -unsigned char
& nDetectIllusion -unsigned char
& nSetTraps -
Remarks
CRuleTables::GetBountyChance¶
int CRuleTables::GetBountyChance(unsigned short nReputation);
Parameters
unsigned short
nReputation -
Return Value
Returns int
Remarks
CRuleTables::GetChapterBMP¶
void CRuleTables::GetChapterBMP(
CResRef& cResText,
unsigned char nRace,
unsigned char nClass,
unsigned short nReputation,
CResRef& cResPower,
CTypedPtrList& list);
Parameters
CResRef& cResText -
unsigned char
nRace -unsigned char
nClass -unsigned short
nReputation -CResRef& cResPower -
CTypedPtrList& list -
Return Value
Returns
Remarks
CRuleTables::GetChapterSong¶
int CRuleTables::GetChapterSong(:ref:`CResRef<CResRef>`\& cResText);
Parameters
CResRef& cResText -
Return Value
Returns int
Remarks
CRuleTables::GetChapterText¶
CList* CRuleTables::GetChapterText(
CResRef& cResText,
unsigned char nRace,
unsigned char nClass,
unsigned short nReputation,
CResRef& cResPower);
Parameters
CResRef& cResText -
unsigned char
nRace -unsigned char
nClass -unsigned short
nReputation -CResRef& cResPower -
Return Value
Returns CList*
Remarks
CRuleTables::GetCharacterSound¶
unsigned long CRuleTables::GetCharacterSound(
CString& sCustomSlot,
unsigned long nSoundSlot,
unsigned char nSex);
Parameters
CString& sCustomSlot -
unsigned long
nSoundSlot -unsigned char
nSex -
Return Value
Returns unsigned long
Remarks
CRuleTables::GetCharacterStateDescription¶
void CRuleTables::GetCharacterStateDescription(
int nState,
CString& sDescription);
Parameters
int
nState -CString& sDescription -
Remarks
CRuleTables::GetClassAPRBonus¶
int CRuleTables::GetClassAPRBonus(
CAIObjectType& TypeAI,
CDerivedStats& DStats,
short proficiencyLevel);
Parameters
CAIObjectType& TypeAI -
CDerivedStats& DStats -
short
proficiencyLevel -
Return Value
Returns int
Remarks
CRuleTables::GetClassAbilityTable¶
C2DArray* CRuleTables::GetClassAbilityTable(
unsigned char nClass,
unsigned long nSpecialist);
Parameters
unsigned char
nClass -unsigned long
nSpecialist -
Return Value
Returns C2DArray*
Remarks
CRuleTables::GetClassBriefDescription¶
unsigned long CRuleTables::GetClassBriefDescription(
int classID,
int kitID,
unsigned long dwFlags);
Parameters
int
classID -int
kitID -unsigned long
dwFlags -
Return Value
Returns unsigned long
Remarks
CRuleTables::GetClassFallenNotice¶
unsigned long CRuleTables::GetClassFallenNotice(
int classID,
int kitID,
unsigned long dwFlags);
Parameters
int
classID -int
kitID -unsigned long
dwFlags -
Return Value
Returns unsigned long
Remarks
CRuleTables::GetClassFromKitId¶
unsigned long CRuleTables::GetClassFromKitId(unsigned long kit);
Parameters
unsigned long
kit -
Return Value
Returns unsigned long
Remarks
CRuleTables::GetClassProficiency¶
short CRuleTables::GetClassProficiency(
unsigned char nClass,
unsigned char nActiveClass,
unsigned char nInactiveClass,
int bInactiveUsable,
unsigned long nProfType,
unsigned long nSpecialist);
Parameters
unsigned char
nClass -unsigned char
nActiveClass -unsigned char
nInactiveClass -int
bInactiveUsable -unsigned long
nProfType -unsigned long
nSpecialist -
Return Value
Returns short
Remarks
CRuleTables::GetClassString¶
CString CRuleTables::GetClassString(
unsigned char nClass,
unsigned long nSpecialist);
Parameters
unsigned char
nClass -unsigned long
nSpecialist -
Return Value
Returns CString
Remarks
CRuleTables::GetClassStringLower¶
unsigned long CRuleTables::GetClassStringLower(
unsigned char nClass,
unsigned long nSpecialist,
unsigned long dwFlags,
CString& sClass,
CGameSprite* pSprite);
Parameters
unsigned char
nClass -unsigned long
nSpecialist -unsigned long
dwFlags -CString& sClass -
CGameSprite* pSprite -
Return Value
Returns unsigned long
Remarks
CRuleTables::GetClassStringMixed¶
void CRuleTables::GetClassStringMixed(
unsigned char nClass,
unsigned long nSpecialist,
unsigned long dwFlags,
CString& sClass,
CGameSprite* pSprite);
Parameters
unsigned char
nClass -unsigned long
nSpecialist -unsigned long
dwFlags -CString& sClass -
CGameSprite* pSprite -
Remarks
CRuleTables::GetClassTHAC0Bonus¶
int CRuleTables::GetClassTHAC0Bonus(CGameSprite* pSprite);
Parameters
CGameSprite* pSprite -
Return Value
Returns int
Remarks
CRuleTables::GetClassTextBiography¶
unsigned long CRuleTables::GetClassTextBiography(
int classID,
int kitID,
unsigned long dwFlags);
Parameters
int
classID -int
kitID -unsigned long
dwFlags -
Return Value
Returns unsigned long
Remarks
CRuleTables::GetClassTextDescription¶
unsigned long CRuleTables::GetClassTextDescription(
int classID,
int kitID,
unsigned long dwFlags);
Parameters
int
classID -int
kitID -unsigned long
dwFlags -
Return Value
Returns unsigned long
Remarks
CRuleTables::GetClassTextLower¶
unsigned long CRuleTables::GetClassTextLower(
int classID,
int kitID,
unsigned long dwFlags);
Parameters
int
classID -int
kitID -unsigned long
dwFlags -
Return Value
Returns unsigned long
Remarks
CRuleTables::GetClassTextMixed¶
unsigned long CRuleTables::GetClassTextMixed(
int classID,
int kitID,
unsigned long dwFlags);
Parameters
int
classID -int
kitID -unsigned long
dwFlags -
Return Value
Returns unsigned long
Remarks
CRuleTables::GetConFatigueBonus¶
int CRuleTables::GetConFatigueBonus(unsigned char nCON);
Parameters
unsigned char
nCON -
Return Value
Returns int
Remarks
CRuleTables::GetContingencyCondition¶
unsigned char CRuleTables::GetContingencyCondition(
unsigned long& strRef,
unsigned long& description,
unsigned short id);
Parameters
unsigned long
& strRef -unsigned long
& description -unsigned short
id -
Return Value
Returns
Remarks
CRuleTables::GetContingencyTarget¶
unsigned char CRuleTables::GetContingencyTarget(
unsigned long& strRef,
unsigned long& description,
unsigned short id);
Parameters
unsigned long
& strRef -unsigned long
& description -unsigned short
id -
Return Value
Returns
Remarks
CRuleTables::GetCripplingStrike¶
int CRuleTables::GetCripplingStrike(
CAIObjectType& TypeAI,
CDerivedStats& DStats,
unsigned long nKit);
Parameters
CAIObjectType& TypeAI -
CDerivedStats& DStats -
unsigned long
nKit -
Return Value
Returns int
Remarks
CRuleTables::GetCustomSound¶
int CRuleTables::GetCustomSound(
CString& end,
unsigned char soundId);
Parameters
CString& end -
unsigned char
soundId -
Return Value
Returns int
Remarks
CRuleTables::GetDefaultColours¶
void CRuleTables::GetDefaultColours(CGameSprite* pSprite);
Parameters
CGameSprite* pSprite -
Remarks
CRuleTables::GetDefaultScript¶
CString CRuleTables::GetDefaultScript(CGameSprite* pSprite);
Parameters
CGameSprite* pSprite -
Return Value
Returns CString
Remarks
CRuleTables::GetDonateRumorChance¶
unsigned char CRuleTables::GetDonateRumorChance(unsigned long dwGold);
Parameters
unsigned long
dwGold -
Return Value
Returns unsigned char
Remarks
CRuleTables::GetDreamFile¶
CString CRuleTables::GetDreamFile(CString& name);
Parameters
CString& name -
Return Value
Returns CString
Remarks
CRuleTables::GetDualClass¶
int CRuleTables::GetDualClass(
unsigned char nClass1,
unsigned char nClass2,
unsigned char& nDualClass);
Parameters
unsigned char
nClass1 -unsigned char
nClass2 -unsigned char
& nDualClass -
Return Value
Returns int
Remarks
CRuleTables::GetDualClassMinAbilitiesDst¶
void CRuleTables::GetDualClassMinAbilitiesDst(
unsigned char nSubClass,
unsigned long nSpecialistMage,
unsigned char& nMinSTR,
unsigned char& nMinDEX,
unsigned char& nMinCON,
unsigned char& nMinINT,
unsigned char& nMinWIS,
unsigned char& nMinCHR);
Parameters
unsigned char
nSubClass -unsigned long
nSpecialistMage -unsigned char
& nMinSTR -unsigned char
& nMinDEX -unsigned char
& nMinCON -unsigned char
& nMinINT -unsigned char
& nMinWIS -unsigned char
& nMinCHR -
Remarks
CRuleTables::GetDualClassMinAbilitiesSrc¶
void void CRuleTables::GetDualClassMinAbilitiesSrc(
unsigned char nSubClass,
unsigned long nSpecialistMage,
unsigned char& nMinSTR,
unsigned char& nMinDEX,
unsigned char& nMinCON,
unsigned char& nMinINT,
unsigned char& nMinWIS,
unsigned char& nMinCHR);
Parameters
unsigned char
nSubClass -unsigned long
nSpecialistMage -unsigned char
& nMinSTR -unsigned char
& nMinDEX -unsigned char
& nMinCON -unsigned char
& nMinINT -unsigned char
& nMinWIS -unsigned char
& nMinCHR -
Remarks
CRuleTables::GetExtraAnimation¶
int CRuleTables::GetExtraAnimation(
unsigned short animationId,
char* armorMaxCode,
unsigned char* bCanLieDown,
unsigned char* bDetectedByInfravision,
int* bDoubleBlit,
int* bEquipHelmet,
int* bSplitBams,
unsigned char* colorBlood,
unsigned char* colorChunks,
int* falseColor,
CString* heightCode,
CString* heightCodeHelmet,
CString* heightCodeShieldPaperDoll,
unsigned long* nSndFreq,
unsigned char* personalSpace,
CString* resref,
CString* resrefPaperDoll,
unsigned char* resrefArmorBase,
unsigned char* resrefArmorSpecific,
CString* resrefShadow);
Parameters
unsigned short
animationId -char
* armorMaxCode -unsigned char
* bCanLieDown -unsigned char
* bDetectedByInfravision -int
* bDoubleBlit -int
* bEquipHelmet -int
* bSplitBams -unsigned char
* colorBlood -unsigned char
* colorChunks -int
* falseColor -CString* heightCode -
CString* heightCodeHelmet -
CString* heightCodeShieldPaperDoll -
unsigned long
* nSndFreq -unsigned char
* personalSpace -CString* resref -
CString* resrefPaperDoll -
unsigned char
* resrefArmorBase -unsigned char
* resrefArmorSpecific -CString* resrefShadow -
Return Value
Returns int
Remarks
CRuleTables::GetFamiliar¶
CResRef CRuleTables::GetFamiliar(unsigned char alignment);
Parameters
unsigned char
alignment -
Return Value
Returns CResRef
Remarks
CRuleTables::GetGenderStringMixed¶
void CRuleTables::GetGenderStringMixed(
unsigned char nGender,
CString& sGender);
Parameters
unsigned char
nGender -CString& sGender -
Remarks
CRuleTables::GetHPCONBonus¶
void CRuleTables::GetHPCONBonus(
unsigned char nClass,
unsigned char nCON,
int& nBonus,
int& nMinRoll);
Parameters
unsigned char
nClass -unsigned char
nCON -int
& nBonus -int
& nMinRoll -
Remarks
CRuleTables::GetHPCONBonusTotal¶
int CRuleTables::GetHPCONBonusTotal(
CAIObjectType& TypeAI,
CDerivedStats& DStats,
unsigned char nCON);
Parameters
CAIObjectType& TypeAI -
CDerivedStats& DStats -
unsigned char
nCON -
Return Value
Returns int
Remarks
CRuleTables::GetHitPoints¶
int CRuleTables::GetHitPoints(
CAIObjectType& TypeAI,
CDerivedStats& OldDStats,
CDerivedStats& NewDStats,
unsigned char nCON);
Parameters
CAIObjectType& TypeAI -
CDerivedStats& OldDStats -
CDerivedStats& NewDStats -
unsigned char
nCON -
Return Value
Returns int
Remarks
CRuleTables::GetInnateClassSkill¶
int CRuleTables::GetInnateClassSkill(
CGameSprite* pSprite,
CString sSkill);
Parameters
CGameSprite* pSprite -
CString sSkill -
Return Value
Returns int
Remarks
CRuleTables::GetIntoxicationInfo¶
void CRuleTables::GetIntoxicationInfo(
unsigned char nCON,
int& nIntoxicationRate,
int& nRecoveryRate,
int& nIntoxicationCap);
Parameters
unsigned char
nCON -int
& nIntoxicationRate -int
& nRecoveryRate -int
& nIntoxicationCap -
Remarks
CRuleTables::GetItemAbilityDescription¶
unsigned long CRuleTables::GetItemAbilityDescription(
CResRef& cResItem,
int nAbilityNum);
Parameters
CResRef& cResItem -
int
nAbilityNum -
Return Value
Returns unsigned long
Remarks
CRuleTables::GetItemDropSound¶
CResRef CRuleTables::GetItemDropSound(int itemtype);
Parameters
int
itemtype -
Return Value
Returns CResRef
Remarks
CRuleTables::GetItemTakeSound¶
CResRef CRuleTables::GetItemTakeSound(int itemtype);
Parameters
int
itemtype -
Return Value
Returns CResRef
Remarks
CRuleTables::GetItemTypeSlot¶
int CRuleTables::GetItemTypeSlot(int itemtype);
Parameters
int
itemtype -
Return Value
Returns int
Remarks
CRuleTables::GetItemUseFlag¶
int CRuleTables::GetItemUseFlag(CString item);
Parameters
CString item -
Return Value
Returns int
Remarks
CRuleTables::GetItemUseString¶
int CRuleTables::GetItemUseString(CString item);
Parameters
CString item -
Return Value
Returns int
Remarks
CRuleTables::GetItemUseUser¶
CString CRuleTables::GetItemUseUser(CString item);
Parameters
CString item -
Return Value
Returns CString
Remarks
CRuleTables::GetItemUseUserName¶
CString CRuleTables::GetItemUseUserName(CString item);
Parameters
CString item -
Return Value
Returns CString
Remarks
CRuleTables::GetJoinDialogFile¶
CString CRuleTables::GetJoinDialogFile(CString item);
Parameters
CString item -
Return Value
Returns CString
Remarks
CRuleTables::GetLayOnHandsAmount¶
int CRuleTables::GetLayOnHandsAmount(
CAIObjectType& TypeAI,
CDerivedStats& DStats);
Parameters
CAIObjectType& TypeAI -
CDerivedStats& DStats -
Return Value
Returns int
Remarks
CRuleTables::GetLevelUpAbilities¶
CGameAbilityList* CRuleTables::GetLevelUpAbilities(
CGameSprite* pSprite,
int nLevel);
Parameters
CGameSprite* pSprite -
int
nLevel -
Return Value
Returns CGameAbilityList*
Remarks
CRuleTables::GetLevelUpAbilityTableString¶
void CRuleTables::GetLevelUpAbilityTableString(
CGameSprite* pSprite,
int nLevel,
CString& sTableName);
Parameters
CGameSprite* pSprite -
int
nLevel -CString& sTableName -
Remarks
CRuleTables::GetLoreBonus¶
int CRuleTables::GetLoreBonus(
unsigned char nWIS,
unsigned char nINT);
Parameters
unsigned char
nWIS -unsigned char
nINT -
Return Value
Returns int
Remarks
CRuleTables::GetMageSpell¶
CResRef CRuleTables::GetMageSpell(
int nSpellLevel,
int nSpellIndex);
Parameters
int
nSpellLevel -int
nSpellIndex -
Return Value
Returns CResRef
Remarks
CRuleTables::GetMaxMemorizedSpellsMage¶
int CRuleTables::GetMaxMemorizedSpellsMage(
CAIObjectType& TypeAI,
CDerivedStats& DStats,
unsigned long nSpecialistMage,
int nSpellLevel);
Parameters
CAIObjectType& TypeAI -
CDerivedStats& DStats -
unsigned long
nSpecialistMage -int
nSpellLevel -
Return Value
Returns int
Remarks
CRuleTables::GetMaxMemorizedSpellsPriest¶
int CRuleTables::GetMaxMemorizedSpellsPriest(
CAIObjectType& TypeAI,
CDerivedStats& DStats,
int nSpellLevel,
int& nBonus);
Parameters
CAIObjectType& TypeAI -
CDerivedStats& DStats -
int
nSpellLevel -int
& nBonus -
Return Value
Returns int
Remarks
CRuleTables::GetMaxMemorizedSpellsRanger¶
int CRuleTables::GetMaxMemorizedSpellsRanger(
CAIObjectType& TypeAI,
CDerivedStats& DStats,
int nSpellLevel);
Parameters
CAIObjectType& TypeAI -
CDerivedStats& DStats -
int
nSpellLevel -
Return Value
Returns int
Remarks
CRuleTables::GetMaxSpellLevel¶
int CRuleTables::GetMaxSpellLevel(CDerivedStats& DStats);
Parameters
CDerivedStats& DStats -
Return Value
Returns int
Remarks
CRuleTables::GetMaxSpellsPerLevel¶
int CRuleTables::GetMaxSpellsPerLevel(CDerivedStats& DStats);
Parameters
CDerivedStats& DStats -
Return Value
Returns int
Remarks
CRuleTables::GetMaximumProficiency¶
int CRuleTables::GetMaximumProficiency(
int nLevel,
int nClass);
Parameters
int
nLevel -int
nClass -
Return Value
Returns int
Remarks
CRuleTables::GetMonkFist¶
CString CRuleTables::GetMonkFist(int nLevel);
Parameters
int
nLevel -
Return Value
Returns CString
Remarks
CRuleTables::GetMovieDescription¶
void CRuleTables::GetMovieDescription(
CString& sMovie,
CString& sDescription);
Parameters
Remarks
CRuleTables::GetNPCChart¶
C2DArray* CRuleTables::GetNPCChart();
Return Value
Returns C2DArray*
Remarks
CRuleTables::GetNextLevel¶
void CRuleTables::GetNextLevel(
CAIObjectType& TypeAI,
CDerivedStats& DStats);
Parameters
CAIObjectType& TypeAI -
CDerivedStats& DStats -
Remarks
CRuleTables::GetNextLevelSubClass¶
void CRuleTables::GetNextLevelSubClass(
unsigned char nClass,
unsigned char nSubClass,
unsigned char nActiveClass,
unsigned char nInactiveClass,
CDerivedStats& DStats);
Parameters
unsigned char
nClass -unsigned char
nSubClass -unsigned char
nActiveClass -unsigned char
nInactiveClass -CDerivedStats& DStats -
Remarks
CRuleTables::GetNextLevelXP¶
unsigned long CRuleTables::GetNextLevelXP(
unsigned char nClass,
unsigned char nLevel);
Parameters
unsigned char
nClass -unsigned char
nLevel -
Return Value
Returns unsigned long
Remarks
CRuleTables::GetNumLevelUpAbilities¶
int CRuleTables::GetNumLevelUpAbilities(
CAIObjectType& TypeAI,
CDerivedStats& OldDStats,
CDerivedStats& NewDStats,
unsigned char& nLevel);
Parameters
CAIObjectType& TypeAI -
CDerivedStats& OldDStats -
CDerivedStats& NewDStats -
unsigned char
& nLevel -
Return Value
Returns int
Remarks
CRuleTables::GetNumPriestSpells¶
int CRuleTables::GetNumPriestSpells(int nSpellLevel);
Parameters
int
nSpellLevel -
Return Value
Returns int
Remarks
CRuleTables::GetNumQuickWeaponSlots¶
int CRuleTables::GetNumQuickWeaponSlots(
unsigned char nClass,
unsigned char nActiveClass,
unsigned char nInactiveClass,
int bInactiveUsable,
unsigned long nSpecialist);
Parameters
unsigned char
nClass -unsigned char
nActiveClass -unsigned char
nInactiveClass -int
bInactiveUsable -unsigned long
nSpecialist -
Return Value
Returns int
Remarks
CRuleTables::GetPostDialogFile¶
CString CRuleTables::GetPostDialogFile(CString& name);
Parameters
CString& name -
Return Value
Returns CString
Remarks
CRuleTables::GetPriestSpell¶
CResRef CRuleTables::GetPriestSpell(
int nSpellLevel,
int nSpellIndex);
Parameters
int
nSpellLevel -int
nSpellIndex -
Return Value
Returns CResRef
Remarks
CRuleTables::GetProfBonuses¶
void CRuleTables::GetProfBonuses(
int nProf,
int nLev,
int* damR,
int* damL,
int* thacR,
int* thacL,
int* ACB,
int* ACM,
int* speed,
int* crit);
Parameters
int
nProf -int
nLev -int
* damR -int
* damL -int
* thacR -int
* thacL -int
* ACB -int
* ACM -int
* speed -int
* crit -
Remarks
CRuleTables::GetProficiencyClassIndex¶
unsigned long CRuleTables::GetProficiencyClassIndex(
unsigned char nClass,
unsigned long nSpecialist);
Parameters
unsigned char
nClass -unsigned long
nSpecialist -
Return Value
Returns unsigned long
Remarks
CRuleTables::GetProficiencyDescription¶
unsigned long CRuleTables::GetProficiencyDescription(unsigned long id);
Parameters
unsigned long
id -
Return Value
Returns unsigned long
Remarks
CRuleTables::GetProficiencyId¶
unsigned long CRuleTables::GetProficiencyId(unsigned long index);
Parameters
unsigned long
index -
Return Value
Returns unsigned long
Remarks
CRuleTables::GetProficiencyName¶
unsigned long CRuleTables::GetProficiencyName(unsigned long id);
Parameters
unsigned long
id -
Return Value
Returns unsigned long
Remarks
CRuleTables::GetProficiencySlots¶
int CRuleTables::GetProficiencySlots(
CAIObjectType& TypeAI,
CDerivedStats& OldDStats,
CDerivedStats& NewDStats,
unsigned char GetInactive);
Parameters
CAIObjectType& TypeAI -
CDerivedStats& OldDStats -
CDerivedStats& NewDStats -
unsigned char
GetInactive -
Return Value
Returns int
Remarks
CRuleTables::GetRaceFeatures¶
int CRuleTables::GetRaceFeatures(
int race,
int type);
Parameters
int
race -int
type -
Return Value
Returns int
Remarks
CRuleTables::GetRaceString¶
CString CRuleTables::GetRaceString(unsigned char nRace);
Parameters
unsigned char
nRace -
Return Value
Returns CString
Remarks
CRuleTables::GetRaceStringMixed¶
void CRuleTables::GetRaceStringMixed(
unsigned char nRace,
CString& sRace);
Parameters
unsigned char
nRace -CString& sRace -
Remarks
CRuleTables::GetRaceTHAC0Bonus¶
int CRuleTables::GetRaceTHAC0Bonus(
int itemType,
unsigned char race);
Parameters
int
itemType -unsigned char
nRace -
Return Value
Returns int
Remarks
CRuleTables::GetRaceTextBiography¶
unsigned long CRuleTables::GetRaceTextBiography(int raceID);
Parameters
int
raceID -
Return Value
Returns unsigned long
Remarks
CRuleTables::GetRaceTextLower¶
unsigned long CRuleTables::GetRaceTextLower(int raceID);
Parameters
int
raceID -
Return Value
Returns unsigned long
Remarks
CRuleTables::GetRaceTextMixed¶
unsigned long CRuleTables::GetRaceTextMixed(int raceID);
Parameters
int
raceID -
Return Value
Returns unsigned long
Remarks
CRuleTables::GetRaiseDeadCost¶
int CRuleTables::GetRaiseDeadCost(
CAIObjectType& TypeAI,
CDerivedStats& DStats);
Parameters
CAIObjectType& TypeAI -
CDerivedStats& DStats -
Return Value
Returns int
Remarks
CRuleTables::GetRandomItem¶
void CRuleTables::GetRandomItem(CString& item);
Parameters
CString& item -
Remarks
CRuleTables::GetRangerHatedRaceHelp¶
unsigned long CRuleTables::GetRangerHatedRaceHelp(short index);
Parameters
short
index -
Return Value
Returns unsigned long
Remarks
CRuleTables::GetRangerHatedRaceIds¶
unsigned char CRuleTables::GetRangerHatedRaceIds(short index);
Parameters
short
index -
Return Value
Returns unsigned char
Remarks
CRuleTables::GetRangerHatedRaceStrref¶
unsigned long CRuleTables::GetRangerHatedRaceStrref(short index);
Parameters
short
index -
Return Value
Returns unsigned long
Remarks
CRuleTables::GetRangerHatedRaceStrrefFromIds¶
unsigned long CRuleTables::GetRangerHatedRaceStrrefFromIds(short ids);
Parameters
short
ids -
Return Value
Returns unsigned long
Remarks
CRuleTables::GetRangerSkillPoints¶
void CRuleTables::GetRangerSkillPoints(
unsigned char nLevel,
unsigned char& nStealth);
Parameters
unsigned char
nLevel -unsigned char
& nStealth -
Remarks
CRuleTables::GetReputationDescription¶
unsigned long CRuleTables::GetReputationDescription(const short nReputation);
Parameters
const short
nReputation -
Return Value
Returns unsigned long
Remarks
CRuleTables::GetSavingThrow¶
int CRuleTables::GetSavingThrow(
CAIObjectType& TypeAI,
CDerivedStats& DStats,
unsigned char nCON,
CString& sSavingThrow);
Parameters
CAIObjectType& TypeAI -
CDerivedStats& DStats -
unsigned char
nCON -CString& sSavingThrow -
Return Value
Returns int
Remarks
CRuleTables::GetScriptDescription¶
void CRuleTables::GetScriptDescription(
CString& sScript,
CString& sTitle,
CString& sDescription);
Parameters
Remarks
CRuleTables::GetSetSnareLimit¶
int CRuleTables::GetSetSnareLimit(CGameSprite* pSprite);
Parameters
CGameSprite* pSprite -
Return Value
Returns int
Remarks
CRuleTables::GetShamanSkillPoints¶
void CRuleTables::GetShamanSkillPoints(
unsigned char nLevel,
unsigned char& nDetect);
Parameters
unsigned char
nLevel -unsigned char
& nDetect -
Remarks
CRuleTables::GetSkillBonus¶
void CRuleTables::GetSkillBonus(
CAIObjectType& TypeAI,
CDerivedStats& DStats,
unsigned short& nPickPockets,
unsigned short& nOpenLocks,
unsigned short& nFindTraps,
unsigned short& nMoveSilently,
unsigned short& nHideInShadows,
unsigned short& nDetectIllusion,
unsigned short& nSetTraps);
Parameters
CAIObjectType& TypeAI
CDerivedStats& DStats
unsigned short
& nPickPockets -unsigned short
& nOpenLocks -unsigned short
& nFindTraps -unsigned short
& nMoveSilently -unsigned short
& nHideInShadows -unsigned short
& nDetectIllusion -unsigned short
& nSetTraps -
Return Value
Returns
Remarks
CRuleTables::GetSkillBonusValue¶
void CRuleTables::GetSkillBonusValue(
CAIObjectType& TypeAI,
CDerivedStats& DStats,
int& nPickPocketsBonus,
int& nOpenLocksBonus,
int& nFindTrapsBonus,
int& nMoveSilentlyBonus,
int& nHideInShadowsBonus,
int& nDetectIllusionBonus,
int& nSetTrapsBonus);
Parameters
CAIObjectType& TypeAI
CDerivedStats& DStats
int
& nPickPocketsBonus -int
& nOpenLocksBonus -int
& nFindTrapsBonus -int
& nMoveSilentlyBonus -int
& nHideInShadowsBonus -int
& nDetectIllusionBonus -int
& nSetTrapsBonus -
Remarks
CRuleTables::GetSlotStealSkill¶
int CRuleTables::GetSlotStealSkill(int slot);
Parameters
int
slot -
Return Value
Returns int
Remarks
CRuleTables::GetSneakAttack¶
int CRuleTables::GetSneakAttack(
CAIObjectType& TypeAI,
CDerivedStats& DStats,
unsigned long nKit);
Parameters
CAIObjectType& TypeAI
CDerivedStats& DStats
unsigned long
nKit -
Return Value
Returns int
Remarks
CRuleTables::GetSoundEnvironment¶
unsigned char CRuleTables::GetSoundEnvironment(
CString stAreaRef,
unsigned long& dwEnvironment,
float& fDamping,
float& fDecay,
float& fVolume,
float& fReverbLevel);
Parameters
CString stAreaRef -
unsigned long
& dwEnvironment -float
& fDamping -float
& fDecay -float
& fVolume -float
& fReverbLevel -
Return Value
Returns unsigned char
Remarks
CRuleTables::GetSpecialItemPriority¶
int CRuleTables::GetSpecialItemPriority(
CResRef& itemName,
int type);
Parameters
CResRef& itemName -
int
type -
Return Value
Returns int
Remarks
CRuleTables::GetSpellAbilityValue¶
int CRuleTables::GetSpellAbilityValue(
int classID,
int nAbilityColumn);
Parameters
int
classID -int
nAbilityColumn -
Return Value
Returns int
Remarks
CRuleTables::GetSpellDescription¶
void CRuleTables::GetSpellDescription(
CString& sSpell,
CString& sDescription);
Parameters
Remarks
CRuleTables::GetSpellProtectionRelation¶
int CRuleTables::GetSpellProtectionRelation(int nRow);
Parameters
int
nRow -
Return Value
Returns int
Remarks
CRuleTables::GetSpellProtectionStat¶
int CRuleTables::GetSpellProtectionStat(int nRow);
Parameters
int
nRow -
Return Value
Returns int
Remarks
CRuleTables::GetSpellProtectionValue¶
int CRuleTables::GetSpellProtectionValue(int nRow);
Parameters
int
nRow -
Return Value
Returns int
Remarks
CRuleTables::GetStartArea¶
void CRuleTables::GetStartArea(
CResRef& cResArea,
CPoint& ptView);
Parameters
Remarks
CRuleTables::GetStartAreaMP¶
void CRuleTables::GetStartAreaMP(
CResRef& cResArea,
CPoint& ptView);
Parameters
Remarks
CRuleTables::GetStartAreaTutorial¶
void CRuleTables::GetStartAreaTutorial(
CResRef& cResArea,
CPoint& ptView);
Parameters
Remarks
CRuleTables::GetStartPoint¶
CPoint CRuleTables::GetStartPoint(int nCharacterSlot);
Parameters
int
nCharacterSlot -
Return Value
Returns CPoint
Remarks
CRuleTables::GetStartPointMP¶
CPoint CRuleTables::GetStartPointMP(int nCharacterSlot);
Parameters
int
nCharacterSlot -
Return Value
Returns CPoint
Remarks
CRuleTables::GetStartPointTutorial¶
CPoint CRuleTables::GetStartPointTutorial(int nCharacterSlot);
Parameters
int
nCharacterSlot -
Return Value
Returns CPoint
Remarks
CRuleTables::GetStartWeapon¶
CResRef CRuleTables::GetStartWeapon((unsigned char nClass);
Parameters
unsigned char
nClass -
Return Value
Returns CResRef
Remarks
CRuleTables::GetStartingGold¶
int CRuleTables::GetStartingGold(CGameSprite* pSprite);
Parameters
CGameSprite* pSprite -
Return Value
Returns int
Remarks
CRuleTables::GetStartingReputation¶
unsigned char CRuleTables::GetStartingReputation(unsigned char nAlignment);
Parameters
unsigned char
nAlignment -
Return Value
Returns unsigned char
Remarks
CRuleTables::GetStatName¶
CString CRuleTables::GetStatName(int offset);
Parameters
int
offset -
Return Value
Returns CString
Remarks
CRuleTables::GetStatValue¶
float CRuleTables::GetStatValue(CString statName);
Parameters
CString statName -
Return Value
Returns float
Remarks
CRuleTables::GetSubClassProficiencySlots¶
int CRuleTables::GetSubClassProficiencySlots(
int nSubClass,
int nOldLevel,
int nNewLevel);
Parameters
int
nSubClass -int
nOldLevel -int
nNewLevel -
Return Value
Returns int
Remarks
CRuleTables::GetSubClasses¶
int CRuleTables::GetSubClasses(
unsigned char nClass,
unsigned char* aSubClass);
Parameters
unsigned char
nClass -unsigned char
* aSubClass -
Return Value
Returns int
Remarks
CRuleTables::GetSummonLimit¶
int CRuleTables::GetSummonLimit(CString summonType);
Parameters
CString summonType -
Return Value
Returns int
Remarks
CRuleTables::GetSummoningTable¶
C2DArray* CRuleTables::GetSummoningTable(int index);
Parameters
int
index -
Return Value
Returns C2DArray*
Remarks
CRuleTables::GetTBPStartPartyMember¶
CResRef CRuleTables::GetTBPStartPartyMember(int member);
Parameters
int
member -
Return Value
Returns CResRef
Remarks
CRuleTables::GetTHAC0¶
int CRuleTables::GetTHAC0(
CAIObjectType& TypeAI,
CDerivedStats& DStats);
Parameters
CAIObjectType& TypeAI -
CDerivedStats& DStats -
Return Value
Returns int
Remarks
CRuleTables::GetThiefSkillPercentage¶
int CRuleTables::GetThiefSkillPercentage(
CGameSprite* pSprite,
CString sSkill,
unsigned char dualingTo);
Parameters
CGameSprite* pSprite -
CString sSkill -
unsigned char
dualingTo -
Return Value
Returns int
Remarks
CRuleTables::GetThiefSkillsDual¶
int CRuleTables::GetThiefSkillsDual(CGameSprite* pSprite);
Parameters
CGameSprite* pSprite -
Return Value
Returns int
Remarks
CRuleTables::GetThiefSkillsLevelUp¶
int CRuleTables::GetThiefSkillsLevelUp(CGameSprite* pSprite);
Parameters
CGameSprite* pSprite -
Return Value
Returns int
Remarks
CRuleTables::GetThiefSkillsStart¶
int CRuleTables::GetThiefSkillsStart(CGameSprite* pSprite);
Parameters
CGameSprite* pSprite -
Return Value
Returns int
Remarks
CRuleTables::GetWedFogAreaSettings¶
int CRuleTables::GetWedFogAreaSettings(
CString key,
int* contrast,
unsigned long* innerColor,
unsigned long* outerColor,
float* alpha,
int* preDisperseSeconds);
Parameters
CString key -
int
* contrast -unsigned long
* innerColor -unsigned long
* outerColor -float
* alpha -int
* preDisperseSeconds -
Return Value
Returns int
Remarks
CRuleTables::GetWedFogPointSettings¶
bool CRuleTables::GetWedFogPointSettings(
CString key,
int* pointAmount,
int* pointDuration,
CPoint* pointPos,
float* pointUForce,
float* pointVForce);
Parameters
CString key -
int
* pointAmount -int
* pointDuration -CPoint* pointPos -
float
* pointUForce -float
* pointVForce -
Return Value
Returns bool
Remarks
CRuleTables::GetXPCap¶
unsigned long CRuleTables::GetXPCap(CAIObjectType& TypeAI);
Parameters
CAIObjectType& TypeAI -
Return Value
Returns unsigned long
Remarks
CRuleTables::IsClassRaceCompatable¶
int CRuleTables::IsClassRaceCompatable(
unsigned char classID,
unsigned char raceID);
Parameters
unsigned char
classID -unsigned char
raceID -
Return Value
Returns int
Remarks
CRuleTables::IsDualClassAllowed¶
unsigned char CRuleTables::IsDualClassAllowed(
unsigned char nActiveClass,
unsigned char nSubClass,
unsigned long nSpecialist);
Parameters
unsigned char
nActiveClass -unsigned char
nSubClass -unsigned long
nSpecialist -
Return Value
Returns unsigned char
Remarks
CRuleTables::IsItemExclusive¶
int CRuleTables::IsItemExclusive(CItem* pItem);
Parameters
CItem* pItem -
Return Value
Returns int
Remarks
CRuleTables::IsProtectedFromSpell¶
int CRuleTables::IsProtectedFromSpell(
int nRow,
CGameSprite* stats,
CGameSprite* mine,
int value);
Parameters
int
nRow -CGameSprite* stats -
CGameSprite* mine -
int
value -
Return Value
Returns int
Remarks
CRuleTables::IsSpellRemoved¶
int CRuleTables::IsSpellRemoved(CString spellRef);
Parameters
CString spellRef -
Return Value
Returns int
Remarks
CRuleTables::IsUsableByAlignment¶
int CRuleTables::IsUsableByAlignment(
unsigned long dwNotUsableBy,
unsigned char alignment);
Parameters
unsigned long
dwNotUsableBy -unsigned char
alignment -
Return Value
Returns int
Remarks
CRuleTables::IsValidAlignment¶
int CRuleTables::IsValidAlignment(
unsigned char nClass,
unsigned char nAlignment,
unsigned long nSpecialist);
Parameters
unsigned char
nClass -unsigned char
nAlignment -unsigned long
nSpecialist -
Return Value
Returns int
Remarks
CRuleTables::MapCharacterSpecializationToSchool¶
unsigned char CRuleTables::MapCharacterSpecializationToSchool(unsigned short nSpecialistMage);
Parameters
unsigned short
nSpecialistMage -
Return Value
Returns unsigned char
Remarks
CRuleTables::RollHitPoints¶
int CRuleTables::RollHitPoints(
C2DArray& tHitPoints,
unsigned char nOldLevel,
unsigned char nNewLevel,
int nCONMinRoll,
int nDivisor,
int bOverrideSides,
int overrideSides,
int bOverrideMod,
int overrideMod);
Parameters
C2DArray& tHitPoints -
unsigned char
nOldLevel -unsigned char
nNewLevel -int
nCONMinRoll -int
nDivisor -int
bOverrideSides -int
overrideSides -int
bOverrideMod -int
overrideMod -
Return Value
Returns int
Remarks
CRuleTables::RollHitPoints¶
int CRuleTables::RollHitPoints(
unsigned char nClass,
unsigned char nSubClass,
CDerivedStats& OldDStats,
CDerivedStats& NewDStats,
int nCONMinRoll,
int nDivisor,
int bIsSingleClass);
Parameters
unsigned char
nClass -unsigned char
nSubClass -CDerivedStats& OldDStats -
CDerivedStats& NewDStats -
int
nCONMinRoll -int
nDivisor -int
bIsSingleClass -
Return Value
Returns int
Remarks
CRuleTables::RollHitPoints¶
int CRuleTables::RollHitPoints(
int nSides,
int nRolls,
int nLevel,
int nMinRoll,
int nModifier);
Parameters
int
nSides -int
nRolls -int
nLevel -int
nMinRoll -int
nModifier -
Return Value
Returns int
Remarks
CRuleTables::SetCampaign¶
int CRuleTables::SetCampaign(CString campaign);
Parameters
CString campaign -
Return Value
Returns int
Remarks
CRuleTables::SevenEyesImmunity¶
long CRuleTables::SevenEyesImmunity(
CGameSprite* sprite,
unsigned long opcode,
unsigned long param2,
CString& resource,
int& strref);
Parameters
CGameSprite* sprite -
unsigned long
opcode -unsigned long
param2 -CString& resource -
int
& strref -
Return Value
Returns long
Remarks
CRuleTables::UnsetCampaign¶
void CRuleTables::UnsetCampaign();
Remarks