UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FStripDataFlags Class Reference

#include <EngineUtils.h>

Public Types

enum class  EStrippedData : uint8 {
  None = 0 , EditorOnly = 1 , AudioVisual = 2 , NeededForCooking = 4 ,
  All = 0xff
}
 

Public Member Functions

ENGINE_API FStripDataFlags (FArchive &Ar, uint8 InClassFlags=0, const FPackageFileVersion &InVersion=GOldestLoadablePackageFileUEVersion)
 
ENGINE_API FStripDataFlags (FArchive &Ar, uint8 InGlobalFlags, uint8 InClassFlags, const FPackageFileVersion &InVersion=GOldestLoadablePackageFileUEVersion)
 
ENGINE_API FStripDataFlags (FStructuredArchive::FSlot Slot, uint8 InClassFlags=0, const FPackageFileVersion &InVersion=GOldestLoadablePackageFileUEVersion)
 
ENGINE_API FStripDataFlags (FStructuredArchive::FSlot Slot, uint8 InGlobalFlags, uint8 InClassFlags, const FPackageFileVersion &InVersion=GOldestLoadablePackageFileUEVersion)
 
bool IsEditorDataStripped () const
 
bool IsAudioVisualDataStripped () const
 
bool IsDataNeededForCookingStripped () const
 
bool IsClassDataStripped (uint8 InFlags) const
 

Detailed Description

Helper class for serializing flags describing which data have been stripped (if any).

Member Enumeration Documentation

◆ EStrippedData

Engine strip flags

Enumerator
None 
EditorOnly 
AudioVisual 
NeededForCooking 
All 

All flags

Constructor & Destructor Documentation

◆ FStripDataFlags() [1/4]

FStripDataFlags::FStripDataFlags ( FArchive Ar,
uint8  InClassFlags = 0,
const FPackageFileVersion InVersion = GOldestLoadablePackageFileUEVersion 
)
explicit

Constructor. Serializes strip data flags. Global (engine) flags are automatically generated from target platform when saving. Class flags need to be defined by the user.

Parameters
Ar- Archive to serialize with.
InClassFlags- User defined per class flags .
InVersion- Minimal strip version required to serialize strip flags

◆ FStripDataFlags() [2/4]

FStripDataFlags::FStripDataFlags ( FArchive Ar,
uint8  InGlobalFlags,
uint8  InClassFlags,
const FPackageFileVersion InVersion = GOldestLoadablePackageFileUEVersion 
)

Constructor. Serializes strip data flags. Global (engine) flags are user defined and will not be automatically generated when saving. Class flags also need to be defined by the user.

Parameters
Ar- Archive to serialize with.
InGlobalFlagsEngine flags
InClassFlags- User defined per class flags.
InVersion- Minimal version required to serialize strip flags

◆ FStripDataFlags() [3/4]

FStripDataFlags::FStripDataFlags ( FStructuredArchive::FSlot  Slot,
uint8  InClassFlags = 0,
const FPackageFileVersion InVersion = GOldestLoadablePackageFileUEVersion 
)
explicit

Constructor. Serializes strip data flags. Global (engine) flags are automatically generated from target platform when saving. Class flags need to be defined by the user.

Parameters
Slot- Slot holding the archive to serialize with.
InClassFlags- User defined per class flags .
InVersion- Minimal strip version required to serialize strip flags

◆ FStripDataFlags() [4/4]

FStripDataFlags::FStripDataFlags ( FStructuredArchive::FSlot  Slot,
uint8  InGlobalFlags,
uint8  InClassFlags,
const FPackageFileVersion InVersion = GOldestLoadablePackageFileUEVersion 
)

Constructor. Serializes strip data flags. Global (engine) flags are user defined and will not be automatically generated when saving. Class flags also need to be defined by the user.

Parameters
Slot- Slot holding the archive to serialize with.
InGlobalFlags- Engine flags.
InClassFlags- User defined per class flags.
InVersion- Minimal version required to serialize strip flags

Member Function Documentation

◆ IsAudioVisualDataStripped()

bool FStripDataFlags::IsAudioVisualDataStripped ( ) const
inline

Checks if FStripDataFlags::AudioVisual flag is set or not

Returns
true if FStripDataFlags::AudioVisual is set, false otherwise.

◆ IsClassDataStripped()

bool FStripDataFlags::IsClassDataStripped ( uint8  InFlags) const
inline

Checks if user defined flags are set or not.

@InFlags - User defined flags to check.

Returns
true if the specified user defined flags are set, false otherwise.

◆ IsDataNeededForCookingStripped()

bool FStripDataFlags::IsDataNeededForCookingStripped ( ) const
inline

Checks if FStripDataFlags::NeededForCooking flag is set or not. It should be set for all non-content-worker targets

Returns
true if FStripDataFlags::NeededForCooking is set, false otherwise.

◆ IsEditorDataStripped()

bool FStripDataFlags::IsEditorDataStripped ( ) const
inline

Checks if FStripDataFlags::Editor flag is set or not

Returns
true if FStripDataFlags::Editor is set, false otherwise.

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