Přeskočit obsah

C_NPC Daedalus class

Class C_NPC describes the character and monsters1. The playable character is also an NPC.

Tip

You can call externals inside the instance of C_NPC class e.g. to give an item or customize look of the NPC.

1
2
3
4
5
6
instance PC_HERO (C_NPC)
{
    // ...
    CreateInvItems (self, ItFo_Wine, 10);
    // ...
};

Definition

C_NPC class definition differs between Gothic 1 and Gothic 2 Addon.

Class definition as it is defined in Scripts/Content/_intern/Classes.d script file.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
class C_Npc 
{
    var int    id;                             // NPC id
    var string name[5];                        // NPC name
    var string slot;                           // Slot (deprecated)
    var int    npcType;                        // NPC type
    var int    flags;                          // NPC flags
    var int    attribute[8];                   // Attribute values
    var int    protection[8];                  // Protection values
    var int    damage[8];                      // Damage values
    var int    damagetype;                     // Type of damage
    var int    guild;                          // NPC guild
    var int    level;                          // NPC level
    var func   mission[5];                     // Missions (deprecated)
    var int    fight_tactic;                   // NPC fight tactic
    var int    weapon;                         // Current comabt mode
    var int    voice;                          // SVM voice assigned to the NPC
    var int    voicePitch;                     // Pitch of the voice
    var int    bodymass;                       // Body mass (deprecated)

    // Routine  
    var func   daily_routine;                  // Starting daily routine of the NPC
    var func   start_aistate;                  // Starting AI state of the NPC

    // Respawn
    var string spawnPoint;                     // Spawn point (deprecated)
    var int    spawnDelay;                     // Spawn delay (deprecated)

    // Senses
    var int    senses;                         // NPC senses
    var int    senses_range;                   // NPC senses range

    // AI
    var int    aivar[50];                      // AI variables
    var string wp;                             // Currently tracked waypoint

    // Experience
    var int    exp;                            // Experience points
    var int    exp_next;                       // Experience points needed for the next level
    var int    lp;                             // Learning points
};

Class definition as it is defined in Scripts/Content/_intern/Classes.d script file.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
class C_Npc 
{
    var int    id;                             // NPC id
    var string name[5];                        // NPC name
    var string slot;                           // Slot (deprecated)
    var string effect;                         // Visual effect
    var int    npcType;                        // NPC type
    var int    flags;                          // NPC flags
    var int    attribute[8];                   // Attribute values
    var int    hitChance[5];                   // Fight skill values
    var int    protection[8];                  // Protection values
    var int    damage[8];                      // Damage values
    var int    damagetype;                     // Type of damage
    var int    guild;                          // NPC guild
    var int    level;                          // NPC level
    var func   mission[5];                     // Missions (deprecated)
    var int    fight_tactic;                   // NPC fight tactic
    var int    weapon;                         // Current comabt mode
    var int    voice;                          // SVM voice assigned to the NPC
    var int    voicePitch;                     // Pitch of the voice
    var int    bodymass;                       // Body mass (deprecated)

    // Routine  
    var func   daily_routine;                  // Starting daily routine of the NPC
    var func   start_aistate;                  // Starting AI state of the NPC

    // Respawn
    var string spawnPoint;                     // Spawn point (deprecated)
    var int    spawnDelay;                     // Spawn delay (deprecated)

    // Senses
    var int    senses;                         // NPC senses
    var int    senses_range;                   // NPC senses range

    // AI
    var int    aivar[100];                     // AI variables
    var string wp;                             // Currently tracked waypoint

    // Experience
    var int    exp;                            // Experience points
    var int    exp_next;                       // Experience points needed for the next level
    var int    lp;                             // Learning points

    var int    bodyStateinterruptableOverride; // Possibility to interrupt the current body state
    var int    noFocus;                        // Disable focus on the NPC
};

Members

int id

Unique identification number used for human NPCs.

string name

Name of the NPC. Only the first name from array is used.

string slot

Deprecated setting

Slot.

string effect

VFX visual effect aplied to the NPC. The effect must be defined as CFx_Base instance.

Warning

This property is only available in Gothic 2 Addon.

int npcType

Type of NPC.

NPC type constants are defined in Scripts/Content/AI/AI_Intern/AI_Constants.d file.

1
2
3
4
5
6
7
8
9
const int NPCTYPE_AMBIENT       = 0; // Ambient NPC
const int NPCTYPE_MAIN          = 1; // Main NPC
const int NPCTYPE_GUARD         = 2; // Guard NPC
const int NPCTYPE_FRIEND        = 3; // Friend
const int NPCTYPE_MINE_AMBIENT  = 4; // Ambient NPC in mines
const int NPCTYPE_MINE_GUARD    = 5; // Guard NPC in mines
const int NPCTYPE_OW_AMBIENT    = 6; 
const int NPCTYPE_OW_GUARD      = 7;
const int NPCTYPE_ROGUE         = 8; // Rogue/Bandit

NPC type constants are defined in Scripts/Content/AI/AI_Intern/AI_Constants.d file.

1
2
3
4
5
6
7
8
const int NPCTYPE_AMBIENT       = 0; // Ambient NPC
const int NPCTYPE_MAIN          = 1; // Main NPC
const int NPCTYPE_FRIEND        = 2; // Friend
const int NPCTYPE_OCAMBIENT     = 3; // Ambient NPC in Valley of Mines
const int NPCTYPE_OCMAIN        = 4; // Main NPC in Valley of Mines
const int NPCTYPE_BL_AMBIENT    = 5; // Ambient NPC in Bandit Camp
const int NPCTYPE_TAL_AMBIENT   = 6;
const int NPCTYPE_BL_MAIN       = 7; // Main NPC in Bandit Camp

int flags

NPC flags.

NPC flag constants are defined in Scripts/Content/_intern/Constants.d file.

1
2
CONST INT NPC_FLAG_FRIEND   =  1 << 0;  // Friend (not used)
CONST INT NPC_FLAG_IMMORTAL =  1 << 1;  // Immmortal

NPC flag constants are defined in Scripts/Content/_intern/Constants.d file.

1
2
3
CONST INT NPC_FLAG_FRIEND   =  1 << 0;  // Friend (not used)
CONST INT NPC_FLAG_IMMORTAL =  1 << 1;  // Immmortal
CONST INT NPC_FLAG_GHOST    =  1 << 2;  // Ghost effect

int attribute

Array of NPC attribute values.

Attribute constants are defined in Scripts/Content/_intern/Constants.d file.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
const int ATR_HITPOINTS             =  0;   // Hitpoints
const int ATR_HITPOINTS_MAX         =  1;   // Maximum Hitpoints
const int ATR_MANA                  =  2;   // Mana
const int ATR_MANA_MAX              =  3;   // Maximum Mana

const int ATR_STRENGTH              =  4;   // Strength
const int ATR_DEXTERITY             =  5;   // Dexterity
const int ATR_REGENERATEHP          =  6;   // Health regeneration (deprecated)
const int ATR_REGENERATEMANA        =  7;   // Mana regeneration (deprecated)

const int ATR_INDEX_MAX             =  8;

Note

Some attributes are associated with C_MENU_ITEM predefined instances.

Attribute Menu item instance
ATR_STRENGTH MENU_ITEM_ATTRIBUTE_1
ATR_DEXTERITY MENU_ITEM_ATTRIBUTE_2
ATR_MANA MENU_ITEM_ATTRIBUTE_3
ATR_HITPOINTS MENU_ITEM_ATTRIBUTE_4

int hitChance

Array of NPC skill for fighting with different types of weapons.

NPC talents constants are defined in Scripts/Content/_intern/Constants.d file.

1
2
3
4
const int NPC_TALENT_1H                 = 1; // One-handed weapons
const int NPC_TALENT_2H                 = 2; // Two-handed weapons
const int NPC_TALENT_BOW                = 3; // Bows
const int NPC_TALENT_CROSSBOW           = 4; // Crossbows

Warning

This property is only available in Gothic 2 Addon.

int protection

Array of NPC protection values against different types of damage.

Protection constants are defined in Scripts/Content/_intern/Constants.d file.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
CONST INT PROT_BARRIER      = DAM_INDEX_BARRIER; // Protection form magic barrier
CONST INT PROT_BLUNT        = DAM_INDEX_BLUNT;   // Protection from blunt weapons (hammers, maces)
CONST INT PROT_EDGE         = DAM_INDEX_EDGE;    // Protection from edged weapons (swords, axes, rapiers)
CONST INT PROT_FIRE         = DAM_INDEX_FIRE;    // Protection from fire
CONST INT PROT_FLY          = DAM_INDEX_FLY;     // Protection from knockback
CONST INT PROT_MAGIC        = DAM_INDEX_MAGIC;   // Protection from magic
CONST INT PROT_POINT        = DAM_INDEX_POINT;   // Protection from point damage (bows, crossbows)
CONST INT PROT_FALL         = DAM_INDEX_FALL;    // Protection from fall damage

CONST INT PROT_INDEX_MAX    = DAM_INDEX_MAX;     // Number of protection types

int damage

Array of maximum damage values inflicted by the NPC for different types of damage. Used with damagetype property.

Damage type constants are defined in Scripts/Content/_intern/Constants.d file.

int damagetype

Type of damage inflicted by the NPC. Used with damage property.

Tip

You can combine multiple damage types using the bitwise OR operator |.

Damage type constants are defined in Scripts/Content/_intern/Constants.d file.

int guild

NPC guild. Guilds differ between Gothic 1 and Gothic 2 Addon, but could be devided into two main groups - human and animal.

Guild constants are defined in Scripts/Content/_intern/Constants.d file.

Relations between human guilds are specified in GIL_ATTITUDES array inside the Scripts/Content/Story/Guilds.d file.

Guild constants are defined in Scripts/Content/_intern/Constants.d file.

Relations between human guilds are specified in GIL_ATTITUDES array inside the Scripts/Content/AI/Human/Guilds.d file.

Info

General parameters for each guild are specified inside the instance of the C_GilValues class.

int level

Current level of the NPC.

Logic for hero leveling is implemented in the B_GiveXP function.

Logic for hero leveling is implemented in the B_GivePlayerXP function.

Note

This property is available in menu as MENU_ITEM_LEVEL predefined instance of the C_MENU_ITEM class.

func mission

Deprecated setting

Array of missions assigned to the NPC.

int fight_tactic

NPC fight tactic. Tactics are described by the C_FightAI class instances and each tactic has its own index.

Fight tactic constants are defined in Scripts/Content/AI/AI_Intern/AI_Constants.d file.

Fight tactic constants are defined in Scripts/Content/AI/AI_Intern/AI_Constants.d file.

int weapon

Current combat mode of the NPC. Property is never used in the game scripts but should work with following constants.

1
2
3
4
5
6
7
8
const int WEAPON_NONE   = 0; // Unarmed
const int WEAPON_FIST   = 1; // Fist
const int WEAPON_DAG    = 2; // Dagger
const int WEAPON_1H     = 3; // One-handed weapon
const int WEAPON_2H     = 4; // Two-handed weapon
const int WEAPON_BOW    = 5; // Bow
const int WEAPON_CBOW   = 6; // Crossbow
const int WEAPON_MAGIC  = 7; // Magic

int voice

Voice assigned to the NPC. This is used for C_SVM instances.

For example, if the NPC has voice property set to 1, it will use the SVM_1 instance of the C_SVM class.

1
2
3
4
instance SVM_1(C_SVM)
{
  // ...  
};

int voicePitch

Pitch of the voice. Accepts values from -5 to 5.

Note

When the pitch is lowered, the playback speed is decreased and overlaing may occur.

int bodymass

Deprecated setting

Body mass of the NPC.

func daily_routine

Function defining the starting daily routine of the NPC.

All routine functions start with the Rtn_ prefix and end with NPC id as suffix. For example, the Start routine of the npc with id 1 will be defined like this:

1
2
3
4
func void Rtn_Start_1()
{
    // ...
};

Instide the function body should be TA_ function calls defining the routine actions. It is important to remember that the routine have to contain at least two functions.

1
2
3
4
5
func void Rtn_Start_1()
{
    TA_SmallTalk (07,00,21,00, "OC1");
    TA_SmallTalk (21,00,07,00, "OC1");
};

To Change the daily routine use the Npc_ExchangeRoutine function.

func start_aistate

Function defining the starting AI state of the NPC. Used mainly for monsters and animals that do not have a daily routine.

string spawnPoint

Deprecated setting

Spawn point of the NPC.

int spawnDelay

Deprecated setting

Spawn delay of the NPC.

int senses

Active NPC senses. Used with senses_range property.

Senses constants are defined in Scripts/Content/_intern/Constants.d file.

1
2
3
CONST INT SENSE_SEE     = 1 << 0; // Vision
CONST INT SENSE_HEAR    = 1 << 1; // Hearing
CONST INT SENSE_SMELL   = 1 << 2; // Smell

int senses_range

Range of active NPC senses in cm.

int aivar

Array of NPC AI variables. Used inside the NPC AI scripts.

Array has 50 elements.

Aivar constants are defined in Scripts/Content/AI/AI_Intern/AI_Constants.d file.

Array has 100 elements.

Aivar constants are defined in Scripts/Content/AI/AI_Intern/AI_Constants.d file.

string wp

Currently tracked waypoint. Used with the pathfinding system.

int exp

Current experience points of the NPC.

See level property for more information about leveling.

Note

This property is available in menu as MENU_ITEM_EXP predefined instance of the C_MENU_ITEM class.

int exp_next

Experience points needed for the next level.

See level property for more information about leveling.

Note

This property is available in menu as MENU_ITEM_LEVEL_NEXT predefined instance of the C_MENU_ITEM class.

int lp

Current learning points of the NPC. Optained when the NPC levels up.

See level property for more information about leveling.

Note

This property is available in menu as MENU_ITEM_LEARN predefined instance of the C_MENU_ITEM class.

int bodyStateinterruptableOverride

Possibility to interrupt the current body state.

Warning

This property is only available in Gothic 2 Addon.

int noFocus

Disable focus on the NPC. The NPC will not be highlighted when the player looks at it.

Warning

This property is only available in Gothic 2 Addon.

  1. Heavily inspired by the amazing documentation site Gothic library ↩