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

#include <UnrealType.h>

+ Inheritance diagram for FByteProperty:

Public Member Functions

virtual UE_API EConvertFromTypeResult ConvertFromType (const FPropertyTag &Tag, FStructuredArchive::FSlot Slot, uint8 *Data, const UStruct *DefaultsStruct, const uint8 *Defaults) override
 
virtual UE_API bool LoadTypeName (UE::FPropertyTypeName Type, const FPropertyTag *Tag=nullptr) override
 
virtual UE_API void SaveTypeName (UE::FPropertyTypeNameBuilder &Type) const override
 
virtual UE_API bool CanSerializeFromTypeName (UE::FPropertyTypeName Type) const override
 
virtual UE_API UEnumGetIntPropertyEnum () const override
 
UE_API uint64 GetMaxNetSerializeBits () const
 
- Public Member Functions inherited from TProperty_Numeric< uint8 >
 TProperty_Numeric (EInternal InInernal, FFieldClass *InClass)
 
 TProperty_Numeric (FFieldVariant InOwner, const FName &InName, EObjectFlags InObjectFlags)
 
 TProperty_Numeric (FFieldVariant InOwner, const UECodeGen_Private::FPropertyParamsBaseWithOffset &Prop)
 
virtual uint32 GetValueTypeHashInternal (const void *Src) const override
 
virtual bool IsFloatingPoint () const override
 
virtual bool IsInteger () const override
 
virtual void SetIntPropertyValue (void *Data, uint64 Value) const override
 
virtual void SetIntPropertyValue (void *Data, int64 Value) const override
 
virtual void SetFloatingPointPropertyValue (void *Data, double Value) const override
 
virtual void SetNumericPropertyValueFromString (void *Data, TCHAR const *Value) const override
 
virtual void SetNumericPropertyValueFromString_InContainer (void *Container, TCHAR const *Value) const override
 
virtual FString GetNumericPropertyValueToString (void const *Data) const override
 
virtual FString GetNumericPropertyValueToString_InContainer (void const *Container) const override
 
virtual int64 GetSignedIntPropertyValue (void const *Data) const override
 
virtual int64 GetSignedIntPropertyValue_InContainer (void const *Container) const override
 
virtual uint64 GetUnsignedIntPropertyValue (void const *Data) const override
 
virtual uint64 GetUnsignedIntPropertyValue_InContainer (void const *Container) const override
 
virtual double GetFloatingPointPropertyValue (void const *Data) const override
 
- Public Member Functions inherited from TProperty_WithEqualityAndSerializer< InTCppType, TInPropertyBaseClass >
 TProperty_WithEqualityAndSerializer (EInternal InInernal, FFieldClass *InClass)
 
 TProperty_WithEqualityAndSerializer (FFieldVariant InOwner, const FName &InName, EObjectFlags InObjectFlags)
 
 TProperty_WithEqualityAndSerializer (FFieldVariant InOwner, const UECodeGen_Private::FPropertyParamsBaseWithOffset &Prop)
 
virtual bool Identical (const void *A, const void *B, uint32 PortFlags=0) const override
 
- Public Member Functions inherited from TProperty< InTCppType, TInPropertyBaseClass >
 TProperty (EInternal InInernal, FFieldClass *InClass)
 
 TProperty (FFieldVariant InOwner, const FName &InName, EObjectFlags InObjectFlags)
 
template<typename PropertyParamsType >
 TProperty (FFieldVariant InOwner, PropertyParamsType &Prop)
 
virtual int32 GetMinAlignment () const override
 
virtual void LinkInternal (FArchive &Ar) override
 
virtual void CopyValuesInternal (void *Dest, void const *Src, int32 Count) const override
 
virtual void ClearValueInternal (void *Data) const override
 
virtual void InitializeValueInternal (void *Dest) const override
 
virtual void DestroyValueInternal (void *Dest) const override
 
UE_FORCEINLINE_HINT TCppType const * GetPropertyValuePtr_InContainer (void const *A, int32 ArrayIndex=0) const
 
UE_FORCEINLINE_HINT TCppTypeGetPropertyValuePtr_InContainer (void *A, int32 ArrayIndex=0) const
 
UE_FORCEINLINE_HINT TCppType const & GetPropertyValue_InContainer (void const *A, int32 ArrayIndex=0) const
 
UE_FORCEINLINE_HINT TCppType GetOptionalPropertyValue_InContainer (void const *B, int32 ArrayIndex=0) const
 
UE_FORCEINLINE_HINT void SetPropertyValue_InContainer (void *A, TCppType const &Value, int32 ArrayIndex=0) const
 
UE_FORCEINLINE_HINT void SetValue_InContainer (void *OutContainer, const TCppType &InValue) const
 
UE_FORCEINLINE_HINT void GetValue_InContainer (void const *InContainer, TCppType *OutValue) const
 
virtual bool HasIntrusiveUnsetOptionalState () const override
 
virtual void InitializeIntrusiveUnsetOptionalValue (void *Data) const override
 
virtual bool IsIntrusiveOptionalValueSet (const void *Data) const override
 
virtual void ClearIntrusiveOptionalValue (void *Data) const override
 

Protected Member Functions

virtual UE_API void ExportText_Internal (FString &ValueStr, const void *PropertyValueOrContainer, EPropertyPointerType PropertyPointerType, const void *DefaultValue, UObject *Parent, int32 PortFlags, UObject *ExportRootScope) const override
 
virtual UE_API const TCHARImportText_Internal (const TCHAR *Buffer, void *ContainerOrPropertyPtr, EPropertyPointerType PropertyPointerType, UObject *Parent, int32 PortFlags, FOutputDevice *ErrorText) const override
 
- Protected Member Functions inherited from TProperty_Numeric< uint8 >
UE_FORCEINLINE_HINT void ConvertFromArithmeticValue (FStructuredArchive::FSlot Slot, void *Obj, const FPropertyTag &Tag) const
 

Additional Inherited Members

- Public Types inherited from TProperty_Numeric< uint8 >
typedef TProperty_WithEqualityAndSerializer< uint8, FNumericPropertySuper
 
typedef uint8 TCppType
 
typedef Super::TTypeFundamentals TTypeFundamentals
 
- Public Types inherited from TProperty_WithEqualityAndSerializer< InTCppType, TInPropertyBaseClass >
typedef TProperty< InTCppType, TInPropertyBaseClass > Super
 
typedef InTCppType TCppType
 
typedef Super::TTypeFundamentals TTypeFundamentals
 
- Public Types inherited from TProperty< InTCppType, TInPropertyBaseClass >
typedef InTCppType TCppType
 
typedef TInPropertyBaseClass Super
 
typedef TPropertyTypeFundamentals< InTCppTypeTTypeFundamentals
 
- Public Types inherited from TPropertyTypeFundamentals< InTCppType >
enum  { CPPSize = sizeof(TCppType) , CPPAlignment = alignof(TCppType) }
 
typedef InTCppType TCppType
 
- Static Public Member Functions inherited from TPropertyTypeFundamentals< InTCppType >
static UE_FORCEINLINE_HINT TCHAR const * GetTypeName ()
 
static UE_FORCEINLINE_HINT TCppType const * GetPropertyValuePtr (void const *A)
 
static UE_FORCEINLINE_HINT TCppTypeGetPropertyValuePtr (void *A)
 
static UE_FORCEINLINE_HINT TCppType const & GetPropertyValue (void const *A)
 
static UE_FORCEINLINE_HINT TCppType GetDefaultPropertyValue ()
 
static UE_FORCEINLINE_HINT TCppType GetOptionalPropertyValue (void const *B)
 
static UE_FORCEINLINE_HINT void SetPropertyValue (void *A, TCppType const &Value)
 
static UE_FORCEINLINE_HINT TCppTypeInitializePropertyValue (void *A)
 
static UE_FORCEINLINE_HINT void DestroyPropertyValue (void *A)
 
static UE_FORCEINLINE_HINT bool HasIntrusiveUnsetOptionalState ()
 
static UE_FORCEINLINE_HINT void InitializeIntrusiveUnsetOptionalValue (void *Data)
 
static UE_FORCEINLINE_HINT bool IsIntrusiveOptionalValueSet (const void *A)
 
static UE_FORCEINLINE_HINT void ClearIntrusiveOptionalValue (void *A)
 
- Static Protected Member Functions inherited from TPropertyTypeFundamentals< InTCppType >
static EPropertyFlags GetComputedFlagsPropertyFlags ()
 

Member Function Documentation

◆ CanSerializeFromTypeName()

bool FByteProperty::CanSerializeFromTypeName ( UE::FPropertyTypeName  Type) const
overridevirtual

◆ ConvertFromType()

EConvertFromTypeResult FByteProperty::ConvertFromType ( const FPropertyTag Tag,
FStructuredArchive::FSlot  Slot,
uint8 Data,
const UStruct DefaultsStruct,
const uint8 Defaults 
)
overridevirtual

Reimplemented from TProperty_Numeric< uint8 >.

◆ ExportText_Internal()

void FByteProperty::ExportText_Internal ( FString &  ValueStr,
const void PropertyValueOrContainer,
EPropertyPointerType  PropertyPointerType,
const void DefaultValue,
UObject Parent,
int32  PortFlags,
UObject ExportRootScope 
) const
overrideprotectedvirtual

◆ GetIntPropertyEnum()

UEnum * FByteProperty::GetIntPropertyEnum ( ) const
overridevirtual

◆ GetMaxNetSerializeBits()

uint64 FByteProperty::GetMaxNetSerializeBits ( ) const

◆ ImportText_Internal()

const TCHAR * FByteProperty::ImportText_Internal ( const TCHAR Buffer,
void ContainerOrPropertyPtr,
EPropertyPointerType  PropertyPointerType,
UObject Parent,
int32  PortFlags,
FOutputDevice ErrorText 
) const
overrideprotectedvirtual

◆ LoadTypeName()

bool FByteProperty::LoadTypeName ( UE::FPropertyTypeName  Type,
const FPropertyTag Tag = nullptr 
)
overridevirtual

◆ SaveTypeName()

void FByteProperty::SaveTypeName ( UE::FPropertyTypeNameBuilder Type) const
overridevirtual

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