Unity - Scripting API: Search.PropertyDatabase.Store
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.
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.
Declaration
public bool Store(string documentId, string propertyPath, object value);
Parameters
| Parameter | Description |
|---|---|
| documentId | A document identifier. |
| propertyPath | A property path or name. |
| value | The value of the property. |
Returns
bool True if the store operation succeeded, false if not.
Description
Stores a document property.
// Store a property of a document, like a property of an asset.
var stored = propertyDatabase.Store("path/to/my/asset", "m_Color", new Color(1, 0, 1));
if (!stored)
Debug.LogWarning("Property m_Color did not store.");
Declaration
public bool Store(ulong documentKey, Hash128 propertyHash, object value);
Parameters
| Parameter | Description |
|---|---|
| documentKey | A document key. |
| propertyHash | A property hash. |
| value | The value of the property. |
Returns
bool True if the store operation succeeded, false if not.
Description
Stores a document property with a precomputed document key and property hash.
Parameters
| Parameter | Description |
|---|---|
| recordKey | A record key. |
| value | The value of the property. |
Returns
bool True if the store operation succeeded, false if not.
Description
Stores a document property with a precomputed record key.
// Store a property with an already computed record key. var recordKey = PropertyDatabase.CreateRecordKey("path/to/my/asset", "prop1"); stored = propertyDatabase.Store(recordKey, 123); if (!stored) Debug.LogWarning("Property prop1 did not store.");
Declaration
public bool Store(Hash128 propertyHash, object value);
Parameters
| Parameter | Description |
|---|---|
| propertyHash | A property hash. |
| value | The value of the property. |
Returns
bool True if the store operation succeeded, false if not.
Description
Stores a property with a precomputed property hash.
The document identifier is considered null and the document key will be 0.