INCLUDE FILES

Include Files ((FOR EXPERIENCED SCRIPTERS ONLY))


Quoted from Dranfaelarun
These lists are only useful for scripters, not builders nor DMs. Unless you're dabbling in scripting, you can safely ignore these.

That said, it is useful. Easiest way to know what each function does though will be to open them up in the Script Editor (and view all resources, not just module-only) and read the comment and the code to understand what it does. Another try is to search the module to see if that function isn't already being used elsewhere, although in a lot of cases I'm going to imagine that they would be in non-module scripts (ie NWN/XP1/XP2/CEP and not TSM). We are using some of them of course, like:

Dregnarg wrote:CastFakeSpellAtLocation? Woo!

Corani uses this when she heals someone of an ability damage or when she raises a body. She's not actually expending a spell, she's just going through the motions of casting and providing the visuals.

Also remember that an invaluable resource is to be had at www.nwnlexicon.com although I've already checked that they don't have all of these functions indexed.




Quoted from Galruthe

Here are just a couple essential include script files that everyone should be aware of and what they include. There's alot of include files out there to dig through, I'm just tossing out the ones that I most frequently utilize.


nw_i0_plot

AdjustFactionReputation
AutoAlignE
AutoAlignG
AutoDC
CanSeePlayer
CheckCharismaHigh
CheckCharismaLow
CheckCharismaMiddle
CheckCharismaNormal
CheckDCStr
CheckIntelligenceHigh
CheckIntelligenceLow
CheckIntelligenceNormal
CheckIntelligenceNormal
CheckWisdomHigh
DebugSpeak
DimensionHop
DoGiveXP
DoOnce
EscapeArea
EscapeViaTeleport
GetCharisma
GetIntelligence
GetIsPlayerCharacter
GetMyMaster
GetNearestPC
GetNumItems
GetPLocalInt
GetReactionAdjustment
GetWisdom
GiveNumItems
gplotAppraiseFavOpenStore
gplotAppraiseOpenStore
HasItem
IsRecall
PlayCharacterTheme
PlayOldTheme
PlaySpeakSoundByStrRef
plotCanRemoveXP
RemoveEffects
Reward_2daXP
RewardGP
RewardXP
SetIsEnemy
SetPLocalInt
TakeGold
TakeNumItems



nw_i0_spells

AmIAHumanoid
AssignAOEDebugString
CreateDoomEffectsLink
CreateProtectionFromAlignmentLink
DoSpellBreach
GetRandomDelay
GetScaledDuration
GetScaledEffect
GetSpellBreachProtection
GetSpellEffectDelay
MyResistSpell
MySavingThrow
PlayDragonBattleCry
RemoveProtections
RemoveSpecificEffect
RemoveSpellEffects
TrapDoElectricalDamage



x2_inc_craft

CICopyItemAppearance
CICraftBrewPotion
CICraftCheckBrewPotion
CICraftCheckScribeScroll
CICraftScribeScroll
CIGetCraftItemStructFrom2DA
CIGetIsCraftFeatBaseItem
CIGetIsSpellRestrictedFromCraftFeat
CIGetSpellWasUsedForItemCreation
CIRemoveItemProps
CIUseCraftItemSkill
ClearCreatureOverrideAIScriptTarget
ExecuteScriptAndReturnInt
GetCreatureFlag
GetCreatureOverrideAIScriptTarget
GetDoorFlag
GetItemFlag
GetModuleSwitchValue
GetUserDefinedItemEventNumber
SetCreatureFlag
SetCreatureOverrideAIScript
SetCreatureOverrideAIScriptFinished
SetDoorFlag
SetExecutedScriptReturnValue
SetItemFlag
SetModuleOverrideSpellscript
SetModuleSwitch
SetUserDefinedItemEventNumber
SetUserDefinedItemEventPrefix
SetWanderingMonster2DAFile
IPDyeArmor
IPGetDamageBonusConstantFromNumber
IPGetDamagePowerConstantFromNumber
IPGetHasItemPropertyOnCharacter
IPGetIPConstCastSpellFromSpellID
IPGetIPWorkContainer
IPGetIsBludgeoningWeapon
IPGetIsIntelligentWeapon
IPGetIsItemEquipable
IPGetIsMeleeWeapon
IPGetIsProjectile
IPGetIsRangedWeapon
IPGetItemHasItemOnHitPropertySubType
IPGetItemHasProperty
IPGetItemPropertyByID
IPGetItemSequencerProperty
IPGetModifiedArmor
IPGetNextArmorAppearanceType
IPGetNumberOfAppearances
IPGetNumberOfItemProperties
IPGetPrevArmorAppearanceType
IPGetRandomArmorAppearanceType
IPGetWeaponEnhancementBonus
IPRemoveAllItemProperties
IPRemoveMatchingItemProperties
IPSafeAddItemProperty
IPSetWeaponEnhancementBonus
IPUpgradeWeaponEnhancementBonus
IPWildShapeCopyItemProperties



x1_inc_cutscene

CutActionCastFakeSpellAtLocation
CutActionCastFakeSpellAtObject
CutActionMoveToLocation
CutActionMoveToObject
CutActionStartConversation
CutApplyEffectAtLocation
CutApplyEffectToObject
CutApplyEffectToObject2
CutBlackScreen
CutClearAllActions
CutCreateObject
CutDeath
CutDestroyObject
CutFadeFromBlack
CutFadeOutAndIn
CutFadeToBlack
CutJumpToLocation
CutJumpToObject
CutKnockdown
CutPlayAnimation
CutPlayAnimation
CutRemoveEffects
CutRestoreCameraFacing
CutRestoreLocation
CutSetCamera
CutSetCutsceneMode
CutSetFacingPoint
CutSetLocation
CutSetPlotFlag
CutSpeakString
CutStopFade
CutStoreCameraFacing



nw_i0_generic

ActivateFleeToExit
AnimActionChallengeIntruder
AnimActionCloseRandomDoor
AnimActionFindFriend
AnimActionFindPlaceable
AnimActionGetUpFromChair
AnimActionGoHome
AnimActionGoInside
AnimActionGoOutside
AnimActionGoToStop
AnimActionLeaveHome
AnimActionLookAround
AnimActionPlayRandomAnimation
AnimActionPlayRandomBasicAnimation
AnimActionPlayRandomCloseRange
AnimActionPlayRandomGoodbye
AnimActionPlayRandomGreeting
AnimActionPlayRandomImmobile
AnimActionPlayRandomInteractAnimation
AnimActionPlayRandomMobile
AnimActionPlayRandomTalkAnimation
AnimActionPlayRandomUncivilized
AnimActionRandomMoveAway
AnimActionRest
AnimActionShakeHead
AnimActionSitInChair
AnimActionStartInteracting
AnimActionStartTalking
AnimActionStopInteracting
AnimActionStopTalking
AnimActionTurnAround
AnimDebug
AnimInitialization
BashDoorCheck
bkAcquireTarget
bkEquipAppropriateWeapons
bkEquipMelee
bkEquipRanged
bkEvaluationSanityCheck
bkSetupBehavior
bkTalentFilter
CheckCurrentAction
CheckCurrentModes
CheckEnemyGroupingOnTarget
CheckFriendlyFireOnTarget
CheckIsAnimActive
CheckIsCivilized
CheckIsUnlocked
CheckWayPoints
ChooseNewTarget
chooseTactics
ClearActions
CompareLastSpellCast
CountEnemiesAndAllies
CreateSignPostNPC
DebugPrintTalentID
DetermineClassToUse
DetermineCombatRound
DetermineEnemies
DetermineSpecialBehavior
DoMathPosition
DubugPrintTalentID
EquipAppropriateWeapons
FindSingleRangedTarget
GenerateNewLocal
genericAttemptHarmfulRanged
genericDoHarmfulRangedAttack
GetAheadLeftLocation
GetAheadLocation
GetAheadRightLocation
GetAngleBetweenLocations
GetAnimationCondition
GetAssociateHealMaster
GetAssociateStartLocation
GetAssociateState
GetBehindLocation
GetBehaviorState
GetChangedPosition
GetChangeInX
GetChangeInY
GetCharacterLevel
GetCreatureHomeWaypoint
GetCombatCondition
GetCombatDifficulty
GetCreatureTalent
GetCRMax
GetCurrentFriend
GetCurrentInteractionTarget
GetCurrentNegativeConditions
GetCustomLeftDirection
GetCustomRightDirection
GetFarLeftDirection
GetFarRightDirection
GetFlankingLeftLocation
GetFlankingRightLocation
GetFleeToExit
GetFollowDistance
GetForwardFlankingLeftLocation
GetForwardFlankingRightLocation
GetHalfLeftDirection
GetHalfRightDirection
GetHasEffect
GetHasNegativeCondition
GetIsBusyWithAnimation
GetIsFighting
GetIsMeleeAttacker
GetIsPostOrWalking
GetIsRangedAttacker
GetIsWieldingRanged
GetLastGenericSpellCast
GetLeftDirection
GetLockedObject
GetMatchCompatibility
GetModeActive
GetMostDangerousClass
GetNearestEnemy
GetNearestPerceivedEnemy
GetNearestSeenFriend
GetNearestSeenEnemy
GetNearestSeenOrHeardEnemy
GetNearestWalkWayPoint
GetNextWalkWayPoint
GetNPCWarningStatus
GetNumberOfMeleeAttackers
GetNumberOfRangedAttackers
GetOppositeDirection
GetOppositeLocation
GetPercentageHPLoss
GetRacialTypeCount
GetRandomFriend
GetRandomLocation
GetRandomObjectByTag
GetRandomObjectByType
GetRandomStop
GetRightDirection
GetSpawnInCondition
GetStepLeftLocation
GetStepRightLocation
GetWalkCondition
GetWaypointSuffix
InvisibleTrue
IsOutOfAmmo
LocationToString
LookUpWalkWayPoints
MatchAreaOfEffectSpell
MatchCombatProtections
MatchCrossbow
MatchDoIHaveAMindAffectingSpellOnMe
MatchDoubleHandedWeapon
MatchElementalProtections
MatchInflictTouchAttack
MatchMeleeWeapon
MatchMindAffectingSpells
MatchNonliving
MatchNormalBow
MatchPersonSpells
MatchShield
MatchSingleHandedWeapon
MatchSpellProtections
MoveToNewLocation
MyPrintString
newdebug
PlayImmobileAmbientAnimations
PlayMobileAmbientAnimations
PlayMobileAmbientAnimations_Avian
PlayMobileAmbientAnimations_NonAvian
RemoveAmbientSleep
ResetHenchmenState
RespondToShout
SetAnimationCondition
SetAssociateStartLocation
SetAssociateState
SetBehaviorState
SetCombatCondition
SetCreatureHomeWaypoint
SetCurrentFriend
SetCurrentInteractionTarget
SetLastGenericSpellCast
SetListeningPatterns
SetModeActive
SetNPCWarningStatus
SetSpawnInCondition
SetSpawnInLocals
SetSummonHelpIfAttacked
SetWalkCondition
SpecialTactics
SpecialTacticsAmbusher
SpecialTacticsCowardly
SpecialTacticsDefensive
SpecialTacticsRanged
StartProtectionLoop
TalentAdvancedBuff
TalentAdvancedProtectSelf
TalentBackOff
TalentBardSong
TalentBuffSelf
TalentCureCondition
TalentDragonCombat
TalentEnhanceOthers
TalentFlee
TalentHeal
TalentHealingSelf
TalentMeleeAttack
TalentMeleeAttacked
TalentPersistentAbilities
TalentRangedAttackers
TalentRangedEnemies
TalentSeeInvisible
TalentSelfProtectionMantleOrGlobe
TalentSneakAttack
TalentSpellAttack
TalentSummonAllies
TalentUseEnhancementOnSelf
TalentUseProtectionOnSelf
TalentUseProtectionOthers
TalentUseTurning
TrySpell
TrySpellForEffect
TryTalent
TurnToFaceObject
UseDetectMode
UseStealthMode
VectorToString
VerifyCombatMeleeTalent
VerifyDisarm
VoiceBadIdea
VoiceCanDo
VoiceCannotDo
VoiceCuss
VoiceFlee
VoiceGoodbye
VoiceHealMe
VoiceHello
VoiceLaugh
VoiceLookHere
VoiceNearDeath
VoiceNo
VoicePicklock
VoicePoisoned
VoiceStop
VoiceTaskComplete
VoiceThreaten
VoiceYes
WalkWayPoints
WiseToDualWield
WrapperActionAttack