Class ProjectCacheModule

Caching local project data manager. Used to store and manage the information about expanded actor nodes in the scene tree and other local user data used by the editor. Stores data in the project cache directory.

Inheritance

System.Object

FlaxEditor.Modules.EditorModule

ProjectCacheModule

Namespace: FlaxEditor.Modules

Assembly: FlaxEngine.CSharp.dll

Syntax

public sealed class ProjectCacheModule : EditorModule

Properties

AutoSaveInterval

Gets or sets the automatic data save interval.

Declaration

public TimeSpan AutoSaveInterval { get; set; }

Property Value

System.TimeSpan

Methods

GetCustomData(String)

Gets the custom data by the key.

Declaration

public string GetCustomData(string key)

Parameters

System.String key The key.

Returns

System.String The custom data.

Remarks

Use HasCustomData(String) to check if a key is valid.

HasCustomData(String)

Determines whether project cache contains custom data of the specified key.

Declaration

public bool HasCustomData(string key)

Parameters

System.String key The key.

Returns

System.Boolean true if has custom data of the specified key; otherwise, false.

IsExpandedActor(ref Guid)

Determines whether actor identified by the given ID is expanded in the scene tree UI.

Declaration

public bool IsExpandedActor(ref Guid id)

Parameters

System.Guid id The actor identifier.

Returns

System.Boolean true if actor is expanded; otherwise, false.

IsGroupToggled(String)

Determines whether group identified by the given title is collapsed/opened in the UI.

Declaration

public bool IsGroupToggled(string title)

Parameters

System.String title The group title.

Returns

System.Boolean true if group is toggled; otherwise, false.

OnExit()

Declaration

public override void OnExit()

Overrides

FlaxEditor.Modules.EditorModule.OnExit()

OnInit()

Declaration

public override void OnInit()

Overrides

FlaxEditor.Modules.EditorModule.OnInit()

OnUpdate()

Declaration

public override void OnUpdate()

Overrides

FlaxEditor.Modules.EditorModule.OnUpdate()

RemoveCustomData(String)

Removes the custom data.

Declaration

public void RemoveCustomData(string key)

Parameters

System.String key The key.

SetCustomData(String, Boolean)

Sets the custom data.

Declaration

public void SetCustomData(string key, bool value)

Parameters

System.String key The key.

System.Boolean value The value.

SetCustomData(String, Single)

Sets the custom data.

Declaration

public void SetCustomData(string key, float value)

Parameters

System.String key The key.

System.Single value The value.

SetCustomData(String, String)

Sets the custom data.

Declaration

public void SetCustomData(string key, string value)

Parameters

System.String key The key.

System.String value The value.

SetExpandedActor(ref Guid, Boolean)

Sets the actor expanded cached value.

Declaration

public void SetExpandedActor(ref Guid id, bool isExpanded)

Parameters

System.Guid id The identifier.

System.Boolean isExpanded If set to true actor will be cached as an expanded, otherwise false.

SetGroupToggle(String, Boolean)

Sets the group collapsed/opened cached value.

Declaration

public void SetGroupToggle(string title, bool isToggled)

Parameters

System.String title The group title.

System.Boolean isToggled If set to true group will be cached as a toggled, otherwise false.

TryGetCustomData(String, out Boolean)

Tries to get the custom data by the key.

Declaration

public bool TryGetCustomData(string key, out bool value)

Parameters

System.String key The key.

System.Boolean value When this method returns, contains the value associated with the specified key, if the key is found; otherwise, the default value for the type of the value parameter. This parameter is passed uninitialized.

Returns

System.Boolean The custom data.

TryGetCustomData(String, out Single)

Tries to get the custom data by the key.

Declaration

public bool TryGetCustomData(string key, out float value)

Parameters

System.String key The key.

System.Single value When this method returns, contains the value associated with the specified key, if the key is found; otherwise, the default value for the type of the value parameter. This parameter is passed uninitialized.

Returns

System.Boolean The custom data.

TryGetCustomData(String, out String)

Tries to get the custom data by the key.

Declaration

public bool TryGetCustomData(string key, out string value)

Parameters

System.String key The key.

System.String value When this method returns, contains the value associated with the specified key, if the key is found; otherwise, the default value for the type of the value parameter. This parameter is passed uninitialized.

Returns

System.Boolean The custom data.

Extension Methods

Extensions.ReflectiveCompare<T>(T, T)

Extensions.RawClone<T>(T)

See Also

FlaxEditor.Modules.EditorModule