AtomicNET : AtomicEngine Namespace

ResourceCache Class

%Resource cache subsystem. Loads resources on demand and stores them for later access.

Syntax

public class ResourceCache : AObject

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Members

See Also: Inherited members from AObject.

Public Constructors

Documentation for this section has not yet been entered.
Construct.

Public Fields

nativeInstance IntPtr . Documentation for this section has not yet been entered. (Inherited from RefCounted.)

Public Properties

AutoReloadResources bool . Documentation for this section has not yet been entered.
[read-only]
Category string . Documentation for this section has not yet been entered. (Inherited from AObject.)
[read-only]
Context Context . Documentation for this section has not yet been entered. (Inherited from AObject.)
[read-only]
EventSender AObject . Documentation for this section has not yet been entered. (Inherited from AObject.)
FinishBackgroundResourcesMs int . Documentation for this section has not yet been entered.
InstantiationType InstantiationType . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
[read-only]
NativeInstance IntPtr . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
[read-only]
NumBackgroundLoadResources uint . Documentation for this section has not yet been entered.
[read-only]
NumResourceDirs uint . Documentation for this section has not yet been entered.
[read-only]
PackageFiles Vector<PackageFile> . Documentation for this section has not yet been entered.
ReturnFailedResources bool . Documentation for this section has not yet been entered.
SearchPackagesFirst bool . Documentation for this section has not yet been entered.
[read-only]
TotalMemoryUse long . Documentation for this section has not yet been entered.
[read-only]
TypeName string . Documentation for this section has not yet been entered. (Inherited from AObject.)
[read-only]
TypeName string . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
[read-only]
TypeNameStatic string . Documentation for this section has not yet been entered. (Inherited from AObject.)

Public Methods

AddManualResource (Resource) : bool
Add a manually created resource. Must be uniquely named.
AddPackageFile (PackageFile, uint) : bool
Add a package file for loading resources from. Optional priority parameter which will control search order.
AddPackageFile (string, uint) : bool
Add a package file for loading resources from by name. Optional priority parameter which will control search order.
AddRef ()
Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting. (Inherited from RefCounted.)
AddRefSilent ()
Increment reference count. Do not call any lifetime book keeping (Inherited from RefCounted.)
AddResourceDir (string, uint) : bool
Add a resource load directory. Optional priority parameter which will control search order.
BackgroundLoadResource (StringHash, string, bool, Resource) : bool
Background load a resource. An event will be sent when complete. Return true if successfully stored to the load queue, false if eg. already exists. Can be called from outside the main thread.
static
csb_Atomic_ResourceCache_GetClassIDStatic () : IntPtr
Documentation for this section has not yet been entered.
Exists (string) : bool
Return whether a file exists by name.
Get<T> (string) : T
Documentation for this section has not yet been entered.
GetAutoReloadResources () : bool
Return whether automatic resource reloading is enabled.
GetCategory () : string
Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered. (Inherited from AObject.)
GetContext () : Context
Return execution context. (Inherited from AObject.)
GetEventSender () : AObject
Return active event sender. Null outside event handling. (Inherited from AObject.)
GetExistingResource (StringHash, string) : Resource
Documentation for this section has not yet been entered.
GetFile (string, bool, StringHash) : File
Open and return a file from the resource load paths or from inside a package file. If not found, use a fallback search with absolute path. Return null if fails. Can be called from outside the main thread.
GetFileStream (string, bool) : System.IO.Stream
Documentation for this section has not yet been entered.
GetFinishBackgroundResourcesMs () : int
Return how many milliseconds maximum to spend on finishing background loaded resources.
GetInstantiationType () : InstantiationType
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
GetMemoryBudget (StringHash) : long
Return memory budget for a resource type.
GetMemoryUse (StringHash) : long
Return total memory use for a resource type.
GetNumBackgroundLoadResources () : uint
Return number of pending background-loaded resources.
GetNumResourceDirs () : uint
Get the number of resource directories
GetPackageFiles () : Vector<PackageFile>
Return added package files.
GetPreferredResourceDir (string) : string
Return either the path itself or its parent, based on which of them has recognized resource subdirectories.
GetResource (StringHash, string, bool) : Resource
Return a resource by type and name. Load if not loaded yet. Return null if not found or if fails, unless SetReturnFailedResources(true) has been called. Can be called only from the main thread.
GetResource<T> (string) : T
Documentation for this section has not yet been entered.
GetResourceDir (uint) : string
Get resource directory at a given index
GetResourceFileName (string) : string
Return full absolute file name of resource if possible.
GetResources (Vector<Resource>, StringHash)
Return all loaded resources of a specific type.
GetReturnFailedResources () : bool
Return whether resources that failed to load are returned.
GetSearchPackagesFirst () : bool
Return whether when getting resources should check package files or directories first.
GetSubsystem (StringHash) : AObject
Return subsystem by type. (Inherited from AObject.)
GetTempResource (StringHash, string, bool) : Resource
Load a resource without storing it in the resource cache. Return null if not found or if fails. Can be called from outside the main thread if the resource itself is safe to load completely (it does not possess for example GPU data.)
GetTotalMemoryUse () : long
Return total memory use for all resources.
override
GetTypeName () : string
Return type name. (Inherited from AObject.)
GetTypeName () : string
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
HasEventHandlers () : bool
Return whether has subscribed to any event. (Inherited from AObject.)
HasSubscribedToEvent (StringHash) : bool
Return whether has subscribed to an event without specific sender. (Inherited from AObject.)
HasSubscribedToEvent (AObject, StringHash) : bool
Return whether has subscribed to a specific sender's event. (Inherited from AObject.)
IsInstanceOf (StringHash) : bool
Check current instance is type of specified type. (Inherited from AObject.)
override
IsObject () : bool
Documentation for this section has not yet been entered. (Inherited from AObject.)
IsObject () : bool
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
PrintMemoryUsage () : string
Returns a formatted string containing the memory actively used.
Refs () : int
Return reference count. (Inherited from RefCounted.)
ReleaseAllResources (bool)
Release all resources. When called with the force flag false, releases all currently unused resources.
ReleaseRef ()
Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting. (Inherited from RefCounted.)
ReleaseResource (StringHash, string, bool)
Release a resource by name.
ReleaseResources (StringHash, bool)
Release all resources of a specific type.
ReleaseResources (StringHash, string, bool)
Release resources of a specific type and partial name.
ReloadResource (Resource) : bool
Reload a resource. Return true on success. The resource will not be removed from the cache in case of failure.
ReloadResourceWithDependencies (string)
Reload a resource based on filename. Causes also reload of dependent resources if necessary.
RemovePackageFile (PackageFile, bool, bool)
Remove a package file. Optionally release the resources loaded from it.
RemovePackageFile (string, bool, bool)
Remove a package file by name. Optionally release the resources loaded from it.
RemoveResourceDir (string)
Remove a resource load directory.
ResetDependencies (Resource)
Reset dependencies for a resource.
SanitateResourceDirName (string) : string
Remove unnecessary constructs from a resource directory name and ensure it to be an absolute path.
SanitateResourceName (string) : string
Remove unsupported constructs from the resource name to prevent ambiguity, and normalize absolute filename to resource path relative if possible.
Scan (string, string, uint, bool) : ResourceNameIterator
Scan specified files, returning them as an iterator
SendEvent (string, ScriptVariantMap)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SetAutoReloadResources (bool)
Enable or disable automatic reloading of resources as files are modified. Default false.
SetFinishBackgroundResourcesMs (int)
Set how many milliseconds maximum per frame to spend on finishing background loaded resources.
SetInstantiationType (InstantiationType)
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
SetMemoryBudget (StringHash, long)
Set memory budget for a specific resource type, default 0 is unlimited.
SetReturnFailedResources (bool)
Enable or disable returning resources that failed to load. Default false. This may be useful in editing to not lose resource ref attributes.
SetSearchPackagesFirst (bool)
Define whether when getting resources should check package files or directories first. True for packages, false for directories.
StoreResourceDependency (Resource, string)
Store a dependency for a resource. If a dependency file changes, the resource will be reloaded.
SubscribeToEvent (string, EventDelegate)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent (uint, EventDelegate)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent (AObject, string, EventDelegate)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent (AObject, uint, EventDelegate)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent<T> (NativeEventDelegate<T>)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent<T> (AObject, NativeEventDelegate<T>)
Documentation for this section has not yet been entered. (Inherited from AObject.)
UnsubscribeFromAllEvents ()
Documentation for this section has not yet been entered. (Inherited from AObject.)
UnsubscribeFromEvent (StringHash)
Unsubscribe from an event. (Inherited from AObject.)
UnsubscribeFromEvent (uint)
Documentation for this section has not yet been entered. (Inherited from AObject.)
UnsubscribeFromEvent (AObject, StringHash)
Unsubscribe from a specific sender's event. (Inherited from AObject.)
UnsubscribeFromEvent<T> ()
Documentation for this section has not yet been entered. (Inherited from AObject.)
UnsubscribeFromEventReceiver (AObject)
Unsubscribe from event for specific receiver (where the event handler isn't necessarily in the subscribed object) (Inherited from AObject.)
UnsubscribeFromEvents (AObject)
Unsubscribe from a specific sender's events. (Inherited from AObject.)
WeakRefs () : int
Return weak reference count. (Inherited from RefCounted.)

Member Details

ResourceCache Constructor

Documentation for this section has not yet been entered.

Syntax

public ResourceCache ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ResourceCache Constructor

Construct.

Syntax

public ResourceCache (IntPtr native)

Parameters

native
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

AddManualResource Method

Add a manually created resource. Must be uniquely named.

Syntax

public bool AddManualResource (Resource resource)

Parameters

resource
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

AddPackageFile Method

Add a package file for loading resources from. Optional priority parameter which will control search order.

Syntax

public bool AddPackageFile (PackageFile package, uint priority)

Parameters

package
Documentation for this section has not yet been entered.
priority
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

AddPackageFile Method

Add a package file for loading resources from by name. Optional priority parameter which will control search order.

Syntax

public bool AddPackageFile (string fileName, uint priority)

Parameters

fileName
Documentation for this section has not yet been entered.
priority
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

AddResourceDir Method

Add a resource load directory. Optional priority parameter which will control search order.

Syntax

public bool AddResourceDir (string pathName, uint priority)

Parameters

pathName
Documentation for this section has not yet been entered.
priority
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

AutoReloadResources Property

Documentation for this section has not yet been entered.

Syntax

public bool AutoReloadResources { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

BackgroundLoadResource Method

Background load a resource. An event will be sent when complete. Return true if successfully stored to the load queue, false if eg. already exists. Can be called from outside the main thread.

Syntax

public bool BackgroundLoadResource (StringHash type, string name, bool sendEventOnFailure, Resource caller)

Parameters

type
Documentation for this section has not yet been entered.
name
Documentation for this section has not yet been entered.
sendEventOnFailure
Documentation for this section has not yet been entered.
caller
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

csb_Atomic_ResourceCache_GetClassIDStatic Method

Documentation for this section has not yet been entered.

Syntax

public static IntPtr csb_Atomic_ResourceCache_GetClassIDStatic ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Exists Method

Return whether a file exists by name.

Syntax

public bool Exists (string name)

Parameters

name
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

FinishBackgroundResourcesMs Property

Documentation for this section has not yet been entered.

Syntax

public int FinishBackgroundResourcesMs { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Get<T> Generic Method

Documentation for this section has not yet been entered.

Syntax

public T Get<T> (string path)
where T : AtomicEngine.Resource

Type Parameters

T
Documentation for this section has not yet been entered.

Parameters

path
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetAutoReloadResources Method

Return whether automatic resource reloading is enabled.

Syntax

public bool GetAutoReloadResources ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetExistingResource Method

Documentation for this section has not yet been entered.

Syntax

public Resource GetExistingResource (StringHash type, string name)

Parameters

type
Documentation for this section has not yet been entered.
name
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetFile Method

Open and return a file from the resource load paths or from inside a package file. If not found, use a fallback search with absolute path. Return null if fails. Can be called from outside the main thread.

Syntax

public File GetFile (string name, bool sendEventOnFailure, StringHash type)

Parameters

name
Documentation for this section has not yet been entered.
sendEventOnFailure
Documentation for this section has not yet been entered.
type
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetFileStream Method

Documentation for this section has not yet been entered.

Syntax

public System.IO.Stream GetFileStream (string name, bool sendEventOnFailure)

Parameters

name
Documentation for this section has not yet been entered.
sendEventOnFailure
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetFinishBackgroundResourcesMs Method

Return how many milliseconds maximum to spend on finishing background loaded resources.

Syntax

public int GetFinishBackgroundResourcesMs ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetMemoryBudget Method

Return memory budget for a resource type.

Syntax

public long GetMemoryBudget (StringHash type)

Parameters

type
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetMemoryUse Method

Return total memory use for a resource type.

Syntax

public long GetMemoryUse (StringHash type)

Parameters

type
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetNumBackgroundLoadResources Method

Return number of pending background-loaded resources.

Syntax

public uint GetNumBackgroundLoadResources ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetNumResourceDirs Method

Get the number of resource directories

Syntax

public uint GetNumResourceDirs ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetPackageFiles Method

Return added package files.

Syntax

public Vector<PackageFile> GetPackageFiles ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetPreferredResourceDir Method

Return either the path itself or its parent, based on which of them has recognized resource subdirectories.

Syntax

public string GetPreferredResourceDir (string path)

Parameters

path
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetResource Method

Return a resource by type and name. Load if not loaded yet. Return null if not found or if fails, unless SetReturnFailedResources(true) has been called. Can be called only from the main thread.

Syntax

public Resource GetResource (StringHash type, string name, bool sendEventOnFailure)

Parameters

type
Documentation for this section has not yet been entered.
name
Documentation for this section has not yet been entered.
sendEventOnFailure
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetResource<T> Generic Method

Documentation for this section has not yet been entered.

Syntax

public T GetResource<T> (string path)
where T : AtomicEngine.Resource

Type Parameters

T
Documentation for this section has not yet been entered.

Parameters

path
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetResourceDir Method

Get resource directory at a given index

Syntax

public string GetResourceDir (uint index)

Parameters

index
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetResourceFileName Method

Return full absolute file name of resource if possible.

Syntax

public string GetResourceFileName (string name)

Parameters

name
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetResources Method

Return all loaded resources of a specific type.

Syntax

public void GetResources (Vector<Resource> result, StringHash type)

Parameters

result
Documentation for this section has not yet been entered.
type
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetReturnFailedResources Method

Return whether resources that failed to load are returned.

Syntax

public bool GetReturnFailedResources ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetSearchPackagesFirst Method

Return whether when getting resources should check package files or directories first.

Syntax

public bool GetSearchPackagesFirst ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetTempResource Method

Load a resource without storing it in the resource cache. Return null if not found or if fails. Can be called from outside the main thread if the resource itself is safe to load completely (it does not possess for example GPU data.)

Syntax

public Resource GetTempResource (StringHash type, string name, bool sendEventOnFailure)

Parameters

type
Documentation for this section has not yet been entered.
name
Documentation for this section has not yet been entered.
sendEventOnFailure
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetTotalMemoryUse Method

Return total memory use for all resources.

Syntax

public long GetTotalMemoryUse ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

NumBackgroundLoadResources Property

Documentation for this section has not yet been entered.

Syntax

public uint NumBackgroundLoadResources { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

NumResourceDirs Property

Documentation for this section has not yet been entered.

Syntax

public uint NumResourceDirs { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

PackageFiles Property

Documentation for this section has not yet been entered.

Syntax

public Vector<PackageFile> PackageFiles { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

PrintMemoryUsage Method

Returns a formatted string containing the memory actively used.

Syntax

public string PrintMemoryUsage ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReleaseAllResources Method

Release all resources. When called with the force flag false, releases all currently unused resources.

Syntax

public void ReleaseAllResources (bool force)

Parameters

force
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReleaseResource Method

Release a resource by name.

Syntax

public void ReleaseResource (StringHash type, string name, bool force)

Parameters

type
Documentation for this section has not yet been entered.
name
Documentation for this section has not yet been entered.
force
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReleaseResources Method

Release all resources of a specific type.

Syntax

public void ReleaseResources (StringHash type, bool force)

Parameters

type
Documentation for this section has not yet been entered.
force
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReleaseResources Method

Release resources of a specific type and partial name.

Syntax

public void ReleaseResources (StringHash type, string partialName, bool force)

Parameters

type
Documentation for this section has not yet been entered.
partialName
Documentation for this section has not yet been entered.
force
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReloadResource Method

Reload a resource. Return true on success. The resource will not be removed from the cache in case of failure.

Syntax

public bool ReloadResource (Resource resource)

Parameters

resource
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReloadResourceWithDependencies Method

Reload a resource based on filename. Causes also reload of dependent resources if necessary.

Syntax

public void ReloadResourceWithDependencies (string fileName)

Parameters

fileName
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

RemovePackageFile Method

Remove a package file. Optionally release the resources loaded from it.

Syntax

public void RemovePackageFile (PackageFile package, bool releaseResources, bool forceRelease)

Parameters

package
Documentation for this section has not yet been entered.
releaseResources
Documentation for this section has not yet been entered.
forceRelease
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

RemovePackageFile Method

Remove a package file by name. Optionally release the resources loaded from it.

Syntax

public void RemovePackageFile (string fileName, bool releaseResources, bool forceRelease)

Parameters

fileName
Documentation for this section has not yet been entered.
releaseResources
Documentation for this section has not yet been entered.
forceRelease
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

RemoveResourceDir Method

Remove a resource load directory.

Syntax

public void RemoveResourceDir (string pathName)

Parameters

pathName
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ResetDependencies Method

Reset dependencies for a resource.

Syntax

public void ResetDependencies (Resource resource)

Parameters

resource
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReturnFailedResources Property

Documentation for this section has not yet been entered.

Syntax

public bool ReturnFailedResources { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SanitateResourceDirName Method

Remove unnecessary constructs from a resource directory name and ensure it to be an absolute path.

Syntax

public string SanitateResourceDirName (string name)

Parameters

name
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SanitateResourceName Method

Remove unsupported constructs from the resource name to prevent ambiguity, and normalize absolute filename to resource path relative if possible.

Syntax

public string SanitateResourceName (string name)

Parameters

name
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Scan Method

Scan specified files, returning them as an iterator

Syntax

public ResourceNameIterator Scan (string pathName, string filter, uint flags, bool recursive)

Parameters

pathName
Documentation for this section has not yet been entered.
filter
Documentation for this section has not yet been entered.
flags
Documentation for this section has not yet been entered.
recursive
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SearchPackagesFirst Property

Documentation for this section has not yet been entered.

Syntax

public bool SearchPackagesFirst { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetAutoReloadResources Method

Enable or disable automatic reloading of resources as files are modified. Default false.

Syntax

public void SetAutoReloadResources (bool enable)

Parameters

enable
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetFinishBackgroundResourcesMs Method

Set how many milliseconds maximum per frame to spend on finishing background loaded resources.

Syntax

public void SetFinishBackgroundResourcesMs (int ms)

Parameters

ms
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetMemoryBudget Method

Set memory budget for a specific resource type, default 0 is unlimited.

Syntax

public void SetMemoryBudget (StringHash type, long budget)

Parameters

type
Documentation for this section has not yet been entered.
budget
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetReturnFailedResources Method

Enable or disable returning resources that failed to load. Default false. This may be useful in editing to not lose resource ref attributes.

Syntax

public void SetReturnFailedResources (bool enable)

Parameters

enable
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetSearchPackagesFirst Method

Define whether when getting resources should check package files or directories first. True for packages, false for directories.

Syntax

public void SetSearchPackagesFirst (bool value)

Parameters

value
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

StoreResourceDependency Method

Store a dependency for a resource. If a dependency file changes, the resource will be reloaded.

Syntax

public void StoreResourceDependency (Resource resource, string dependency)

Parameters

resource
Documentation for this section has not yet been entered.
dependency
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

TotalMemoryUse Property

Documentation for this section has not yet been entered.

Syntax

public long TotalMemoryUse { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0