1. Epic GamesDeveloper
  3. UMassAgentComponent

UMassAgentComponent

There are two primary use cases for this component:

API > API/Plugins > API/Plugins/MassActors

Inheritance Hierarchy

References

   
Module MassActors
Header /Engine/Plugins/Runtime/MassGameplay/Source/MassActors/Public/MassAgentComponent.h
Include #include "MassAgentComponent.h"

Syntax

UCLASS&40;Blueprintable, ClassGroup&61;Mass, Meta&61;&40;BlueprintSpawnableComponent&41;,  
       HideCategories&61;&40;Sockets, Collision&41;&41;  
class UMassAgentComponent : public UActorComponent

Remarks

There are two primary use cases for this component:

If placed on an AActor blueprint can it lets the used specify additional fragments that will be created for entities spawned based on this given blueprint.

If present present on an actor in the world it makes it communicate with the MassSimulation which will create an entity representing given actor. Use case 1) will also applicable in this case. The component is unregistered by default and requires manual enabling via a 'Enable' call

Variables

  Type Name Description
Protected variable FMassEntityHandle AgentHandle  
Protected variable UProperty Category, EditAnywhere uint32: 1 bAutoRegisterInEditorMode  
Protected variable UProperty Category, EditAnywhere FMassEntityConfig EntityConfig  
Protected variable UProperty replicatedusing FMassNetworkID NetID  
Protected variable FMassArchetypeCompositionDescriptor PuppetSpecificAddition Contains all the fragments added to the entity during puppet's initialization.
Protected variable EAgentComponentState State  
Protected variable FMassEntityTemplateID TemplateID  

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void  
Protected function void  
Public function void  
Protected function void  
Public function UFunction BlueprintCallable, Category void

Disable ()

 Registers the component with the owner effectively turning it off
Public function UFunction BlueprintCallable, Category void

Enable ()

 Registers the component with the owner effectively turning it on.
Public function void  
Public function void  
Public function Const const FMassEntityConfig &  
Public function Const FMassEntityHandle Methods handling the state for actors that needs mass entity creation
Public function FMassArchetypeCompositionDescriptor &  
Public function Const FMassNetworkID  
Public function Const const FMassArchetypeCompositionDescriptor &  
Public function Const FMassEntityTemplateID  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function UFunction BlueprintCallable, Category void

KillEntity ( const bool bDestroyActor
)

  
Public function void  
Public function Virtual UFunction void  
Public function void

PausePuppet ( const bool bPause
)

 Re-adds/Removes all puppet fragments added on the mass agent This is only supported in Puppet flow
Public function void  
Public function void  
Public function void  
Public function void Methods handling the state of a server replicated puppet
Public function void  
Public function void Support poolable mass agents going into stasis.
Public function void

SetEntityConfig ( const FMassEntityConfig& InEntityConfig
)

  
Public function void

SetEntityHandle ( const FMassEntityHandle NewHandle
)

  
Protected function void  
Public function void

SetPuppetHandle ( const FMassEntityHandle NewHandle
)

 Methods handling the state of puppet actors that needs fragments initialization
Public function void  
Protected function void  
Public function void  

Overridden from UActorComponent

  Type Name Description
Protected function Virtual void Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
Protected function Virtual void Called when a component is unregistered.

Overridden from UObject

  Type Name Description
Public function Virtual Const void Returns properties that are replicated for the lifetime of the actor channel
Protected function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Protected function Virtual void Do any object-specific cleanup required immediately after loading an object.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page