1. Epic GamesDeveloper
  3. AMassSpawner

AMassSpawner

A spawner you can put on a map and configure it to spawn different things

API > API/Plugins > API/Plugins/MassSpawner

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;HideCategories&61;&40;Object, Actor, Input, Rendering, LOD, Cooking, Collision, HLOD, Partition&41;&41;  
class AMassSpawner : public AActor

Remarks

A spawner you can put on a map and configure it to spawn different things

Variables

  Type Name Description
Protected variable TArray< FMassEntitySpawnDataGeneratorResult > AllGeneratedResults  
Protected variable TArray< FSpawnedEntities > AllSpawnedEntities  
Protected variable UProperty Category, EditAnywhere uint32: 1 bAutoSpawnOnBeginPlay  
Protected variable UProperty Category, EditAnywhere uint32: 1 bOverrideSchematics By default TickSchematics will be appended to the simulation's schematics.
Protected variable UProperty Category, EditAnywhere int32 Count  
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite TArray< FMassSpawnedEntityType > EntityTypes Array of entity types to spawn. These define which entities to spawn.
Public variable UProperty BlueprintAssignable FMassSpawnerOnDespawningFinishedEvent OnDespawningFinishedEvent Called once DoDespawning completes and all mass agents spawned by this spawner have been despawned.
Protected variable FDelegateHandle OnPostWorldInitDelegateHandle  
Public variable UProperty BlueprintAssignable FMassSpawnerOnSpawningFinishedEvent OnSpawningFinishedEvent Called once DoSpawning completes and all entities have been spawned.
Protected variable UProperty TArray< TObjectPtr< UMassProcessor > > PostSpawnProcessors  
Protected variable FDelegateHandle SimulationStartedHandle  
Protected variable UProperty Category, EditAnywhere TArray< FMassSpawnDataGenerator > SpawnDataGenerators Array of entity spawn generators. These define where to spawn entities.
Protected variable UProperty Category, EditAnywhere float SpawningCountScale Scale of the spawning count
Protected variable TSharedPtr< FStreamableHandle > StreamingHandle  

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category callineditor void Remove all the entities
Public function UFunction BlueprintCallable, Category callineditor void  
Public function bool

DespawnEntity ( const FMassEntityHandle Entity
)

 If given entity has been spawned by this MassSpawner instance then it will get destroyed and all the book keeping updated.
Public function UFunction BlueprintCallable, Category void Despawn all mass agent that was spawned by this spawner
Public function void

DoDespawning ( TConstArrayView< FMassEntityHandle > EntitiesToIgnore
)

 Despawn all mass agent that was spawned by this spawner, except EntitiesToIgnore.
Public function UFunction BlueprintCallable, Category void Starts the spawning of all the agent types of this spawner
Public function Const UFunction BlueprintCallable, Category int32  
Protected function UMassProcessor *  
Protected function Const int32  
Public function Const UFunction BlueprintCallable, Category float  
Protected function void  
Protected function void  
Protected function void  
Public function UFunction BlueprintCallable, Category void

ScaleSpawningCount ( float Scale
)

 Scales the spawning counts
Protected function void  
Public function UFunction BlueprintCallable, Category void  

Overridden from AActor

  Type Name Description
Protected function Virtual void Overridable native event for when play begins for this actor.
Protected function Virtual void

EndPlay ( const EEndPlayReason::Type EndPlayReason
)

 Overridable function called whenever this actor is being removed from a level
Protected function Virtual void Called after all the components in the Components array are registered, called both in editor and during gameplay.

Overridden from UObject

  Type Name Description
Protected function Virtual void Called before destroying the object.
Protected function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Protected function Virtual void Do any object-specific cleanup required immediately after loading an object.

Classes

  Type Name Description
Protected struct FSpawnedEntities    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page