Detailed Description

A collection of custom properties related to some asset.

Inheritance diagram for Doloro.DataManagement.AssetPropertiesSystem.AssetPropertiesCollection:

[legend]

Collaboration diagram for Doloro.DataManagement.AssetPropertiesSystem.AssetPropertiesCollection:

[legend]

Classes
class	ProperiesDomain
	Implements API for the layer relayed features. More...

Public Member Functions
void	Add (AssetProperty property)
	Adds property to the register. More...

void	Clear ()
	Clears entire register.

bool	Contains (string propertyPath)
	Checks is the property by the path exists. More...

bool	Contains (AssetProperty property)
	Checks is the property by the path exists. More...

void	CopyTo (AssetProperty[] array, int arrayIndex)
	Copying properties to array. More...

IEnumerator< AssetProperty >	GetEnumerator ()
	Returns enumerator of entire asset properties. More...

IEnumerator< AssetProperty >	GetDomainEnumerator (ProperiesDomain domain)
	Returns enumerator of properties placed to the certain domain layer. More...

bool	Remove (string propertyPath)
	Removes property from the register. More...

bool	Remove (AssetProperty property)
	Removes property from the register. More...

ProperiesDomain	FindDomain (string domainPath)
	Looking for domain by the path. More...

ProperiesDomain	FindPropertyDomain (string propertyPath, out string propertyKey)
	Looking for layer by the full property path. More...

void	SetDirty ()
	Bakes runtime data from the Register property to the serializable binaryRegister. More...

bool	TryReadFromBinary (byte[] data)
	Attempts to read the binary as ProperiesDomain. Applies result to Register in case is operation has been successful. More...

void	ReadFromBinary (byte[] data)
	Drops current Register and loads new one from the binary data. More...

byte[]	ToBinary ()
	Converts Register to binary view. More...

object	Clone ()
	Creates new game object with cloned properties. More...

Properties
int	Count `[get]`
	Elements in register's hierarchy.

bool	IsReadOnly `[get]`
	Always false.

ProperiesDomain	Register `[get, set]`
	Ground properties layer.

AssetProperty	this[string path] `[get]`
	Provides access to property by path. More...

Events
Action< AssetProperty >	PropertyAdded
	Occurs when new property added.

Action< AssetProperty >	PropertyRemoved
	Occurs when property removed.

Member Function Documentation

◆ Add()

void Doloro.DataManagement.AssetPropertiesSystem.AssetPropertiesCollection.Add ( AssetProperty property )

Adds property to the register.

Parameters

property Property to add.

Exceptions

ArgumentNullException	`property` is null.
ArgumentException	`property`.`FullPath` is null of white space.
EntryAlreadyExistsException	Occurs when you try to add property to the path that already exist or can't be expanded.

◆ Clone()

object Doloro.DataManagement.AssetPropertiesSystem.AssetPropertiesCollection.Clone ( )

Creates new game object with cloned properties.

Returns

◆ Contains() [1/2]

bool Doloro.DataManagement.AssetPropertiesSystem.AssetPropertiesCollection.Contains ( AssetProperty property )

Checks is the property by the path exists.

Parameters

property Property instance to check.

Returns: Result of search.

◆ Contains() [2/2]

bool Doloro.DataManagement.AssetPropertiesSystem.AssetPropertiesCollection.Contains ( string propertyPath )

Checks is the property by the path exists.

Parameters

propertyPath Full path of the a property.

Returns: Result of search.

Implements Doloro.DataManagement.AssetPropertiesSystem.IPropertiesProvider.

◆ CopyTo()

void Doloro.DataManagement.AssetPropertiesSystem.AssetPropertiesCollection.CopyTo	(	AssetProperty[]	array,
		int	arrayIndex
	)

Copying properties to array.

Parameters

array	Destination array.
arrayIndex	Start index at the destination array.

◆ FindDomain()

ProperiesDomain Doloro.DataManagement.AssetPropertiesSystem.AssetPropertiesCollection.FindDomain ( string domainPath )

Looking for domain by the path.

Parameters

domainPath Domains splitted with the dot char.

Returns: Domain in case if found. Null otherwise.

◆ FindPropertyDomain()

ProperiesDomain Doloro.DataManagement.AssetPropertiesSystem.AssetPropertiesCollection.FindPropertyDomain	(	string	propertyPath,
		out string	propertyKey
	)

Looking for layer by the full property path.

Parameters

propertyPath	Full property path.
propertyKey	Property key detected from the path.

Returns: Layer if exist. Null if not found.

◆ GetDomainEnumerator()

IEnumerator< AssetProperty > Doloro.DataManagement.AssetPropertiesSystem.AssetPropertiesCollection.GetDomainEnumerator ( ProperiesDomain domain )

Returns enumerator of properties placed to the certain domain layer.

Parameters

domain Domain to properties search.

Returns: Properties enumerator.

◆ GetEnumerator()

IEnumerator< AssetProperty > Doloro.DataManagement.AssetPropertiesSystem.AssetPropertiesCollection.GetEnumerator ( )

Returns enumerator of entire asset properties.

Returns: Properties enumerator.

◆ ReadFromBinary()

void Doloro.DataManagement.AssetPropertiesSystem.AssetPropertiesCollection.ReadFromBinary ( byte[] data )

Drops current Register and loads new one from the binary data.

Parameters

data	Binary source generated with the SetDirty handler.

Implements Doloro.DataManagement.Serialization.IBinaryDataProvider.

◆ Remove() [1/2]

bool Doloro.DataManagement.AssetPropertiesSystem.AssetPropertiesCollection.Remove ( AssetProperty property )

Removes property from the register.

Parameters

property Property to remove.

Exceptions

ArgumentNullException	`property` is null.
ArgumentException	`property`.`FullPath` is null of white space.
EntryAlreadyExistsException	Occurs when you try to add property to the path that already exist or can't be expanded.

◆ Remove() [2/2]

bool Doloro.DataManagement.AssetPropertiesSystem.AssetPropertiesCollection.Remove ( string propertyPath )

Removes property from the register.

Parameters

propertyPath Full path to property.

Exceptions

ArgumentException	`property`.`FullPath` is null of white space.
EntryAlreadyExistsException	Occurs when you try to add property to the path that already exist or can't be expanded.

◆ SetDirty()

void Doloro.DataManagement.AssetPropertiesSystem.AssetPropertiesCollection.SetDirty ( )

Bakes runtime data from the Register property to the serializable binaryRegister.

Should be called each time when Register has been modified with editor tool.

◆ ToBinary()

byte[] Doloro.DataManagement.AssetPropertiesSystem.AssetPropertiesCollection.ToBinary ( )

Converts Register to binary view.

Returns

Implements Doloro.DataManagement.Serialization.IBinaryDataProvider.

◆ TryReadFromBinary()

bool Doloro.DataManagement.AssetPropertiesSystem.AssetPropertiesCollection.TryReadFromBinary ( byte[] data )

Attempts to read the binary as ProperiesDomain. Applies result to Register in case is operation has been successful.

Parameters

data	Binary data to read.

Returns: true in case if data has been restored to objects without exceptions.

Implements Doloro.DataManagement.Serialization.IBinaryDataProvider.

Property Documentation

◆ this[string path]

AssetProperty Doloro.DataManagement.AssetPropertiesSystem.AssetPropertiesCollection.this[string path]

get

Provides access to property by path.

Parameters

path	Path to property in internal hierarchy.

Returns: Reference to property. Null if not found.

Implements Doloro.DataManagement.AssetPropertiesSystem.IPropertiesProvider.

The documentation for this class was generated from the following file:

D:/Work/GitHub/DGDK22/Assets/Tauri Interactive/Doloro-GDK/Doloro-Data-Management/Runtime/Asset Properties System/Components/AssetPropertiesCollection.cs

Detailed Description

Classes

Public Member Functions

Properties

Events

Member Function Documentation

◆ Add()

◆ Clone()

◆ Contains() [1/2]

◆ Contains() [2/2]

◆ CopyTo()

◆ FindDomain()

◆ FindPropertyDomain()

◆ GetDomainEnumerator()

◆ GetEnumerator()

◆ ReadFromBinary()

◆ Remove() [1/2]

◆ Remove() [2/2]

◆ SetDirty()

◆ ToBinary()

◆ TryReadFromBinary()

Property Documentation

◆ this[string path]