ResourceManager

Summary

Methods

Method	Returns
MountSuperBundle(superbundle: string, mediaHint: MediaHint = MediaHint.MediaHint_Default, optional: bool = false)	void
UnmountSuperBundle(superbundle: string)	void
GetSettings(settingsType: string)	DataContainer | nil
LookupDataContainer(compartment: ResourceCompartment, name: string)	DataContainer | nil
SearchForDataContainer(name: string)	DataContainer | nil
FindInstanceByGuid(partitionGuid: Guid, instanceGuid: Guid)	DataContainer | nil
SearchForInstanceByGuid(instanceGuid: Guid)	DataContainer | nil
FindDatabasePartition(partitionGuid: Guid)	DatabasePartition | nil
FindPartitionForInstance(instance: DataContainer)	DatabasePartition | nil
RegisterInstanceLoadHandler(partitionGuid: Guid, instanceGuid: Guid, callback: callable)	ContainerCallback | nil
RegisterInstanceLoadHandler(partitionGuid: Guid, instanceGuid: Guid, context: any, callback: callable)	ContainerCallback
RegisterInstanceLoadHandlerOnce(partitionGuid: Guid, instanceGuid: Guid, callback: callable)	ContainerCallback
RegisterInstanceLoadHandlerOnce(partitionGuid: Guid, instanceGuid: Guid, context: any, callback: callable)	ContainerCallback
RegisterPartitionLoadHandler(partitionGuid: Guid, callback: callable)	ContainerCallback | nil
RegisterPartitionLoadHandler(partitionGuid: Guid, context: any, callback: callable)	ContainerCallback
RegisterPartitionLoadHandlerOnce(partitionGuid: Guid, callback: callable)	ContainerCallback
RegisterPartitionLoadHandlerOnce(partitionGuid: Guid, context: any, callback: callable)	ContainerCallback
AddRegistry(registry: DataContainer, compartment: ResourceCompartment)	void
BeginLoadData(compartment: ResourceCompartment, bundles: string{})	int
EndLoadData(handle: int)	bool
PollBundleOperation(handle: int)	bool
CancelBundleOperation(handle: int)	void
BeginClear(compartment: ResourceCompartment)	int
EndClear(handle: int)	void
AllocateDynamicCompartment(name: string, parent: ResourceCompartment, clientOnly: bool)	ResourceCompartment
DestroyDynamicCompartment(compartment: ResourceCompartment)	void
AlwaysClearGameCompartment(enable: bool)	void

Methods

MountSuperBundle

MountSuperBundle(superbundle: string, mediaHint: MediaHint = MediaHint.MediaHint_Default, optional: bool = false)

Parameters

Name	Type	Description
superbundle	string
mediaHint	MediaHint
optional	bool

UnmountSuperBundle

UnmountSuperBundle(superbundle: string)

Parameters

Name	Type	Description
superbundle	string

GetSettings

GetSettings(settingsType: string): DataContainer | nil

Parameters

Name	Type	Description
settingsType	string

Returns

Type	Description
DataContainer | nil

LookupDataContainer

LookupDataContainer(compartment: ResourceCompartment, name: string): DataContainer | nil

Parameters

Name	Type	Description
compartment	ResourceCompartment
name	string

Returns

Type	Description
DataContainer | nil

SearchForDataContainer

SearchForDataContainer(name: string): DataContainer | nil

Parameters

Name	Type	Description
name	string

Returns

Type	Description
DataContainer | nil

FindInstanceByGuid

FindInstanceByGuid(partitionGuid: Guid, instanceGuid: Guid): DataContainer | nil

Parameters

Name	Type	Description
partitionGuid	Guid
instanceGuid	Guid

Returns

Type	Description
DataContainer | nil

SearchForInstanceByGuid

SearchForInstanceByGuid(instanceGuid: Guid): DataContainer | nil

Parameters

Name	Type	Description
instanceGuid	Guid

Returns

Type	Description
DataContainer | nil

FindDatabasePartition

FindDatabasePartition(partitionGuid: Guid): DatabasePartition | nil

Parameters

Name	Type	Description
partitionGuid	Guid

Returns

Type	Description
DatabasePartition | nil

FindPartitionForInstance

FindPartitionForInstance(instance: DataContainer): DatabasePartition | nil

Parameters

Name	Type	Description
instance	DataContainer

Returns

Type	Description
DatabasePartition | nil

RegisterInstanceLoadHandler

RegisterInstanceLoadHandler(partitionGuid: Guid, instanceGuid: Guid, callback: callable): ContainerCallback | nil

Parameters

Name	Type	Description
partitionGuid	Guid
instanceGuid	Guid
callback	callable

Returns

Type	Description
ContainerCallback | nil

RegisterInstanceLoadHandler

RegisterInstanceLoadHandler(partitionGuid: Guid, instanceGuid: Guid, context: any, callback: callable): ContainerCallback

Parameters

Name	Type	Description
partitionGuid	Guid
instanceGuid	Guid
context	any
callback	callable

Returns

Type	Description
ContainerCallback

RegisterInstanceLoadHandlerOnce

RegisterInstanceLoadHandlerOnce(partitionGuid: Guid, instanceGuid: Guid, callback: callable): ContainerCallback

Parameters

Name	Type	Description
partitionGuid	Guid
instanceGuid	Guid
callback	callable

Returns

Type	Description
ContainerCallback

RegisterInstanceLoadHandlerOnce

RegisterInstanceLoadHandlerOnce(partitionGuid: Guid, instanceGuid: Guid, context: any, callback: callable): ContainerCallback

Parameters

Name	Type	Description
partitionGuid	Guid
instanceGuid	Guid
context	any
callback	callable

Returns

Type	Description
ContainerCallback

RegisterPartitionLoadHandler

RegisterPartitionLoadHandler(partitionGuid: Guid, callback: callable): ContainerCallback | nil

Parameters

Name	Type	Description
partitionGuid	Guid
callback	callable

Returns

Type	Description
ContainerCallback | nil

RegisterPartitionLoadHandler

RegisterPartitionLoadHandler(partitionGuid: Guid, context: any, callback: callable): ContainerCallback

Parameters

Name	Type	Description
partitionGuid	Guid
context	any
callback	callable

Returns

Type	Description
ContainerCallback

RegisterPartitionLoadHandlerOnce

RegisterPartitionLoadHandlerOnce(partitionGuid: Guid, callback: callable): ContainerCallback

Parameters

Name	Type	Description
partitionGuid	Guid
callback	callable

Returns

Type	Description
ContainerCallback

RegisterPartitionLoadHandlerOnce

RegisterPartitionLoadHandlerOnce(partitionGuid: Guid, context: any, callback: callable): ContainerCallback

Parameters

Name	Type	Description
partitionGuid	Guid
context	any
callback	callable

Returns

Type	Description
ContainerCallback

AddRegistry

AddRegistry(registry: DataContainer, compartment: ResourceCompartment)

Parameters

Name	Type	Description
registry	DataContainer
compartment	ResourceCompartment

BeginLoadData

BeginLoadData(compartment: ResourceCompartment, bundles: string{}): int

Parameters

Name	Type	Description
compartment	ResourceCompartment
bundles	string{}

Returns

Type	Description
int

EndLoadData

EndLoadData(handle: int): bool

Parameters

Name	Type	Description
handle	int

Returns

Type	Description
bool

PollBundleOperation

PollBundleOperation(handle: int): bool

Parameters

Name	Type	Description
handle	int

Returns

Type	Description
bool

CancelBundleOperation

CancelBundleOperation(handle: int)

Parameters

Name	Type	Description
handle	int

BeginClear

BeginClear(compartment: ResourceCompartment): int

Parameters

Name	Type	Description
compartment	ResourceCompartment

Returns

Type	Description
int

EndClear

EndClear(handle: int)

Parameters

Name	Type	Description
handle	int

AllocateDynamicCompartment

AllocateDynamicCompartment(name: string, parent: ResourceCompartment, clientOnly: bool): ResourceCompartment

Parameters

Name	Type	Description
name	string
parent	ResourceCompartment
clientOnly	bool

Returns

Type	Description
ResourceCompartment

DestroyDynamicCompartment

DestroyDynamicCompartment(compartment: ResourceCompartment)

Parameters

Name	Type	Description
compartment	ResourceCompartment

AlwaysClearGameCompartment

AlwaysClearGameCompartment(enable: bool)

Parameters

Name	Type	Description
enable	bool