NPC – character functions¶

zDExt_Npc_GetRoutineFuncName¶

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

func string zDExt_Npc_GetRoutineFuncName(var C_NPC npc) {};

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

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).

func string zDExt_Npc_GetRoutineName(var C_NPC npc) {};

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

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

zDExt_Npc_EquipItem¶

Equips or unequips the specified item on the NPC.

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

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

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

func int zDExt_Npc_GetWalkMode(var C_NPC npc) {};

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

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

zDExt_Npc_IsStanding¶

Checks if the NPC is currently standing still.

func int zDExt_Npc_IsStanding(var C_NPC npc) {};

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

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

zDExt_Npc_IsWalking¶

Checks if the NPC is currently walking.

func int zDExt_Npc_IsWalking(var C_NPC npc) {};

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

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

zDExt_Npc_HasOverlayMds¶

Checks if the NPC has the specified animation overlay active.

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

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

zDExt_Npc_HasTimedOverlayMds¶

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

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

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

zDExt_Npc_OpenDeadNpcInventory¶

Opens NPC's plunder inventory.

func void zDExt_Npc_OpenDeadNpcInventory(var C_NPC npc) {};

• npc – instance of the NPC

zDExt_Npc_OpenDeadNpcInventory(self);

zDExt_Npc_CloseInventory¶

Closes NPC's main inventory.

func void zDExt_Npc_CloseInventory(var C_NPC npc) {};

• npc – instance of the NPC

zDExt_Npc_CloseInventory(self);

zDExt_Npc_CloseInventorySteal¶

Closes the steal inventory of npc's focus NPC.

func void zDExt_Npc_CloseInventorySteal(var C_NPC npc) {};

• npc – instance of the NPC

zDExt_Npc_CloseInventorySteal(self);

zDExt_Npc_CloseDeadNpcInventory¶

Closes NPC's plunder inventory.

func void zDExt_Npc_CloseDeadNpcInventory(var C_NPC npc) {};

• npc – instance of the NPC

zDExt_Npc_CloseDeadNpcInventory(self);

zDExt_Npc_GetDistToPos¶

Gets the distance between the NPC and a given position in the world (in cm).

func int zDExt_Npc_GetDistToPos(var C_NPC npc, var int posX, var int posY, var int 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 between npc and the specified position (in cm)

if (zDExt_Npc_GetDistToPos(hero, 16795, 23120, 1400) <= 500)
{
    //...
};

zDExt_Npc_GetDistToVob¶

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

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

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

zDExt_Npc_GetVisualBody¶

Gets the name of the NPC's visual body.

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)

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.

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)

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.

func string zDExt_Npc_GetPortalRoom(var C_NPC npc) {};

• npc – instance of the NPC
• return – name of the portal room

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.

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

zDExt_Npc_Teleport(hero, "START");