1. Epic GamesDeveloper
  3. UMassActorSpawnerSubsystem

UMassActorSpawnerSubsystem

A subsystem managing spawning of actors for all mass subsystems

API > API/Plugins > API/Plugins/MassActors

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;&41;  
class UMassActorSpawnerSubsystem : public UWorldSubsystem

Remarks

A subsystem managing spawning of actors for all mass subsystems

Variables

  Type Name Description
Protected variable UProperty TArray< TObjectPtr< AActor > > ActorsToDestroy  
Protected variable bool bActorPoolingEnabled  
Protected variable UProperty TArray< TObjectPtr< AActor > > DeactivatedActorsToDestroy  
Protected variable int32 NumActorPooled  
Protected variable int32 NumActorSpawned  
Protected variable TMap< TSubclassOf< AActor >, TArray< TObjectPtr< AActor > > > PooledActors  
Protected variable std::atomic< uint32 > RequestSerialNumberCounter  
Protected variable FMassEntityHandleManager_ActorSpawnRequest SpawnRequestHandleManager  
Protected variable UProperty TArray< FInstancedStruct > SpawnRequests  

Functions

  Type Name Description
Public function Static void  
Public function void

DestroyActor ( AActor* Actor,
bool bImmediate
)

 Destroy an actor
Public function void  
Public function void  
Public function T & Returns the stored spawn request from the handle, useful to update the transform
Protected function Virtual Const FMassActorSpawnRequestHandle Retrieve what would be the next best spawning request to spawn, can be overridden to have different logic Default implementation is the first valid request in the list, no interesting logic yet
Public function Const const T &

GetSpawnRequest ( const FMassActorSpawnRequestHandle SpawnRequestHandle
)

 Returns the stored spawn request from the handle, useful to update the transform
Protected function void

OnPrePhysicsPhaseFinished ( const float DeltaSeconds
)

 Called at the end of the PrePhysics mass processing phase and calls ProcessPendingDestruction
Protected function void

OnPrePhysicsPhaseStarted ( const float DeltaSeconds
)

 Called at the start of the PrePhysics mass processing phase and calls ProcessPendingSpawningRequest
Protected function void

ProcessPendingDestruction ( const double MaxTimeSlicePerTick
)

 Go through the queued actors to destroy and destroy them until we reach the budget
Protected function void

ProcessPendingSpawningRequest ( const double MaxTimeSlicePerTick
)

 Go through the spawning request and spawn them until we reach the budget
Protected function bool Try releasing this actor to pool if possible
Public function void  
Public function bool Removes a spawn request The only time a spawn request cannot be removed is when its state is processing Also spawn requests are auto removed if you provided a spawn delegate after it was being executed.
Public function FMassActorSpawnRequestHandle

RequestActorSpawn ( const T& InSpawnRequest
)

 Request an actor to spawn Note: If you do not provide a spawn delegate, the requester is responsible to remove the request by hand.
Protected function FMassActorSpawnRequestHandle Internal generic request actor spawn to make sure the request derives from FMassActorSpawnRequest
Public function void Retries a failed spawn request
Protected function Virtual Const ESpawnRequestStatus

SpawnActor ( FConstStructView SpawnRequestView,
TObjectPtr< AActor >& OutSpawnedActor
)

 Actual code that will spawn the actor, overridable by subclass if need to be.
Protected function Virtual ESpawnRequestStatus

SpawnOrRetrieveFromPool ( FConstStructView SpawnRequestView,
TObjectPtr< AActor >& OutSpawnedActor
)

  

Overridden from USubsystem

  Type Name Description
Public function Virtual void Implement this for deinitialization of instances of the system
Public function Virtual void USubsystem BEGIN.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page