x2_inc_globals

Many of the functions in this library are specific to the Official Campaign, but it does contain some useful generic database wrappers.

NOTE: This file includes x0_i0_henchman.

Constants

NameValueBrief Description
DB_NAMEXP2

Functions

NameBrief Description
CallForthHenchmanCall this function as a wrapper for retrieving a henchman from hell the henchmen should have been loaded in.
ClearDatabaseThis function is specific to the Official Campaign. It calls DestroyCampaignDatabase for "XP2_TEMP".
CopyAllHenchmenStores all of a player's henchmen objects to the campaign database.
CopyInventoryInternal function. Copies everything from oSource's inventory into oTarget's.

Can be used with either Creatures or Stores.

Does not destroy original.
CopyOriginalFourInventoryInternal function. This function is specific to the Official Campaign.

Copies the original 4 henchmen inventories into the Pool of Lost Souls.
CopyVariableIntToDatabaseCopies the specified local integer variable from the module into the campaign database.
GetGlobalIntWrapper function for GetLocalInt.

Returns an integer variable that is set on the module.
GetGlobalStringWrapper function for GetLocalString.

Returns a string variable that is set on the module.
PCBetrayedNathyrraInternal function. This function is specific to the Official Campaign.

Returns whether player betrayed Nathyrra.
PCBetrayedValenInternal function. This function is specific to the Official Campaign.

Returns whether player betrayed Valen.
RemoveInventoryInternal function. This function is specific to the Official Campaign.

Used at start of c2 and c3 to "blank" the genie store.
RestoreAllHenchmenRestore henchmen. This function should be called after all other database fetches because it destroys the database.
RestoreHenchmenVariablesThis function is specific to the Official Campaign.

Restores all important variables that the henchmen may have on them from db.
RestoreIntInternal function. Wrapper function for SetLocalInt.

Sets a local integer variable on the module from the campaign database.
RestoreIntFromObjectWrapper function for SetLocalInt.

Sets a local integer variable on an object, gained from the campaign database.
RestorePoolOfLostSoulsInternal function. This function is specific to the Official Campaign.

Copies the Pool of Lost Souls into the place of the existing one in the module.
RestoreStringInternal function. Wrapper function for SetLocalString.

Sets a local string variable on the module from the campaign database.
RestoreWeaponIntInternal function. Retrieves a campaign integer and saves it to the module as a local integer.
RestoreWeaponVarsInternal function. This function is specific to the Official Campaign.

Restores weapon variables.
ReturnToChapter2Internal function. This function is specific to the Official Campaign.
SetGlobalIntWrapper function for SetLocalInt.

Sets an integer variable on the module.
SetGlobalStringWrapper function for SetLocalString.

Sets a string variable on the module.
StoreHenchmenVariablesInternal function. This function is specific to the Official Campaign.

Stores all important variables that the henchmen may have on them into the database.
StoreIntInternal function. Wrapper function for SetCampaignInt.

Sets a campaign integer variable gained from the module.
StoreIntFromObjectInternal function. Wrapper function for SetCampaignInt.

Sets a campaign integer variable gained from an object.
StorePoolOfLostSoulsInternal function. This function is specific to the Official Campaign.

Copies the Pool of Lost Souls.
StoreStringInternal function. Wrapper function for SetCampaignString.

Sets a campaign string variable gained from the module.
StoreWeaponIntInternal function. Wrapper function for StoreInt.
StoreWeaponVarsInternal function. This function is specific to the Official Campaign.

Stores the variables for the intelligent weapon.
WrapCopyItemInternal function. Wrapper function for CopyItem with checks for GetPlotFlag and GetItemCursedFlag.

See Also

categories:  Database Functions

  author: Mistress, contributor: Graewerld