NPC – character functions¶

zDExt_Npc_GetRoutineFuncName¶

Gets the function name of the NPC's current routine (e.g. RTN_PRESTART_100).

1

func string zDExt_Npc_GetRoutineFuncName(var C_NPC npc) {};

• npc – instance of the NPC
• return – function name of the NPC's current routine; empty if the NPC is invalid or the routine does not start with RTN_

1
2
3
4

if (Hlp_StrCmp(zDExt_Npc_GetRoutineFuncName(self), "RTN_PreStart_100"))
{
    //...
};

zDExt_Npc_GetRoutineName¶

Gets the name of the NPC's current routine (e.g. PRESTART).

1

func string zDExt_Npc_GetRoutineName(var C_NPC npc) {};

• npc – instance of the NPC
• return – name of the NPC's current routine

1
2
3
4

if (Hlp_StrCmp(zDExt_Npc_GetRoutineName(self), "PreStart"))
{
    //...
};

zDExt_Npc_EquipItem¶

Equips or unequips an existing item on the NPC through the engine equip operation. It does not create an item.

1

func void zDExt_Npc_EquipItem(var C_NPC npc, var int itemInstance) {};

• npc – instance of the NPC
• itemInstance – instance name of the item

1

zDExt_Npc_EquipItem(self, ItLsTorch);

zDExt_Npc_GetWalkMode¶

Gets the current walk mode of the NPC.

• -1 - invalid
• 0 / NPC_RUN - run
• 1 / NPC_WALK - walk
• 2 / NPC_SNEAK - sneak
• 3 - in water
• 4 - swim
• 5 - dive

1

func int zDExt_Npc_GetWalkMode(var C_NPC npc) {};

• npc – instance of the NPC
• return – walk mode

1
2
3
4

if (zDExt_Npc_GetWalkMode(self) == NPC_SNEAK)
{
    //...
};

zDExt_Npc_IsStanding¶

Checks if the NPC is currently standing still.

1

func int zDExt_Npc_IsStanding(var C_NPC npc) {};

• npc – instance of the NPC
• return – TRUE if NPC is standing, FALSE otherwise

1
2
3
4

if (zDExt_Npc_IsStanding(self))
{
    //...
};

zDExt_Npc_IsWalking¶

Checks if the NPC is currently walking.

1

func int zDExt_Npc_IsWalking(var C_NPC npc) {};

• npc – instance of the NPC
• return – TRUE if NPC is walking, FALSE otherwise

1
2
3
4

if (zDExt_Npc_IsWalking(self))
{
    //...
};

zDExt_Npc_HasOverlayMds¶

Checks if the NPC has the specified animation overlay active.

1

func int zDExt_Npc_HasOverlayMds(var C_NPC npc, var string overlay) {};

• npc – instance of the NPC
• return – TRUE if NPC has overlay with specified name, FALSE otherwise

1
2
3
4

if (zDExt_Npc_HasOverlayMds(self, "Humans_Tired.mds"))
{
    //...
};

zDExt_Npc_HasTimedOverlayMds¶

Checks if the NPC has the specified timed animation overlay active.

1

func int zDExt_Npc_HasTimedOverlayMds(var C_NPC npc, var string overlay) {};

• npc – instance of the NPC
• return – TRUE if NPC has overlay with specified name, FALSE otherwise

1
2
3
4

if (zDExt_Npc_HasTimedOverlayMds(self, "Humans_Sprint.mds"))
{
    //...
};

zDExt_Npc_OpenDeadNpcInventory¶

Opens NPC's plunder inventory.

1

func void zDExt_Npc_OpenDeadNpcInventory(var C_NPC npc) {};

• npc – instance of the NPC

1

zDExt_Npc_OpenDeadNpcInventory(self);

zDExt_Npc_CloseInventory¶

Closes NPC's main inventory.

1

func void zDExt_Npc_CloseInventory(var C_NPC npc) {};

• npc – instance of the NPC

1

zDExt_Npc_CloseInventory(self);

zDExt_Npc_CloseInventorySteal¶

Closes the steal inventory of npc's focus NPC.

1

func void zDExt_Npc_CloseInventorySteal(var C_NPC npc) {};

• npc – instance of the NPC

1

zDExt_Npc_CloseInventorySteal(self);

zDExt_Npc_CloseDeadNpcInventory¶

Closes NPC's plunder inventory.

1

func void zDExt_Npc_CloseDeadNpcInventory(var C_NPC npc) {};

• npc – instance of the NPC

1

zDExt_Npc_CloseDeadNpcInventory(self);

zDExt_Npc_GetDistToPos¶

Gets the distance between the NPC and a world position using the engine distance calculation (in cm).

1

func int zDExt_Npc_GetDistToPos(var C_NPC npc, var float posX, var float posY, var float posZ) {};

• npc – instance of the NPC
• posX – X coordinate in the game world
• posY – Y coordinate in the game world
• posZ – Z coordinate in the game world
• return – distance in cm, truncated to an integer; 2147483647 for an invalid NPC

1
2
3
4

if (zDExt_Npc_GetDistToPos(hero, 16795.0, 23120.0, 1400.0) <= 500)
{
    //...
};

zDExt_Npc_GetDistToVob¶

Gets the distance between the NPC and an vob (in cm).

1

func int zDExt_Npc_GetDistToVob(var C_NPC npc, var string vobName) {};

• npc – instance of the NPC
• vobName – name of vob in game world
• return – distance between NPC and vob in cm, truncated to an integer; 2147483647 if either object is invalid

1
2
3
4

if (zDExt_Npc_GetDistToVob(hero, "CHEST_LOBART") <= 500)
{
    //...
};

zDExt_Npc_GetVisualBody¶

Gets the name of the NPC's visual body.

1

func string zDExt_Npc_GetVisualBody(var C_NPC npc) {};

• npc – instance of the NPC
• return – name of the NPC's visual body (for example HUM_BODY_NAKED0)

1
2
3
4
5
6

var string body; body = zDExt_Npc_GetVisualBody(hero);

if (Hlp_StrCmp(body, "HUM_BODY_NAKED0"))
{
    //...
};

zDExt_Npc_GetVisualHead¶

Gets the name of the NPC's visual head.

1

func string zDExt_Npc_GetVisualHead(var C_NPC npc) {};

• npc – instance of the NPC
• return – name of the NPC's visual head (for example HUM_HEAD_PONY)

1
2
3
4
5
6

var string head; head = zDExt_Npc_GetVisualHead(hero);

if (Hlp_StrCmp(head, "HUM_HEAD_PONY"))
{
    //...
};

zDExt_Npc_GetPortalRoom¶

Gets the name of the portal room in which the NPC is currently located.

1

func string zDExt_Npc_GetPortalRoom(var C_NPC npc) {};

• npc – instance of the NPC
• return – name of the portal room, or an empty string if the NPC is invalid or outside a portal room

1
2
3
4
5
6

var string room; room = zDExt_Npc_GetPortalRoom(hero);

if (Hlp_StrCmp(room, ""))
{
    //...
};

zDExt_Npc_Teleport¶

Teleports the NPC to the specified location without an AI queue.

1

func void zDExt_Npc_Teleport(var C_NPC npc, var string point) {};

• npc – instance of the NPC
• point – name of the waypoint, freepoint or any vob in the game world

1

zDExt_Npc_Teleport(hero, "START");

zDExt_Npc_OpenInventorySteal¶

Opens the steal inventory of the NPC currently focused by npc.

1

func void zDExt_Npc_OpenInventorySteal(var C_NPC npc) {};

• npc – NPC opening the steal inventory

1

zDExt_Npc_OpenInventorySteal(hero);

zDExt_Npc_SetAsPlayer¶

Makes the specified NPC the player character.

1

func void zDExt_Npc_SetAsPlayer(var C_NPC npc) {};

• npc – NPC to set as the player character

1

zDExt_Npc_SetAsPlayer(hero);

zDExt_Npc_TakeItem¶

Makes the NPC take the specified item vob directly, without adding an AI action to its queue.

1

func void zDExt_Npc_TakeItem(var C_NPC npc, var C_Item item) {};

• npc – NPC taking the item
• item – reference to an existing item vob, not its instance ID

1
2
3

var C_Item item;
item = zDExt_Hlp_GetItem(ItLsTorch);
zDExt_Npc_TakeItem(hero, item);

zDExt_Npc_DropItem¶

Makes the NPC drop the specified item vob directly, without adding an AI action to its queue.

1

func void zDExt_Npc_DropItem(var C_NPC npc, var C_Item item) {};

• npc – NPC dropping the item
• item – reference to an existing item belonging to the NPC

1
2
3

var C_Item item;
item = zDExt_Hlp_GetItem(ItLsTorch);
zDExt_Npc_DropItem(hero, item);

zDExt_Npc_EquipArmor¶

Passes the existing armor item to the engine armor equip operation. It does not create an item.

1

func void zDExt_Npc_EquipArmor(var C_NPC npc, var int itemInstance) {};

• npc – NPC equipping the armor
• itemInstance – instance ID of an existing armor item

1

zDExt_Npc_EquipArmor(hero, ITAR_MIL_L);

zDExt_Npc_UnequipArmor¶

Toggles the currently equipped armor through the engine armor equip operation. The second argument is required and must be nonzero; it does not select which armor is removed.

1

func void zDExt_Npc_UnequipArmor(var C_NPC npc, var int itemInstance) {};

• npc – NPC whose equipped armor is removed
• itemInstance – nonzero argument required by the current implementation

1

zDExt_Npc_UnequipArmor(hero, ITAR_MIL_L);