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

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

   
Name AMassSpawner
Type class
Header File /Engine/Plugins/Runtime/MassGameplay/Source/MassSpawner/Public/MassSpawner.h
Include Path #include "MassSpawner.h"

Syntax

UCLASS (MinimalAPI,  
       HideCategories=(Object, Actor, Input, Rendering, LOD, Cooking, Collision, HLOD, Partition))  
class AMassSpawner : public AActor

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

AMassSpawner()

   MassSpawner.h  

Structs

Name Remarks
FSpawnedEntities  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnDespawningFinishedEvent FMassSpawnerOnDespawningFinishedEvent Called once DoDespawning completes and all mass agents spawned by this spawner have been despawned. MassSpawner.h
  • BlueprintAssignable
OnSpawningFinishedEvent FMassSpawnerOnSpawningFinishedEvent Called once DoSpawning completes and all entities have been spawned. MassSpawner.h
  • BlueprintAssignable

Protected

Name Type Remarks Include Path Unreal Specifiers
SpriteComponent TObjectPtr< UBillboardComponent >   MassSpawner.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ClearTemplates()

   MassSpawner.h
  • BlueprintCallable
  • Category="Spawning"

void DEBUG_Clear()

 Remove all the entities MassSpawner.h
  • BlueprintCallable
  • CallInEditor
  • Category="Debug"

void DEBUG_Spawn()

   MassSpawner.h
  • BlueprintCallable
  • CallInEditor
  • Category="Debug"

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. MassSpawner.h  

void DoDespawning ()

 Despawn all mass agent that was spawned by this spawner MassSpawner.h
  • BlueprintCallable
  • Category="Spawning"

void DoDespawning ( TConstArrayView< FMassEntityHandle > EntitiesToIgnore
)

 Despawn all mass agent that was spawned by this spawner, except EntitiesToIgnore. MassSpawner.h  

void DoSpawning()

 Starts the spawning of all the agent types of this spawner MassSpawner.h
  • BlueprintCallable
  • Category="Spawning"

int32 GetCount()

   MassSpawner.h
  • BlueprintCallable
  • Category="Spawning"

float GetSpawningCountScale()

   MassSpawner.h
  • BlueprintCallable
  • Category="Spawning"

void ScaleSpawningCount ( float Scale
)

 Scales the spawning counts MassSpawner.h
  • BlueprintCallable
  • Category="Spawning"

void UnloadConfig()

   MassSpawner.h
  • BlueprintCallable
  • Category="Spawning"

Protected

Name Remarks Include Path Unreal Specifiers

UMassProcessor * GetPostSpawnProcessor ( TSubclassOf< UMassProcessor > ProcessorClass
)

   MassSpawner.h  

int32 GetSpawnCount()

   MassSpawner.h  

void OnPostWorldInit ( UWorld* World,
const UWorld::InitializationValues
)

   MassSpawner.h  

void OnSpawnDataGenerationFinished ( TConstArrayView< FMassEntitySpawnDataGeneratorResult > Results,
FMassSpawnDataGenerator* FinishedGenerator
)

   MassSpawner.h  

void RegisterEntityTemplates()

   MassSpawner.h  

void SpawnGeneratedEntities ( TConstArrayView< FMassEntitySpawnDataGeneratorResult > Results
)

   MassSpawner.h  

Overridden from AActor

Name Remarks Include Path Unreal Specifiers

virtual void BeginPlay()

   MassSpawner.h  

virtual void EndPlay ( const EEndPlayReason::Type EndPlayReason
)

   MassSpawner.h  

virtual void PostRegisterAllComponents()

   MassSpawner.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   MassSpawner.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   MassSpawner.h  

virtual void PostLoad()

   MassSpawner.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page