Function Categories
Function categories group functions by their association to other functions. Some functions may appear in more than one category.
| Name | Description |
|---|---|
| Action on Object (105) | Functions used to perform specific actions upon a certain object. |
| Alignment (12) | Functions that deal with alignment. |
| Animation (2) | Animations performed by NPCs when placed within one of NPCs script event handlers. |
| Area (56) | Functions used to deal with areas. |
| Combat (27) | Combat related functions |
| Combat Actions (24) | Combat action related functions. |
| Combat Information (27) | Combat information related functions. |
| Conversation (26) | Functions that deal with conversations. |
| Core AI (65) | Functions that deal with the core artificial intelligence engine |
| Core AI Talent (23) | Functions that deal with the core AI talents |
| Cut-Scene (16) | Functions useful for creating a cut-scene; that is, a scene where events unfold as the person playing their character watches. |
| Database (22) | Database retrieval and storage for persistant campaigns. |
| Debug (22) | Functions used to debug and test. |
| Effects (114) | Functions that deal with various effects. |
| Encounter (12) | Functions used to deal with encounters. |
| Experience (11) | Functions that deal with experience. |
| Function (0) | A routine that performs an action or returns a value, or does both. |
| Get Data (52) | A function that returns a value. |
| Get Data from Creature (117) | A function that returns data from a creature. |
| Get Data from Object (78) | A function that returns data from an object. |
| Henchmen/Familiars/Summoned (73) | Functions used to deal with NPC henchmen, familiars, or summoned creatures. |
| Horse (32) | Functions that deal with horses. |
| Inventory (62) | Functions that deal with a character's inventory. |
| Item Creation (212) | Functions used to deal with item creation. The itemproperty commands are special constructors - they construct an itemproperty "object" which can then be, for instance, applied to an item using the AddItemProperty command. Much like effects need to be first constructed, then applied with ApplyEffectToObject. It will often be a good idea to remove similar itemproperties from the item first. There's a command in the "x2_inc_itemprop" include file called IPSafeAddItemProperty which will do that for you. |
| Item Properties (32) | Item property subsystem. |
| Journal (3) | Functions that deal with the in-game journal. |
| Lighting Effects (11) | Lighting Effect related functions. |
| Local Variables (43) | Functions used to deal with local variables. |
| Math (32) | Math functions. |
| Miscellaneous (71) | Functions that don't fit into any other category. |
| Module (25) | Functions used to deal with modules. |
| Module Specific (96) | Functions found in #include files that are specific to a certain module and would not be of much use outside of that module. |
| Money (17) | Functions that deal with money. |
| Movement (58) | Movement related functions. |
| Music Effects (13) | Music Effect related functions. |
| Party (45) | Functions that deal with parties. |
| PC Only (44) | Functions that affect a PC only. |
| Perception (14) | Functions that deal with perception. |
| Private Functions (13) | These functions are found in scripts used within official BioWare modules. The scripts also contain a void main() which makes the script an invalid candidate for the #include compiler directive. They are provided here for the usefulness one may find by locating the script (located in the Scripts.bif archive file) and copying the function out into a local script. |
| Prototyped but Unused (19) | These functions are prototyped but not actually declared or used by BioWare. |
| Reputation/Faction (44) | Functions that deal with reputation or faction. |
| Saving Throw (13) | Functions used to deal with saving throws. |
| Server (7) | Functions that deal with the host server. |
| Sound Effects (18) | Sound Effect related functions. |
| Spell Casting Effects (26) | Spell Casting Effect related functions. |
| Spells (58) | Functions that deal with spells. |
| Stores (10) | Functions that deal with stores. |
| String (20) | Functions that deal with string manipulation. |
| Talents/Skills/Feats (45) | Functions used to deal with talents, skills, and feats. |
| Targeting (22) | Functions that deal with targeting. |
| Time (20) | Functions that deal with time. |
| Traps (33) | Functions that deal with traps. |
| Type Casting/Conversion (15) | Functions that convert one variable type to another variable type. |
| Visual Effects (20) | Visual Effect related functions. |
author: NWN Lexicon Group, editor: Mistress