Apparatus Version 1.22
ECS data-oriented workflow for Unreal Engine.
Public Member Functions | Public Attributes | List of all members
USubjectRecordCollection Class Reference

A serializable collection of subject records. More...

#include <SubjectRecordCollection.h>

Inheritance diagram for USubjectRecordCollection:
Inheritance graph
[legend]
Collaboration diagram for USubjectRecordCollection:
Collaboration graph
[legend]

Public Member Functions

void Add (FSubjectHandle Subject, const EFlagmark FlagmarkMask=FM_AllUserLevel)
 Add a subject to the collection. More...
 
void Reset (int32 NewSize=0)
 Remove all of the collected subjects, while leaving the slack. More...
 
void Empty (int32 Slack=0)
 Remove all of the collected subjects, while leaving the slack. More...
 

Public Attributes

TArray< FSubjectRecordSubjects
 The actual list of subject records. More...
 

Detailed Description

A serializable collection of subject records.

Member Function Documentation

◆ Add()

void USubjectRecordCollection::Add ( FSubjectHandle  Subject,
const EFlagmark  FlagmarkMask = FM_AllUserLevel 
)

Add a subject to the collection.

Parameters
SubjectThe subject to add. Must be a valid one.
FlagmarkMaskThe mask used to capture the flags from the subject. Only user-level flags are captured by default.

◆ Empty()

void USubjectRecordCollection::Empty ( int32  Slack = 0)

Remove all of the collected subjects, while leaving the slack.

Parameters
SlackThe slack capacity to to remained.

◆ Reset()

void USubjectRecordCollection::Reset ( int32  NewSize = 0)

Remove all of the collected subjects, while leaving the slack.

Parameters
NewSizeThe expected usage size after calling this function.

Member Data Documentation

◆ Subjects

TArray<FSubjectRecord> USubjectRecordCollection::Subjects

The actual list of subject records.

Can be accessed and changed directly.


The documentation for this class was generated from the following file: