1. Epic GamesDeveloper
  3. UInstancedActorsComponent

UInstancedActorsComponent

Provides Mass Entity reference and interop functions for Actors spawned via Instanced Actors on both client & server.

API > API/Plugins > API/Plugins/InstancedActors

Inheritance Hierarchy

References

   
Module InstancedActors
Header /Engine/Plugins/Runtime/InstancedActors/Source/InstancedActors/Public/InstancedActorsComponent.h
Include #include "InstancedActorsComponent.h"

Syntax

UCLASS (ClassGroup="Instanced Actors", Meta=(BlueprintSpawnableComponent))  
class UInstancedActorsComponent : public UActorComponent

Remarks

Provides Mass Entity reference and interop functions for Actors spawned via Instanced Actors on both client & server.

Variables

  Type Name Description
Protected variable UProperty Category, Meta BlueprintReadOnly Transient replicatedusing FInstancedActorsInstanceHandle InstanceHandle Handle to the instance that spawned this Instanced Actor, if this component's Actor owner was spawned by the Instanced Actor system, invalid handle otherwise.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void If HasMassEntity(), adds a new default constructed FragmentType to this Instanced Actor's Mass entity, if not already present (no-op otherwise) Performed deferred using FMassCommandBuffer to safely add fragments, as Mass may currently be performing parallel processing.
Public function void

AddOrUpdateFragmentsDeferred ( FragmentTypes&&... NewFragments
)

 If HasMassEntity(), adds or updates existing FragmentTypes for this Instanced Actor's Mass entity.
Public function void

AddOrUpdatePersistentFragmentsDeferred ( FragmentTypes&&... NewFragments
)

 If HasMassEntity(), adds or updates existing FragmentTypes for this Instanced Actor's Mass entity, then requests a persistent data resave once the fragments are updated.
Public function Virtual Const uint32 Subclasses implementing SerializeInstancePersistenceData must implement this method and return a non-zero unique uint32 used to match serialized persistence records with this UInstancedActorsComponent's SerializeInstancePersistenceData implementation.
Public function Const FMassEntityHandle Handle to this Instanced Actor's Mass Entity, if this components Actor owner was spawned by the Instanced Actor system, invalid handle otherwise.
Public function Const TSharedPtr< FMassEntityManager > If HasMassEntity(), the Mass Entity Manager for MassEntityHandle
Public function Const FMassEntityManager &  
Public function Const const FragmentType * If HasMassEntity(), returns existing FragmentType fragment for this Instanced Actor's Mass Entity, if any.
Public function Const UFunction BlueprintPure, Category bool Returns true if this Actor was spawned by the Instanced Actor system for a Mass Entity.
Public function Virtual void Called on servers during InitializeComponent for Actors spawned by the Instanced Actor system.
Public function Virtual Const void

ModifyMassEntityConfig ( FMassEntityManager& InMassEntityManager,
UInstancedActorsData* InstancedActorData,
FMassEntityConfig& InOutMassEntityConfig
)

 Called on an 'exemplar' Actor's components for clients & servers during UInstancedActorsData::CreateEntityTemplate to provide UInstancedActorsComponent's an opportunity to extend Mass entity default traits.
Public function Virtual Const void

ModifyMassEntityTemplate ( FMassEntityManager& InMassEntityManager,
UInstancedActorsData* InstancedActorData,
FMassEntityTemplateData& InOutMassEntityTemplateData
)

 Called on ActorClass CDO components for clients & servers during UInstancedActorsData::CreateEntityTemplate to provide UInstancedActorsComponent's an opportunity to extend Mass entity default fragments.
Protected function UFunction void  
Public function Virtual void Called on servers before InitializeComponent & BeginPlay in UServerInstancedActorsSpawnerSubsystem::SpawnActor for Actors spawned by the Instanced Actor system.
Public function void If HasMassEntity(), removes FragmentType from this Instanced Actor's Mass entity, if present (no-op otherwise) Performed deferred using FMassCommandBuffer to safely add fragments, as Mass may currently be performing parallel processing.
Public function Virtual Const void Called by AInstancedActorsManager::SerializeInstancePersistenceData for IAD's with an ActorClass containing this UInstancedActorsComponent, to save / load extended persistence data.
Public function Virtual Const bool

ShouldSerializeInstancePersistenceData ( const FArchive& Archive,
UInstancedActorsData* InstanceData,
int64 TimeDelta
)

 Called prior to SerializeInstancePersistenceData for both saving & loading persistence data, to check if we indeed have persistence data to write / want to read.

Overridden from UActorComponent

  Type Name Description
Protected function Virtual void

EndPlay ( const EEndPlayReason::Type EndPlayReason
)

 Ends gameplay for this component.
Protected function Virtual void Initializes the component.

Overridden from UObject

  Type Name Description
Protected function Virtual Const void Returns properties that are replicated for the lifetime of the actor channel

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page