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.
Close| recordKey | A record key. |
| data | 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.
using (var view = propertyDatabase.GetView())
{
var colorRecordKey = view.CreateRecordKey("path/to/my/asset", "m_Color");
if (!view.TryLoad(colorRecordKey, out object colorObject))
Assert.Fail("Failed to load color property.");
var color = (Color)colorObject;
Assert.AreEqual(new Color(1, 0, 1), color);
}
See Also: IPropertyDatabaseView.CreateRecordKey.
| recordKey | A record key. |
| data | 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 IPropertyDatabaseView.GetObjectFromRecordValue.
// Load the record value to do a deserialization at the appropriate time.
using (var view = propertyDatabase.GetView())
{
var sizeRecordKey = view.CreateRecordKey("path/to/my/asset", "m_Size");
if (!view.TryLoad(sizeRecordKey, out IPropertyDatabaseRecordValue sizeRecordValue))
Assert.Fail("Failed to load size property.");
var size = view.GetValueFromRecord<int>(sizeRecordValue);
Assert.AreEqual(42, size);
}
See Also: IPropertyDatabaseView.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.
using (var view = propertyDatabase.GetView())
{
var nullDocumentKey = view.CreateDocumentKey(null);
if (!view.TryLoad(nullDocumentKey, out IEnumerable<object> noDocumentProperties))
Assert.Fail("Failed to load properties with no documents.");
Assert.IsNotEmpty(noDocumentProperties);
Assert.AreEqual("myDocs_", noDocumentProperties.First());
}
See Also: IPropertyDatabaseView.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 IPropertyDatabaseView.GetObjectFromRecordValue.
// Load all values associated with a document, not deserialized.
using (var view = propertyDatabase.GetView())
{
var myAssetDocumentKey = view.CreateDocumentKey("path/to/my/asset");
if (!view.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 = view.GetValueFromRecord<object>(myDocumentRecord.value);
deserializedValues.Add(myDocumentRecord.key, value);
}
Assert.AreEqual(5, deserializedValues.Count);
}
See Also: IPropertyDatabaseView.CreateDocumentKey.