npcSettings.inc Functions
 
 

NPC_GetDefaultSettings

Parameters
(settings:=0)
Name Type
settings Optional parameter
Dictionary read in from NPC_GetDefaultSettings()
Explanation
Checks the settings dictionary to make sure required values are set.
* If a dictionary is passed, it will check it for required parameters.
* If they are not present, they will be set.
* Nothing will be overwritten in this function.
Return Values
Returns a dictionary.
 

NPC_LoadScriptSettings

Parameters
(source)
Name Type
source Name of the NPC template to load settings for.
If an NPC reference is used it will also load custom script settings set on it.
Explanation
Loads brain AI script settings for an NPC. Gives .script and .flag values for them.
Uses AIScript and AIScriptFlag entries.
Return Values
Returns a dictionary.
 

NPC_LoadTemplateSettings

Parameters
(source)
Name Type
source Name of the npc template to load settings for.
If an NPC reference is used it will also load custom script settings set on it.
Explanation
Loads script settings for a template from the appropriate npcdesc.cfg.
Uses AISetting lines.
Return Values
Returns a dictionary.