Cavrnus Unreal API - FlagComponents

Owned by Kyle
Last updated: Jul 18, 2024
2 min read

The header files in the FlagComponents folder relate to flagging or marking entities within the Cavrnus system (users, avatars, spawned objects). These components play a role in identifying and tracking these entities for collaboration.

The header files in the FlagComponents folder define three classes that are derived from USceneComponent so that components can be attached to actors with their own transform in the 3D Cavrnus Space. These flag components identify and track different entity types (users, avatars, spawned objects). They work in conjunction with other parts of the plugin to enable features like real-time synchronization, interaction, and communication between users:

Base Class (Common Features):

  • All three classes inherit from USceneComponent, allowing them to be placed in the 3D world and attached to actors.

  • They all have a UPROPERTY macro with the BlueprintReadWrite specifier, which means that their properties can be read and modified from both C++ code and Blueprints.

  • They are all declared within the CAVRNUSCONNECTOR_API macro, indicating that they are part of the public API of the Cavrnus Connector plugin.

Cavrnus User Avatar Flag:

  1. Purpose: This component is designed to be associated with a Cavrnus user's avatar. It likely helps identify and track the avatar within the collaborative space.

  2. Key Property:

    • CavrnusUser: A struct (FCavrnusUser) that holds information about the Cavrnus user associated with the avatar.

Cavrnus Local User Flag:

  1. Purpose: This component represents the local user (the user running the Unreal Engine instance) within the Cavrnus environment. It probably facilitates tracking the local user's position, actions, and interactions with other users and objects.

  2. Key Property:

    • LocalUser: A struct (FCavrnusUser) that stores details about the local user.

Cavrnus Spawned Object Flag:

  1. Purpose: This component is intended to be attached to spawned objects within the Cavrnus space. It likely helps identify and manage these objects, especially in collaborative scenarios where multiple users might be interacting with them.

  2. Key Property:

    • SpawnedObject: A struct (FCavrnusSpawnedObject) that contains information about the spawned object.The header files in the FlagComponents folder relate to flagging or marking entities within the Cavrnus system (users, avatars, spawned objects). These components play a role in identifying and tracking these entities for collaboration.