Generic Activity Framework

Plugin setup

Get the plugin up-and-running

Core interfaces

IGenericAgentActivityWorker

Backbone for all FAgentActivity workers

IGenericCrowdActivityWorker

Backbone for all FCrowdActivity workers

IGenericWorldActivityWorker

Backbone for all FWorldActivity workers

Related to Agent

FAgentActivity

Structure describing a performable agent activity

FAgentActivityCognitionTag

Tags that encapsulate cognition for AgentActivityWorkers specifically

Related to Crowd

FCrowdActivity

Structure describing a performable crowd activity

FCrowdActivityCognitionTag

Tags that encapsulate cognition for CrowdActivityWorkers specifically

Related to World

FWorldActivity

Structure describing a performable world activity

FWorldActivityCognitionTag

Tag that encapsulates cognition for WorldActivityWorkers specifically

Documentation

Unreal Engine 5.0

Unreal Engine 4.27

title placeholder

View on GitHub

About

While this framework doesn’t necessarily mandate a certain implementation pattern, it’s still written with a strong preconceived philosophy of how things (pure virtual functions) should be dealt with internally. That’s separately included inside a section labeled 'Recommended'.

From a high-level perspective, IGenericCrowdActivityWorker is a native-only interface embodying a crowd controller, capable of beginning/ending Agent Activities on the agents it manipulates.

Each IGenericCrowdActivityWorker can begin/end an FCrowdActivity, which represent a high-level task only crowds can perform.

Recommended

Crowd activities encapsulate a sequence of agent activities.

The logic it executes compliments its relative responsibility down the world-crowd-agent chain by solely being focused on how each crowd activity is carried out, without being aware of its higher strategic purpose.

IGenericWorldActivityWorker is responsible for each crowd activity, and may strategically spawn crowds for a certain purpose only it knows. It's seated in the most leveraged position.

IGenericWorldActivityWorker does not understand how each FCrowdActivity is carried out. Likewise,
IGenericCrowdActivityWorker does not understand how each FAgentActivity is carried out.

CrowdActivityCognition

Each IGenericCrowdActivityWorker has its own Scoped/Persistent CrowdActivityCognition tags, which are just GameplayTags mapped to the "AgentActivityCognition" base category.

Recommended

ubyte.dev endorses creating GameplayConcepts extending CrowdActivityCognition that:

Explicitly specify which problem they solve. Example: WorkerStrategyGameplayConcept (included by default) introduces a filtered variant of CrowdActivityCognition called CrowdActivityStrategy. This concept mandates that these tags always dynamically influence the underlying implementation of a CrowdActivity (as its name implies).
Explicitly manage their blueprint exposure. Example: WorkerStrategyGameplayConcept introduces BlueprintCallable methods for adding/removing CrowdActivityStrategy tags. While this concept is pretty simple, any other concept might require additional encapsulation and/or properties before truly exposing itself to the blueprint surface.

Blueprints should never be able to add/remove unencapsulated CrowdActivityCognition tags. It's only permitted through blueprint-exposed concepts that extend CrowdActivityCognition (e.g. CrowdActivityStrategy).