Can't find any content

Error loading documents tree: Nothing found

  1. Epic GamesDeveloper
  3. FMassEntityView

FMassEntityView

The type representing a single entity in a single archetype.

API > API/Plugins > API/Plugins/MassEntity

References

   
Module MassEntity
Header /Engine/Plugins/Runtime/MassEntity/Source/MassEntity/Public/MassEntityView.h
Include #include "MassEntityView.h"

Syntax

USTRUCT ()  
struct FMassEntityView

Remarks

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.

Constructors

  Type Name Description
Public function    
Public function  

FMassEntityView ( const FMassArchetypeHandle& ArchetypeHandle,
FMassEntityHandle Entity
)

 Resolves Entity against ArchetypeHandle.
Public function  

FMassEntityView ( const FMassEntityManager& EntityManager,
FMassEntityHandle Entity
)

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

Functions

  Type Name Description
Public function Const const T & Will fail a check if the viewed entity doesn't have the given const shared fragment
Public function Const const T * If the viewed entity doesn't have the given const shared fragment the function will return null
Public function Const FConstStructView

GetConstSharedFragmentDataStruct ( const UScriptStruct* FragmentType
)

  
Protected function Const const void *

GetConstSharedFragmentPtr ( const UScriptStruct& FragmentType
)

  
Protected function Const const void *

GetConstSharedFragmentPtrChecked ( const UScriptStruct& FragmentType
)

  
Public function Const FMassEntityHandle  
Public function Const T & Will fail a check if the viewed entity doesn't have the given fragment
Public function Const T * If the viewed entity doesn't have the given fragment the function will return null
Public function Const FStructView

GetFragmentDataStruct ( const UScriptStruct* FragmentType
)

  
Protected function Const void *

GetFragmentPtr ( const UScriptStruct& FragmentType
)

  
Protected function Const void *

GetFragmentPtrChecked ( const UScriptStruct& FragmentType
)

  
Public function Const T & Will fail a check if the viewed entity doesn't have the given shared fragment
Public function Const T * If the viewed entity doesn't have the given shared fragment the function will return null
Protected function Const void *

GetSharedFragmentPtr ( const UScriptStruct& FragmentType
)

  
Protected function Const void *

GetSharedFragmentPtrChecked ( const UScriptStruct& FragmentType
)

  
Public function Const bool

HasTag ()

  
Protected function Const bool

HasTag ( const UScriptStruct& TagType
)

  
Public function Const bool

IsSet ()

  
Public function Const bool

IsValid ()

  
Public function 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.

Operators

  Type Name Description
Public function Const bool

operator== ( const FMassEntityView& Other
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page