Version: 2017.3 (switch to 2017.4)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Experimental: this API is experimental and might be changed or removed in the future.

VisualElement.GetOrCreatePersistentData

Other Versions
Leave feedback
Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public method GetOrCreatePersistentData(existing: object, key: string): T;
public T GetOrCreatePersistentData(object existing, string key);
public method GetOrCreatePersistentData(existing: ScriptableObject, key: string): T;
public T GetOrCreatePersistentData(ScriptableObject existing, string key);

Parameters

existing An existing object to be persisted, or null to create a new object. If no persisted state is found, a non-null object will be returned as-is.
key The key for the current VisualElement to be used with the persistence store on the EditorWindow.

Returns

T The same object being passed in (or a new one if null was passed in), but possibly with its persistent state restored.

Description

Takes a reference to an existing persisted object and a key and returns the object either filled with the persisted state or as-is.

Takes a reference to an existing (or null) persisted object and a key, ideally from VisualElement.GetFullHierarchicalPersistenceKey, and returns the object either filled with the persisted state or as-is. It will also create a new persisted object if its passed in null and no persisted state is found. This function will not save anything into the persistence store on the EditorWindow.

Did you find this page useful? Please give it a rating:

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright © 2018 Unity Technologies. Publication: 2017.3-002A. Built: 2018-04-04.
Tutorials Community Answers Knowledge Base Forums Asset Store LegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information