Navigation
API > API/Plugins > API/Plugins/MassSpawner
A finalized and const wrapper for FMassEntityTemplateData, associated with a Mass archetype and template ID. Designed to never be changed. If a change is needed a copy of the hosted FMassEntityTemplateData needs to be made and used to create another finalized FMassEntityTemplate (via FMassEntityTemplateManager).
| Name | FMassEntityTemplate |
| Type | struct |
| Header File | /Engine/Plugins/Runtime/MassGameplay/Source/MassSpawner/Public/MassEntityTemplate.h |
| Include Path | #include "MassEntityTemplate.h" |
Syntax
struct FMassEntityTemplate : public TSharedFromThis< FMassEntityTemplate >
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FMassEntityTemplate
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| MassEntityTemplate.h | |||
FMassEntityTemplate
(
const FMassEntityTemplateData& InData, |
MassEntityTemplate.h | ||
FMassEntityTemplate
(
FMassEntityTemplateData&& InData, |
MassEntityTemplate.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| TSharedFromThis< FMassEntityTemplate > | friend | MassEntityTemplate.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Archetype | FMassArchetypeHandle | MassEntityTemplate.h | ||
| TemplateData | FMassEntityTemplateData | MassEntityTemplate.h | ||
| TemplateID | FMassEntityTemplateID | MassEntityTemplate.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UE::Mass::FEntityBuilder CreateEntityBuilder
(
const TSharedRef< FMassEntityManager >& InEntityManager |
MassEntityTemplate.h | ||
FString DebugGetArchetypeDescription
(
FMassEntityManager& EntityManager |
MassEntityTemplate.h | ||
FString DebugGetDescription
(
FMassEntityManager* EntityManager |
MassEntityTemplate.h | ||
const FMassArchetypeHandle & GetArchetype() |
MassEntityTemplate.h | ||
const FMassArchetypeCompositionDescriptor & GetCompositionDescriptor() |
MassEntityTemplate.h | ||
TConstArrayView< FInstancedStruct > GetInitialFragmentValues() |
MassEntityTemplate.h | ||
TConstArrayView< FMassEntityTemplateData::FObjectFragmentInitializerFunction > GetObjectFragmentInitializers() |
FMassEntityTemplateData getters. | MassEntityTemplate.h | |
const FMassArchetypeSharedFragmentValues & GetSharedFragmentValues() |
MassEntityTemplate.h | ||
const FMassEntityTemplateData & GetTemplateData() |
MassEntityTemplate.h | ||
FMassEntityTemplateID GetTemplateID() |
MassEntityTemplate.h | ||
const FString & GetTemplateName() |
MassEntityTemplate.h | ||
bool IsValid() |
MassEntityTemplate.h | ||
void SetArchetype
(
const FMassArchetypeHandle& InArchetype |
InArchetype is expected to be valid. The function will crash-check it. | MassEntityTemplate.h | |
void SetTemplateID
(
FMassEntityTemplateID InTemplateID |
MassEntityTemplate.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static TSharedRef< FMassEntityTemplate > MakeFinalTemplate
(
FMassEntityManager& EntityManager, |
MassEntityTemplate.h |