Skip to content

NPC – character functions

Npc_GetRoutineFuncName

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

1
func string Npc_GetRoutineFuncName(var C_NPC npc) {};
  • npc – instance of the NPC
  • return – function name of the NPC's current routine
Example usage
1
2
3
4
if (Hlp_StrCmp(Npc_GetRoutineFuncName(self), "RTN_PreStart_100"))
{
    //...
};

Npc_GetRoutineName

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

1
func string Npc_GetRoutineName(var C_NPC npc) {};
  • npc – instance of the NPC
  • return – name of the NPC's current routine
Example usage
1
2
3
4
if (Hlp_StrCmp(Npc_GetRoutineName(self), "PreStart"))
{
    //...
};

Npc_EquipItem

Equips or unequips the specified item on the NPC.

1
func void Npc_EquipItem(var C_NPC npc, var int itemInstance) {};
  • npc – instance of the NPC
  • itemInstance – instance name of the item
Example usage
1
Npc_EquipItem(self, ItLsTorch);

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 Npc_GetWalkMode(var C_NPC npc) {};
  • npc – instance of the NPC
  • return – walk mode
Example usage
1
2
3
4
if (Npc_GetWalkMode(self) == NPC_SNEAK)
{
    //...
};

Npc_IsStanding

Checks if the NPC is currently standing still.

1
func int Npc_IsStanding(var C_NPC npc) {};
  • npc – instance of the NPC
  • return – TRUE if NPC is standing, FALSE otherwise
Example usage
1
2
3
4
if (Npc_IsStanding(self))
{
    //...
};

Npc_IsWalking

Checks if the NPC is currently walking.

1
func int Npc_IsWalking(var C_NPC npc) {};
  • npc – instance of the NPC
  • return – TRUE if NPC is walking, FALSE otherwise
Example usage
1
2
3
4
if (Npc_IsWalking(self))
{
    //...
};

Npc_HasOverlayMds

Checks if the NPC has the specified animation overlay active.

1
func int 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
Example usage
1
2
3
4
if (Npc_HasOverlayMds(self, "Humans_Tired.mds"))
{
    //...
};

Npc_HasTimedOverlayMds

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

1
func int 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
Example usage
1
2
3
4
if (Npc_HasTimedOverlayMds(self, "Humans_Sprint.mds"))
{
    //...
};

Npc_OpenDeadNpcInventory

Opens NPC's plunder inventory.

1
func void Npc_OpenDeadNpcInventory(var C_NPC npc) {};
  • npc – instance of the NPC
Example usage
1
Npc_OpenDeadNpcInventory(self);

Npc_CloseInventory

Closes NPC's main inventory.

1
func void Npc_CloseInventory(var C_NPC npc) {};
  • npc – instance of the NPC
Example usage
1
Npc_CloseInventory(self);

Npc_CloseInventorySteal

Closes the steal inventory of npc's focus NPC.

1
func void Npc_CloseInventorySteal(var C_NPC npc) {};
  • npc – instance of the NPC
Example usage
1
Npc_CloseInventorySteal(self);

Npc_CloseDeadNpcInventory

Closes NPC's plunder inventory.

1
func void Npc_CloseDeadNpcInventory(var C_NPC npc) {};
  • npc – instance of the NPC
Example usage
1
Npc_CloseDeadNpcInventory(self);

Npc_GetDistToPos

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

1
func int Vob_GetDistToPos(var string vobName, var C_Position position) {};
  • npc – instance of the NPC
  • position – coordinates (X, Y, Z) in the game world
  • return – distance between NPC and position in cm
Example usage
1
2
3
4
5
6
var C_Position pos; pos = Wld_GetPos(16795, 23120, 1400);

if (Npc_GetDistToPos(hero, pos) <= 500)
{
    //...
};

Npc_GetDistToVob

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

1
func int 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
Example usage
1
2
3
4
if (Npc_GetDistToVob(hero, "CHEST_LOBART") <= 500)
{
    //...
};

Npc_GetVisualBody

Gets the name of the NPC's visual body.

1
func string Npc_GetVisualBody(var C_NPC npc) {};
  • npc – instance of the NPC
  • return – name of the portal room
Example usage
1
2
3
4
5
6
var string body; body = Npc_GetVisualBody(hero);

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

Npc_GetVisualHead

Gets the name of the NPC's visual head.

1
func string Npc_GetVisualHead(var C_NPC npc) {};
  • npc – instance of the NPC
  • return – name of the portal room
Example usage
1
2
3
4
5
6
var string head; head = Npc_GetVisualHead(hero);

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

Npc_GetPortalRoom

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

1
func string Npc_GetPortalRoom(var C_NPC npc) {};
  • npc – instance of the NPC
  • return – name of the portal room
Example usage
1
2
3
4
5
6
var string room; room = Npc_GetPortalRoom(hero);

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

Npc_Teleport

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

1
func void 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
Example usage
1
Npc_Teleport(hero, "START");