StoreCampaignObject(string, string, object, object)

Stores an item or creature in the campaign database.

int StoreCampaignObject(
    string sCampaignName,
    string sVarName,
    object oObject,
    object oPlayer = OBJECT_INVALID
);

Parameters

sCampaignName

Campaign name (case-sensitive)

sVarName

Unique variable name.

oObject

Object value to store

oPlayer

Player to associate this object value with. (Default: OBJECT_INVALID)


Description

Stores an item or creature in the campaign database. Campaign names are case-sensitive. Returns 1 if successful, 0 if the function fails. Only items or creatures can be stored using this function.



Remarks

It is unknown that if by specifying oPlayer that the sVarName must still be unique.

Variables stored locally on the object don't appear to be stored along with the object.


Version

1.30

See Also

functions: RetrieveCampaignObject
categories: Database Functions


 author: Charles Feduke, editor: Lilac Soul, additional contributor(s): Lilac Soul
 Send comments on this topic.