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.
CloseFor 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.
CloserecordKey | A record key. |
value | The property value. |
bool True if the record is found and is valid, false otherwise.
Loads a single property, already deseriazed into an object.
// Load the value already deserialized. var colorRecordKey = PropertyDatabase.CreateRecordKey("path/to/my/asset", "m_Color"); if (!propertyDatabase.TryLoad(colorRecordKey, out object colorObject)) Assert.Fail("Failed to load color property."); var color = (Color)colorObject; Assert.AreEqual(new Color(1, 0, 1), color);
Additional resources: PropertyDatabase.CreateRecordKey.
recordKey | A record key. |
value | The property record. |
bool True if the record is found and is valid, false otherwise.
Loads a single property, still contained within a record.
This method doesn't deserialize the value. You have to deserialize it yourself by calling PropertyDatabase.GetObjectFromRecordValue.
// Load the record value to do a deserialization at the appropriate time. var sizeRecordKey = PropertyDatabase.CreateRecordKey("path/to/my/asset", "m_Size"); if (!propertyDatabase.TryLoad(sizeRecordKey, out IPropertyDatabaseRecordValue sizeRecordValue)) Assert.Fail("Failed to load size property."); var size = propertyDatabase.GetValueFromRecord<int>(sizeRecordValue); Assert.AreEqual(42, size);
Additional resources: PropertyDatabase.CreateRecordKey.
documentKey | A document key. |
data | The document property values. |
bool True if the record is found and is valid, false otherwise.
Loads all the properties of a document, already deseriazed into objects.
// Load all values not associated with a document, already deserialized. var nullDocumentKey = PropertyDatabase.CreateDocumentKey(null); if (!propertyDatabase.TryLoad(nullDocumentKey, out IEnumerable<object> noDocumentProperties)) Assert.Fail("Failed to load properties with no documents."); Assert.IsNotEmpty(noDocumentProperties); Assert.AreEqual("myDocs_", noDocumentProperties.First());
Additional resources: PropertyDatabase.CreateDocumentKey.
documentKey | A document key. |
records | The document property records. |
bool True if the record is found and is valid, false otherwise.
Loads all the properties of a document, still contained within records.
This method doesn't deserialize the values. You have to deserialize them yourself by calling PropertyDatabase.GetObjectFromRecordValue.
// Load all values associated with a document, not deserialized. var myAssetDocumentKey = PropertyDatabase.CreateDocumentKey("path/to/my/asset"); if (!propertyDatabase.TryLoad(myAssetDocumentKey, out IEnumerable<IPropertyDatabaseRecord> myDocumentRecords)) Assert.Fail("Failed to load records for my asset document."); var deserializedValues = new Dictionary<PropertyDatabaseRecordKey, object>(); foreach (var myDocumentRecord in myDocumentRecords) { var value = propertyDatabase.GetValueFromRecord<object>(myDocumentRecord.value); deserializedValues.Add(myDocumentRecord.key, value); } Assert.AreEqual(5, deserializedValues.Count);
Additional resources: PropertyDatabase.CreateDocumentKey.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.