FMassEntityView

The type representing a single entity in a single archetype.

Choose your operating system:

Windows

macOS

Linux

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

Name Description

Public function

FMassEntityView()

Public function

FMassEntityView

(
    const FArchetypeHandle& ArchetypeH...,
    FMassEntityHandle Entity
)

Resolves Entity against ArchetypeHandle.

Public function

FMassEntityView

(
    const UMassEntitySubsystem& Entity...,
    FMassEntityHandle Entity
)

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

Functions

Name Description

Public function Const

const T &

 

GetConstSharedFragmentData()

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

Public function Const

const T *...

 

GetConstSharedFragmentDataPtr()

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

Protected function Const

const void &...

 

GetConstSharedFragmentPtr

(
    const UScriptStruct& FragmentType
)

Protected function Const

const void &...

 

GetConstSharedFragmentPtrChecked

(
    const UScriptStruct& FragmentType
)

Public function Const

FMassEntityH...

 

GetEntity()

Public function Const

T &

 

GetFragmentData()

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

Public function Const

T *

 

GetFragmentDataPtr()

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

Public function Const

FStructView

 

GetFragmentDataStruct

(
    const UScriptStruct* FragmentT...
)

Protected function Const

void *

 

GetFragmentPtr

(
    const UScriptStruct& FragmentType
)

Protected function Const

void *

 

GetFragmentPtrChecked

(
    const UScriptStruct& FragmentType
)

Public function Const

T &

 

GetSharedFragmentData()

Will fail a check if the viewed entity doesn't have the given shared fragment

Public function Const

T *

 

GetSharedFragmentDataPtr()

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()

Operators

Name Description

Public function Const

bool

 

operator==

(
    const FMassEntityView& Other
)