Category:Database Functions

From NWN Lexicon
Jump to: navigation, search

Database Function Category

Database retrieval and storage for persistant campaigns.



Functions

Name Brief Description

DeleteCampaignDBVariable

Delete a campaign variable.

DeleteCampaignDBVariableOnAll

Deletes a campaign DB variable from all PCs in a PC's party.

DeleteCampaignVariable

Deletes a campaign variable from the database.

DestroyCampaignDatabase

Destroys a campaign database.

Get2DAString

Retrieves a string value from a *.2da file on a server.

GetCampaignDBFloat

Get a campaign float on a player in the default database for this module.

GetCampaignFloat

Retrieves a float from the campaign database.

GetCampaignDBInt

Get a campaign integer on a player in the default database for this module.

GetCampaignInt

Retrieves an integer value from the campaign database.

GetCampaignDBLocation

Get a campaign location on a player in the default database for this module.

GetCampaignLocation

Retrieves a location value from the campaign database.

GetCampaignDBName

Return the name of the campaign database that should be used for this module (or a default value if none).

GetCampaignDBString

Get a campaign string on a player in the default database for this module.

GetCampaignString

Retrieves a string value from the campaign database.

GetCampaignDBVector

Get a campaign vector on a player in the default database for this module.

GetCampaignVector

Retrieves a vector value from the campaign database.

RetrieveCampaignDBObject

Get a campaign object stored on a player in the default database for this module. You should use DeleteCampaignDBVariable to remove the object once you are done retrieving it, or else the database will bloat.

RetrieveCampaignObject

Retrieves an object stored in the campaign database.

SetCampaignDBFloat

Set a campaign float on a player in the default database for this module.

SetCampaignDBFloatOnAll

Sets a campaign DB float variable on all PCs in a PC's party

SetCampaignDBInt

Set a campaign int on a player in the default database for this module.

SetCampaignDBIntOnAll

Sets a campaign DB integer on all PCs in PC's party

SetCampaignDBLocation

Set a campaign location on a player in the default database for this module.

SetCampaignDBLocationOnAll

Sets a campaign DB location variable on all PCs of a PC's party

SetCampaignDBString

Set a campaign string on a player in the default database for this module.

SetCampaignDBStringOnAll

Sets a campaign string variable on all PCs in a PC's party

SetCampaignDBVector

Set a campaign vector on a player in the default database for this module.

SetCampaignDBVectorOnAll

Sets a campaign DB vector variable on all PCs in a PC's party

SetCampaignFloat

Sets the value of a float in the campaign database.

SetCampaignInt

Sets the value of an integer in the campaign database.

SetCampaignLocation

Sets the value of a location in the campaign database.

SetCampaignString

Sets the value of a string in the campaign database.

SetCampaignVector

Sets the value of a vector in the campaign database.

StoreCampaignDBObject

Store a campaign object on a player in the default database for this module.

StoreCampaignDBObjectOnAll

Stores a campaign DB object on all PCs of a PC's party

StoreCampaignObject

Stores an item or creature in the campaign database.