RetrieveCampaignObject(string, string, location, object, object)
Retrieves an object stored in the campaign database.
object RetrieveCampaignObject( string sCampaignName, string sVarName, location locLocation, object oOwner = OBJECT_INVALID, object oPlayer = OBJECT_INVALID );
Parameters
sCampaignName
Campaign name to retrieve the value from (case-sensitive).
sVarName
Variable's name.
locLocation
Location to create the object at.
oOwner
Owner to attempt to create the object within. (Default: OBJECT_INVALID)
oPlayer
oPlayer associated with the object that was stored in the database. (Default: OBJECT_INVALID)
Description
Returns an object stored in the campaign database. Campaign names are case-sensitive. If you specify an owner, the object will try to be created in the owner's repository. If the owner can't handle the item (or if the owner is a creature), the item will be created on the ground.
Remarks
Unknown as to what other types of owning objects can't handle an item. Unknown if the location matters when a valid owner is specified (but GetLocation(oOwner) should suffice).
Local variables that were on the object when you stored it don't appear to be stored in the database.
Version
1.30
See Also
functions: | StoreCampaignObject |
categories: | Database Functions |
author: Charles Feduke, editor: Lilac Soul, additional contributor(s): Lilac Soul
Send comments on this topic.