Differences

This shows you the differences between two versions of the page.

--- en:toolworks:docs:apparatus:trait [2021/06/11 15:41] – created vladius
+++ en:toolworks:docs:apparatus:trait [2022/06/07 10:53] (current) – Fix structure name. jispar
@@ Line 1: / Line 1: @@
 ====== Trait ======
-Traits are low-level data blocks (components) comprising subjects. Unlike [[en:toolworks:docs:apparatus:detail|Details]], Traits are plain UStruct data. They are managed manually by the framework in a cache-efficient manner are mainly targeted towards the runtime performance.
+Traits are low-level data blocks (components) comprising subjects. Unlike [[en:toolworks:docs:apparatus:detail|Details]], Traits are plain UStruct data. They are managed manually by the framework in a cache-efficient manner and mainly targeted towards the runtime performance.
+===== Changing Traits =====
+The Trait data is what called value-type in some languages. The behavior is somewhat native for UE environment. This basically means that in order to change a Trait's data you have to read it, change it afterwards and finally write it back re-applying it to the Subject. This procedure is necessary to guarantee the atomic and secure nature of the Trait types. Don't be too much scared by this copying routine since the procedure has some very high chances of being cache-local.
+===== Garbage Collection Notes =====
+As it was already said earlier Apparatus uses its own low-level memory model to store Traits efficiently. This comes at a certain cost. Basically you have to manually guarantee the safety for references to other UObjects (Actors, Components, etc) within your Traits, since those should be refernce-counted by the Garbage Collector which is absent.
+Luckily, you can do it quite easily by referencing the same objects a certain asset or object via some global GC-managed UObject instance and retaining them this way. This global object may also be [[ue>API/Runtime/CoreUObject/UObject/UObjectBaseUtility/AddToRoot/|added to root]] to be retained. You may also add the referenced objects to root explicitly, before assigning them to Trait properties.
+Referencing other Subjects via Subject Handles is perfectly fine though and is managed by Apparatus itself. Only remember that those Handles are like weak references. They don't hold the Subject referenced, they just invalidate themselves when the Subject is destroyed (despawned).
 ===== Creating Traits =====
@@ Line 11: / Line 23: @@
 You should mainly refer to the official Unreal Engine manual on creating [[ue>ProgrammingAndScripting/GameplayArchitecture/Structs/UsingStructs|UStructs]].
-==== Garbage Collection Notes ====
+You basically create a header (''.h'') file and optionally a source (''.cpp'') file. An example of such header-only Trait would be:<code cpp>
+#pragma once
-As it was already said earlier Apparatus uses its own low-level memory model to store Traits efficiently. This comes at a certain cost. Basically you have to manually guarantee the safety for references to other UObjects (Actors, Components, etc) within your Traits, since those should be refernce-counted by the Garbage Collector which is absent.
+#include "CoreMinimal.h"
+#include "Moving.generated.h"
-Luckily, you can do it quite easily by referencing the same objects a certain asset or object via some global GC-managed UObject instance and retaining them this way. This global object may also be [[ue>API/Runtime/CoreUObject/UObject/UObjectBaseUtility/AddToRoot/|added to root]] to be retained. You may also add the referenced objects to root explicitly, before assigning them to Trait properties.
+/**
+ * The state of being moved with a certain velocity.
+ */
+USTRUCT(BlueprintType)
+struct MY_API FMoving
+{
+	GENERATED_BODY()
-Referencing other Subjects via Subject Handles is perfectly fine though and is managed by Apparatus itself. Only remember that those Handles are like weak references. They don't hold the Subject referenced, they just invalidate themselves when the Subject is destroyed (despawned).
+  public:
+	UPROPERTY(BlueprintReadWrite, EditAnywhere)
+	float VelocityX = 0;
+	UPROPERTY(BlueprintReadWrite, EditAnywhere)
+	float VelocityY = 0;
+};
+</code>
+You could omit the [[ue>ProgrammingAndScripting/GameplayArchitecture/Properties|UPROPERTY]] specifications but
+with the fields exposed like that you can now use ''FMoving'' both in your C++ code and within BPs.
+==== Blueprint Workflow ====
+As basically every Unreal Engine's ''USTRUCT'' is actually a Trait creating one through the Editor is quite simple. Rigth-Click on some empty space inside the Content Browser and choose **Blueprints** → **Structure**.
+{{ :en:toolworks:docs:apparatus:ue-create-bp-struct.png?nolink |}}
+This will create a new asset file right inside the designated folder. You should give it an appropriate name after that.
+{{ :en:toolworks:docs:apparatus:ue-name-bp-struct.png?nolink |}}
+That's basically it and from now on the created structure can be used right inside your [[en:toolworks:docs:apparatus:filter|Filters]].