Mod Handler

From VCMI Project Wiki
Revision as of 15:57, 5 February 2012 by Warmonger (talk | contribs) (Objects identifiers)
Jump to: navigation, search

Mod handler is a class of modding engine which performs the following tasks:

  • Reads all packages and conversions
  • Manages mods, turning them on and off. List of active mods is stored in a file.
  • Performs consistency checks: if all mod prerequisistes are met, and if mod files are still present.
  • Synchronizes mod files in online game

Objects identifiers

Every game object (creature, artifact, hero, spell) needs to have unique identifier (ID). These IDs are assigned dynamically at game start. Original Shadow of Death objects are considered fixed.

Reference to certain object via script has a form:

[PACKAGE_NAME].[OBJECT_TYPE](localID)

For example, for package Wake of Gods

WOG.creatures(1)

is Supreme Archangel and

WOG.artifacts(3)

is Monster's Power.

Adventure object identifiers

As adventure objects have double identifiers (ID and subID), they have to be threated differently. By default, Mod Handler assigns unique ID to each new adventure object class added and their subID is 0.

There is a script function which allows to add object as a next subID to the existing group with specific ID.