Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
CIGI Client Plugin
Rendering-Related Classes

Organizing Properties

UNIGINE properties are organized in a hierarchy and managed via the Properties Hierarchy window.

Properties Hierarchy Window

The Properties Hierarchy window provides access to all properties of the project and allows filtering them by names, collapsing properties hierarchy (i.e., showing only the base properties and hiding the user ones), inheriting, cloning, renaming, and deleting properties.

Notice
Properties don't support reparenting.

All properties in the hierarchy are linked to .prop files stored in the assets folder of the project and available via the Asset Browser.

To open the Properties Hierarchy window, choose Windows -> Toggle Property Hierarchy in the Menu Bar.

Creating a Property

A property can be created via UnigineEditor in one of the following ways:

The new property is automatically added to the properties hierarchy and displayed in the Properties Hierarchy window. The asset, to which the new property links, is also created and becomes available via the Asset Browser.

Notice
Properties in the hierarchy are sorted alphabetically by names, so you cannot rearrange them.

Basic Operations on a Property

The Properties Hierarchy window allows the following basic operations on a property.

Renaming a Property

To rename a property, right-click it and choose Rename in the drop-down list.

Renaming a Property

You can also rename a property asset via the Asset Browser: the property that links to it will be renamed as well.

Cloning a Property

To clone a property, right-click it and choose Clone in the drop-down list.

Cloning a Property

Another way to clone a property is to select it and click to the left of the property name filter.

Notice
Only the user properties can be cloned. Cloning a property leads creating an asset file, to which the new property links.
The new property will be created at the same hierarchy level as the original one. Note that the child properties won't be cloned.

If you copy a property asset via the Asset Browser, the property that links to it will be cloned.

Deleting a Property

To delete a property, right-click it, choose Delete in the drop-down list and confirm deletion in the dialog window that opens:

Deleting a Property

Another way to delete a property is to select it and click to the left of the property name filter. If you delete a parent property, all its children will be deleted as well.

Notice
Deleting a property leads deleting the asset file it is linked. You cannot undo property's deletion.

If you delete a property file via the Asset Browser, the property that links to it will also be deleted from the hierarchy.

Inheriting a Property

Inheriting one property from another allows forming the properties hierarchy. To inherit a new property from the existing one, right-click the desired parent property and choose Inherit in the drop-down list.

Inheriting a Property

Another way to inherit a property is to select it and click to the left of the property name filter.

Notice
Inheriting a property leads creating a new asset file.

Inheriting via Asset Browser

To inherit a property via the Asset Browser, select the property asset, right-click it and choose Inherit in the drop-down list. The new property will be added to the Properties Hierarchy window and linked to the created asset.

Inheriting a Property via Asset Browser

Assigning a Property

A property can be assigned both to the whole node and the single surface. For example:

  • A property assigned to the node can specify additional settings that extend the built-in ones.
  • A property assigned to the surface can specify settings that can be used during physical interaction with the surface.
Notice
It is recommended to assign properties inherited from the node_base property to nodes. If you need to assign a property to a single surface, inherit it from the surface_base property. However, you can also assign a custom base property or its children.

To assign a property, select the node, select the target surface (surfaces) (if required) and perform one of the following:

Notice
To assign a property to all of the node surfaces, selecting the node will be enough: the property will be assigned to all its surfaces.
  • Drag the property from the Properties Hierarchy window or the icon of the property asset from the Asset Browser to the Node Property or Surface Property field in the Parameters window.

  • Drag the property from the Properties Hierarchy window or the icon of the property asset from the Asset Browser to the target node or surface in the Scene Viewport.

  • Use the button next to the field with the property asset name in the Parameters window to choose the desired property asset.

  • Type the name of the property asset to the field with the property asset name in the Parameters window manually. If an asset with the specified name exists in the project, it will be shown in the drop-down list while typing.

Last update: 2017-12-21