1. Epic GamesDeveloper
  3. FMassEntityView

FMassEntityView

The type representing a single entity in a single archetype.

API > API/Runtime > API/Runtime/MassEntity

The type representing a single entity in a single archetype. It's of a very transient nature so we guarantee it's validity only within the scope it has been created in. Don't store it.

   
Name FMassEntityView
Type struct
Header File /Engine/Source/Runtime/MassEntity/Public/MassEntityView.h
Include Path #include "MassEntityView.h"

Syntax

USTRUCT ()  
struct FMassEntityView

Constructors

Name Remarks Include Path Unreal Specifiers

FMassEntityView ( const FMassArchetypeHandle& ArchetypeHandle,
FMassEntityHandle Entity
)

 Resolves Entity against ArchetypeHandle. MassEntityView.h  

FMassEntityView ( const FMassEntityManager& EntityManager,
FMassEntityHandle Entity
)

 Finds the archetype Entity belongs to and then resolves against it. MassEntityView.h  
  MassEntityView.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
Archetype FMassArchetypeData *   MassEntityView.h  
Entity FMassEntityHandle   MassEntityView.h  
EntityDataHandle FMassEntityInChunkDataHandle   MassEntityView.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

const T & GetConstSharedFragmentData()

 Will fail a check if the viewed entity doesn't have the given const shared fragment MassEntityView.h  

const T * GetConstSharedFragmentDataPtr()

 If the viewed entity doesn't have the given const shared fragment the function will return null MassEntityView.h  

FConstStructView GetConstSharedFragmentDataStruct ( const UScriptStruct* FragmentType
) const

   MassEntityView.h  

FMassEntityHandle GetEntity()

   MassEntityView.h  

T & GetFragmentData()

 Will fail a check if the viewed entity doesn't have the given fragment MassEntityView.h  

T * GetFragmentDataPtr()

 If the viewed entity doesn't have the given fragment the function will return null MassEntityView.h  

FStructView GetFragmentDataStruct ( const UScriptStruct* FragmentType
) const

   MassEntityView.h  
  MassEntityView.h  
Will fail a check if the viewed entity doesn't have the given shared fragment MassEntityView.h  
  MassEntityView.h  
If the viewed entity doesn't have the given shared fragment the function will return null MassEntityView.h  

FStructView GetSharedFragmentDataStruct ( const UScriptStruct* FragmentType
) const

   MassEntityView.h  

bool HasTag ()

   MassEntityView.h  

bool HasTag ( const UScriptStruct& TagType
) const

   MassEntityView.h  

bool IsSet()

 INLINES. MassEntityView.h  

bool IsValid()

   MassEntityView.h  

Protected

Name Remarks Include Path Unreal Specifiers

const void * GetConstSharedFragmentPtr ( const UScriptStruct& FragmentType
) const

   MassEntityView.h  

const void * GetConstSharedFragmentPtrChecked ( const UScriptStruct& FragmentType
) const

   MassEntityView.h  

void * GetFragmentPtr ( const UScriptStruct& FragmentType
) const

   MassEntityView.h  

void * GetFragmentPtrChecked ( const UScriptStruct& FragmentType
) const

   MassEntityView.h  

void * GetSharedFragmentPtr ( const UScriptStruct& FragmentType
) const

   MassEntityView.h  

void * GetSharedFragmentPtrChecked ( const UScriptStruct& FragmentType
) const

   MassEntityView.h  

Static

Name Remarks Include Path Unreal Specifiers

static FMassEntityView TryMakeView ( const FMassEntityManager& EntityManager,
FMassEntityHandle Entity
)

 If the given handle represents a valid entity the function will create a FMassEntityView just like a constructor would. MassEntityView.h  

Operators

Name Remarks Include Path Unreal Specifiers

bool operator== ( const FMassEntityView& Other
) const

   MassEntityView.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page