Skip to main content

Properties

Properties are attributes on an object, that describe certain object state. For example, a Button in a user interface may have an icon property to provide some visual indicator of what the button does.

Property types

Properties are associated with a specific data type, such as Boolean, Integer, or Float, but can also be represented by more complex types such as Object, Array, Dictionary, or specialized packed array types. Properties are specifically color coded for easy identification, just like variables.

Accessing properties

Properties can be accessed in two ways: by using the Get node (called an accessor) or the Set node (called a mutator).

You can create a Set or Get node for a property by:

  1. Right-clicking in the graph or dragging a connection from an existing node
  2. In the All Actions dialog, search for the property of interest, i.e. Get Position.
  3. Make sure that the selection has an icon similar to
    and not
    on the right.
  4. Either press the Add button or simply hit Enter.

Using Property nodes allows an Orchestration to read or modify the state of that property. For example, a character controller would update the Position property each frame based on input.

Get property

The property Get node accesses the current value of a property. These nodes do not have execution control flow pins as they're designed to specifically return a single value to be used as input values to other nodes.

Set property

The property Set node updates or modifies the value of a property. These nodes have execution control flow pins as they're designed to be called in a sequence chain. These nodes also have an input pin based on the property's type to set the property value with.