API for saving, loading, and managing Stashes. More...

Inheritance diagram for vSS_API_Stash:

Static Public Member Functions
Int	GetStashFormMap ()

String	CreateStashData (ObjectReference akStashRef)

Int	GetStashJMap (String asUUID)

Int	GetStashBackupJMap (String asUUID, Int aiBackupNum=1)

Int	RevertToBackup (String asUUID, Int aiBackupNum=1)

Int	GetStashRefJMap (ObjectReference akStashRef)

String	GetUUIDForStashRef (ObjectReference akStashRef)

ObjectReference	GetStashRefForUUID (String asUUID)

Int	GetStashSessionFormMap ()

Int	CreateStashSessionJMap (String asUUID="")

Int	GetStashSessionJMap (String asUUID, Bool abCreateIfMissing=False)

Int	GetStashRefSessionJMap (ObjectReference akStashRef, Bool abCreateIfMissing=False)

Int	GetStashSessionInt (String asUUID, String asKey)

	SetStashSessionInt (String asUUID, String asKey, Int aiValue)

Int	GetStashInt (String asUUID, String asKey)

	SetStashInt (String asUUID, String asKey, Int aiValue)

Float	GetStashFlt (String asUUID, String asKey)

	SetStashFlt (String asUUID, String asKey, Float afValue)

String	GetStashStr (String asUUID, String asKey)

	SetStashStr (String asUUID, String asKey, String asValue)

Form	GetStashForm (String asUUID, String asKey)

	SetStashForm (String asUUID, String asKey, Form akValue)

Int	GetStashObj (String asUUID, String asKey)

	SetStashObj (String asUUID, String asKey, Int ajValue)

Int	GetStashRefSessionInt (ObjectReference akStashRef, String asKey)

	SetStashRefSessionInt (ObjectReference akStashRef, String asKey, Int aiValue)

Int	GetStashRefInt (ObjectReference akStashRef, String asKey)

	SetStashRefInt (ObjectReference akStashRef, String asKey, Int aiValue)

Float	GetStashRefFlt (ObjectReference akStashRef, String asKey)

	SetStashRefFlt (ObjectReference akStashRef, String asKey, Float afValue)

String	GetStashRefStr (ObjectReference akStashRef, String asKey)

	SetStashRefStr (ObjectReference akStashRef, String asKey, String asValue)

Form	GetStashRefForm (ObjectReference akStashRef, String asKey)

	SetStashRefForm (ObjectReference akStashRef, String asKey, Form akValue)

Int	GetStashRefObj (ObjectReference akStashRef, String asKey)

	SetStashRefObj (ObjectReference akStashRef, String asKey, Int ajValue)

Bool	IsStash (String asUUID)

Bool	CreateStashRef (ObjectReference akStashRef, Int aiStashGroup=0)

Bool	RemoveStash (String asUUID, Form akStashRef=None)

Bool	RemoveStashRef (ObjectReference akStashRef)

Bool	IsStashRef (ObjectReference akStashRef)

	SetStashGroup (String asUUID, Int aiStashGroup=0)

Int	GetStashGroup (String asUUID)

	SetStashRefGroup (ObjectReference akStashRef, Int aiStashGroup=0)

Int	GetStashRefGroup (ObjectReference akStashRef)

Int	GetStashEntryCount (String asUUID)

String[]	GetStashItems (String asUUID)

Form[]	GetAllStashObjects ()

Form[]	GetStashObjectsInCell ()

	CreateMCMLists ()

String[]	GetMCMNames ()

Int	LoadStashesForCell (Cell akCell)

Int	ImportStashRefItems (ObjectReference akStashRef, Bool abForce=False)

Int	ScanContainer (ObjectReference akStashRef)

Int	UpdateStashData (String asUUID)

	ExportStash (String asUUID, Bool abSkipBackup=False)

	DebugTraceAPIStash (String sDebugString, Int iSeverity=0)

String	GetStashFileNameString (String asUUID)

String	GetFormIDString (Form kForm)

Form	GetFormFromString (String asString)

Additional Inherited Members
Public Attributes inherited from vSS_APIBase
String	META = ".Info"

Detailed Description

API for saving, loading, and managing Stashes.

[ vSS_API_Stash.psc ]

API for saving and loading Stashs. A Stash is a container that will be shared between multiple savegames/sessions.

FIXME: HEY I just had this really hoopy idea. Papyrus coerces Forms into Strings. This means I can check to see if an incoming string is actually a Form, and consolidate these split functions into one without breaking compatibility. Maybe. Might not be worth the effort.

Member Function Documentation

vSS_API_Stash::CreateMCMLists ( )

inlinestatic

This creates the data structures used by the MCM for quickly sorting through Stashes.

Note: This should only be called by the MCM script under most circumstances.

See also: vSS_MCMConfigQuestScript

String vSS_API_Stash::CreateStashData ( ObjectReference akStashRef )

inlinestatic

Initialize the data for a new Stash based on akStashRef.

Parameters

akStashRef The ObjectReference to use for the new Stash.

Returns: The UUID of the new Stash.

String [] vSS_API_Stash::GetMCMNames ( )

inlinestatic

Return an array of Strings containing the names of all available Stashes.

Note: This should only be called by the MCM script under most circumstances. CreateMCMLists() must be called at least once before this will work.

See also: vSS_MCMConfigQuestScript

Int vSS_API_Stash::GetStashBackupJMap	(	String	asUUID,
		Int	aiBackupNum = `1`
	)

inlinestatic

Get the JMap for the specified revison of a Stash.

Parameters

asUUID	The UUID of the Stash.
aiBackupNum	The revision number. Higher is older. Default max is 9.

Returns: The JMap object or 0 if not found.

Int vSS_API_Stash::GetStashFormMap ( )

inlinestatic

Return the JFormMap for all Stashes, creating it if it does not exist.

Returns: A jFormMap.

Int vSS_API_Stash::GetStashJMap ( String asUUID )

inlinestatic

Get the JMap for the specified Stash.

Parameters

asUUID The UUID of the Stash.

Returns: The JMap object or 0 if not found.

ObjectReference vSS_API_Stash::GetStashRefForUUID ( String asUUID )

inlinestatic

Get the ObjectReferenc for the specified Stash.

Parameters

asUUID The UUID of the Stash.

Returns: The ObjectReference for the Stash if it exists, or None. See note.

Note: ObjectReferences in unloaded Cells will also return None. There really isn't any way around this.

Int vSS_API_Stash::GetStashRefJMap ( ObjectReference akStashRef )

inlinestatic

Get the Stash JMap for the specified ObjectReference.

Parameters

akStashRef The ObjectReference of the Stash.

Returns: The JMap object or 0 if not found.

String vSS_API_Stash::GetUUIDForStashRef ( ObjectReference akStashRef )

inlinestatic

Get the Stash UUID of the specified ObjectReference.

Parameters

akStashRef The ObjectReference of the Stash.

Returns: The Stash's UUID, or an empty string if none is found.

Int vSS_API_Stash::RevertToBackup	(	String	asUUID,
		Int	aiBackupNum = `1`
	)

inlinestatic

Revert the contents of the Stash to those in the specified revision.

Parameters

asUUID	The UUID of the Stash.
aiBackupNum	The revision number. Higher is older. Default max is 9.

Returns: 0 if successful, -1 if the Stash is not found.

Warning: This function will DELETE any items currently in the Stash Container.

The documentation for this class was generated from the following file:

//kodan/verteiron/Papy2Doxy/output/vSS_API_Stash.psc

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation