DeleteCampaignVariable(string, string, object)

Deletes a campaign variable from the database.

void DeleteCampaignVariable(
    string sCampaignName,
    string sVarName,
    object oPlayer = OBJECT_INVALID
);

Parameters

sCampaignName

Campaign to delete the variable from (case-sensitive).

sVarName

Variable name to delete.

oPlayer

Player associated with a variable. (Default: OBJECT_INVALID)


Description

Marks a campaign variable of any type within the database for deletion.



Remarks

Note that by normal database standards, deleting does not actually removed the entry from the database, but flags it as deleted. Do not expect the database files to shrink in size from this command. If you want to 'pack' the database, you will have to do it externally from the game.

Unknown how to restore a deleted variable within the database from outside the game.


Version

1.30

See Also

categories: Database Functions


 author: Charles Feduke, editor: Lilac Soul
 Send comments on this topic.