Skip to content

HLP – help functions

Hlp_GetItem

Finds an item object by its instance name.

1
func C_Item Hlp_GetItem(var int itemInstance) {};
  • itemInstance – instance name of the item
  • return – link to item object
Example usage
1
var C_Item torch; torch = Hlp_GetItem(ItLsTorch);

Hlp_IsValidVob

Checks if vob is in the game world.

1
func int Hlp_IsValidVob(var instance object) {};
  • object – any instance
  • return – TRUE or FALSE

Hlp_GetNpcPlunderedByPlayer

Gets the NPC is currently plundered by the player.

1
func C_NPC Hlp_GetNpcPlunderedByPlayer() {};
  • return – instance of the NPC

Hlp_IsOptionExists

Checks whether an options section or a specific option entry exists in a given options level.

1
func int Hlp_IsOptionExists(var string level, var string section, var string option) {};
  • level – options level name (e.g. Gothic level)
  • section – section name inside the options file
  • option – option name; if empty, the function checks for section existence
  • return – TRUE if the section or option exists, FALSE otherwise
Example usage
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
// Check if a section exists
if (Hlp_IsOptionExists("Gothic", "ENGINE", ""))
{
    // Section exists
};

// Check if a specific option exists
if (Hlp_IsOptionExists("Gothic", "ENGINE", "ZMAXFPS"))
{
    // Option exists
};

Hlp_GetOptionIntValue

Reads an integer option value from the specified options level.

1
func int Hlp_GetOptionIntValue(var string level, var string section, var string option, var int defaultValue) {};
  • level – options level name
  • section – section name
  • option – option name
  • defaultValue – value returned when option is missing
  • return – integer value of the option
Example usage
1
var int val; val = Hlp_GetOptionIntValue("Gothic", "ENGINE", "ZMAXFPS", 60);

Hlp_GetOptionFloatValue

Reads a floating-point option value from the specified options level.

1
func float Hlp_GetOptionFloatValue(var string level, var string section, var string option, var float defaultValue) {};
  • level – options level name
  • section – section name
  • option – option name
  • defaultValue – value returned when option is missing
  • return – float value of the option
Example usage
1
var float val; val = Hlp_GetOptionFloatValue("Gothic", "ENGINE", "zWindAngleVelo", 9.0);

Hlp_GetOptionStringValue

Reads a string option value from the specified options level.

1
func string Hlp_GetOptionStringValue(var string level, var string section, var string option, var string defaultValue) {};
  • level – options level name
  • section – section name
  • option – option name
  • defaultValue – value returned when option is missing
  • return – string value of the option
Example usage
1
var string str; str = Hlp_GetOptionStringValue("Gothic", "ZMULTILOGUE", "LoggerLevelUnion", "INFO");

Hlp_SetOptionIntValue

Writes an integer option value to the specified options level.

1
func void Hlp_SetOptionIntValue(var string level, var string section, var string option, var int value) {};
  • level – options level name
  • section – section name
  • option – option name
  • value – integer value to write
Example usage
1
Hlp_SetOptionIntValue("Gothic", "ENGINE", "ZMAXFPS", 60);

Hlp_SetOptionFloatValue

Writes a floating-point option value to the specified options level.

1
func void Hlp_SetOptionFloatValue(var string level, var string section, var string option, var float value) {};
  • level – options level name
  • section – section name
  • option – option name
  • value – float value to write
Example usage
1
Hlp_SetOptionFloatValue("Gothic", "ENGINE", "zWindAngleVelo", 9.0);

Hlp_SetOptionStringValue

Writes a string option value to the specified options level.

1
func void Hlp_SetOptionStringValue(var string level, var string section, var string option, var string value) {};
  • level – options level name
  • section – section name
  • option – option name
  • value – string value to write
Example usage
1
Hlp_SetOptionStringValue("Gothic", "ZMULTILOGUE", "LoggerLevelUnion", "WARN");

Hlp_IsDevModeActive

Returns whether the game is currently running in developer/test mode.

1
func int Hlp_IsDevModeActive() {};
  • return – TRUE if developer/test mode is active, FALSE otherwise
Example usage
1
2
3
4
if (Hlp_IsDevModeActive())
{
    Print("Dev mode active");
};