[ Web Proxy ]
URL:
Viewing: https://docs.unity3d.com/ScriptReference/Search.PropertyDatabase.Store.html [Back]  [Original]

Unity - Scripting API: Search.PropertyDatabase.Store
Version: Unity 6.5 (6000.5)
    • Supported
    • Legacy
    LanguageEnglish
    • C#

    PropertyDatabase.Store

    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
    Your name Your email Suggestion* Submit suggestion

    Cancel

    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.

    // Store a property of a document, with the document id and property hash already computed.
    var documentId = PropertyDatabase.CreateDocumentKey("path/to/my/asset");
    var propertyHash = PropertyDatabase.CreatePropertyHash("m_Size");
    stored = propertyDatabase.Store(documentId, propertyHash, 42);
    if (!stored)
        Debug.LogWarning("Property m_Size did not store.");
    

    Declaration

    public bool Store(ref PropertyDatabaseRecordKey recordKey, Object value);

    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.");
    

    Additional resources: PropertyDatabase.CreateRecordKey.


    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.

    // Store a property without any document.
    stored = propertyDatabase.Store(PropertyDatabase.CreatePropertyHash("documentPrefix"), "myDocs_");
    if (!stored)
        Debug.LogWarning("Property documentPrefix did not store.");
    

    Additional resources: PropertyDatabase.CreatePropertyHash.


    Web Proxy Viewer  |  New URL  |  Original Page