Session-specific Functions

Functions
Int	vSS_API_Stash::GetStashSessionFormMap ()
Int	vSS_API_Stash::CreateStashSessionJMap (String asUUID="")
Int	vSS_API_Stash::GetStashSessionJMap (String asUUID, Bool abCreateIfMissing=False)
Int	vSS_API_Stash::GetStashRefSessionJMap (ObjectReference akStashRef, Bool abCreateIfMissing=False)

Detailed Description

Function Documentation

Int vSS_API_Stash::CreateStashSessionJMap ( String  asUUID = "" )

inlinestatic

Create the Session-specific data for a new Stash based on akStashRef.

Parameters

asUUID

The UUID to use for the new Stash, if one exists.

Returns

The Session JMap for the new Stash.

Int vSS_API_Stash::GetStashRefSessionJMap ( ObjectReference  akStashRef, Bool  abCreateIfMissing = False  )

inlinestatic

Return the Session-specific data for a Stash using its ObjectReference, optionally creating it if it is missing.

Parameters

akStashRef	The ObjectReference of the Stash.
abCreateIfMissing	If set to True, create the Session-specific Stash data if it is missing. Default: False.

Returns

The Session JMap for the Stash.

Int vSS_API_Stash::GetStashSessionFormMap ( )

inlinestatic

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

Returns

A jFormMap.

Int vSS_API_Stash::GetStashSessionJMap ( String  asUUID, Bool  abCreateIfMissing = False  )

inlinestatic

Return the Session-specific data for a Stash, optionally creating it if it is missing.

Parameters

asUUID	The UUID of the Stash.
abCreateIfMissing	If set to True, create the Session-specific Stash data if it is missing. Default: False.

Returns

The Session JMap for the Stash.