Stash Data Functions

Functions
Bool	vSS_API_Stash::IsStash (String asUUID)
Bool	vSS_API_Stash::CreateStashRef (ObjectReference akStashRef, Int aiStashGroup=0)
Bool	vSS_API_Stash::RemoveStash (String asUUID, Form akStashRef=None)
Bool	vSS_API_Stash::RemoveStashRef (ObjectReference akStashRef)
Bool	vSS_API_Stash::IsStashRef (ObjectReference akStashRef)
	vSS_API_Stash::SetStashGroup (String asUUID, Int aiStashGroup=0)
Int	vSS_API_Stash::GetStashGroup (String asUUID)
	vSS_API_Stash::SetStashRefGroup (ObjectReference akStashRef, Int aiStashGroup=0)
Int	vSS_API_Stash::GetStashRefGroup (ObjectReference akStashRef)
Int	vSS_API_Stash::GetStashEntryCount (String asUUID)
String[]	vSS_API_Stash::GetStashItems (String asUUID)
Form[]	vSS_API_Stash::GetAllStashObjects ()
Form[]	vSS_API_Stash::GetStashObjectsInCell ()

Detailed Description

Functions for manipulating or testing Stash data.

Function Documentation

Bool vSS_API_Stash::CreateStashRef ( ObjectReference  akStashRef, Int  aiStashGroup = 0  )

inlinestatic

Turn the ObjectReference specified by akStashRef into a new Stash.

Parameters

akStashRef	The ObjectReference of the Stash.
aiStashGroup	The group ID of the Stash.

Returns

True for success, otherwise False.

Note

aiStashGroup does nothing right now.

Form [] vSS_API_Stash::GetAllStashObjects ( )

inlinestatic

Get an array of ObjectReferences that are set as Stashes.

Returns

An array of ObjectReferences currently set a Stashes.

Bug:

ObjectReferences in unloaded Cells will not be on the list. This is a Skyrim bug and not one that I can fix.

Int vSS_API_Stash::GetStashEntryCount ( String  asUUID )

inlinestatic

Get the number of item entries for the specified Stash.

Parameters

asUUID

The UUID of the Stash.

Returns

The number of item entries in the Stash, or 0 if not found.

Note

Item entries are not the same as items, objects, or anything else. They consist of a Form (used as the index) and various attached info. The ItemEntry count is equal to the number of Forms, not the number of items in the Stash.

Int vSS_API_Stash::GetStashGroup ( String  asUUID )

inlinestatic

Get the Group ID for the specified Stash.

Parameters

asUUID

The UUID of the Stash.

Returns

The Group ID.

Note

Stash Groups aren't implemented, so this does nothing right now.

String [] vSS_API_Stash::GetStashItems ( String  asUUID )

inlinestatic

Deprecated:

This does nothing now and will be removed shortly.

Form [] vSS_API_Stash::GetStashObjectsInCell ( )

inlinestatic

Get an array of ObjectReferences that are set as Stashes in a Cell.

Returns

An array of ObjectReferences currently set a Stashes in a Cell.

Bug:

This identical to GetAllStashObjects(), must not have ever needed to use it.

Int vSS_API_Stash::GetStashRefGroup ( ObjectReference  akStashRef )

inlinestatic

Get the Group ID for the specified Stash by ObjectReference.

Parameters

akStashRef

The ObjectReference of the Stash.

Returns

The Group ID.

Note

Stash Groups aren't implemented, so this does nothing right now.

See also

GetStashGroup()

Bool vSS_API_Stash::IsStash ( String  asUUID )

inlinestatic

Check if the specified UUID is a valid Stash.

Parameters

asUUID

The UUID of the Stash.

Returns

True if UUID is a valud Stash, otherwise False.

Bool vSS_API_Stash::IsStashRef ( ObjectReference  akStashRef )

inlinestatic

Check if the specified ObjectReference is a valid Stash.

Parameters

akStashRef

The ObjectReference of the Stash.

Returns

True if UUID is a valud Stash, otherwise False.

See also

IsStash()

Bool vSS_API_Stash::RemoveStash ( String  asUUID, Form  akStashRef = None  )

inlinestatic

Remove the Stash data for the specified Stash.

Parameters

asUUID	The UUID of the Stash.
akStashRef	(Optional) The ObjectReference of the Stash.

Returns

True for success, otherwise False.

Note

This removes the Stash data from the persistent registry, but does not touch the items in the Stash's Container.

Bool vSS_API_Stash::RemoveStashRef ( ObjectReference  akStashRef )

inlinestatic

Remove the Stash data for the specified Stash by its ObjectReference.

Parameters

akStashRef

The ObjectReference of the Stash.

Returns

True for success, otherwise False.

Note

This removes the Stash data from the persistent registry, but does not touch the items in the Stash's Container.

vSS_API_Stash::SetStashGroup ( String  asUUID, Int  aiStashGroup = 0  )

inlinestatic

Set the Group ID for the specified Stash.

Parameters

asUUID	The UUID of the Stash.
aiStashGroup	The new Group ID.

Note

Stash Groups aren't implemented, so this does nothing right now.

vSS_API_Stash::SetStashRefGroup ( ObjectReference  akStashRef, Int  aiStashGroup = 0  )

inlinestatic

Set the Group ID for the specified Stash by ObjectReference.

Parameters

akStashRef	The ObjectReference of the Stash.
aiStashGroup	The new Group ID.

Note

Stash Groups aren't implemented, so this does nothing right now.

See also

SetStashGroup()