HLP - help functions

Hlp_GetInstanceID

Returns the internal ID of an instance, usefull for comparison

1

func int Hlp_GetInstanceID(var instance inst)  {};

Parameters

• var instance inst - any instance

Return value
The function returns internal ID of the instance

Hlp_GetNpc

Finds an NPC object by its instance name

1

func C_NPC Hlp_GetNpc(var int instancename)  {};

Parameters

• var int instancename - instance name of the NPC

Return value
The function returns link to NPC object

Hlp_IsItem

Checks if item object is a specified instance

1

func int Hlp_IsItem(var C_ITEM itm, var int instancename)  {};

Parameters

• var C_ITEM itm - C_ITEM instance of the item
• var int instancename - instance name of the item

Return value
The function returns TRUE if the item is the specified instance, FALSE otherwise

Hlp_IsValidItem

Checks if item is in the game world

1

func int Hlp_IsValidItem(var C_ITEM itm)  {};

Parameters

• var C_ITEM itm - instance of the item

Return value
The function returns TRUE if the item is in the game world, FALSE otherwise

Hlp_IsValidNpc

Checks if the NPC exists in the game world

1

func int Hlp_IsValidNpc(var C_NPC npc)  {};

Parameters

• var C_NPC npc - instance of the NPC

Return value
The function returns TRUE if the NPC exists, FALSE otherwise

Hlp_Random

Generates a random value

1

func int Hlp_Random(var int bound)  {};

Parameters

• var int bound - maximum value

Return value
The function returns random value form 0 to bound

Hlp_StrCmp

Compares two strings (not case-sensitive)

1

func int Hlp_StrCmp(var string s1, var string s2)  {};

Parameters

• var string s1 - first string
• var string s2 - second string

Return value
The function returns TRUE if the strings are equal, FALSE otherwise

Hlp_CutscenePlayed

Relic of the cutscene system

1

func int Hlp_CutscenePlayed(var string csname)