1. Epic GamesDeveloper
  3. FBoolProperty

FBoolProperty

Describes a single bit flag variable residing in a 32-bit unsigned double word.

API > API/Runtime > API/Runtime/CoreUObject

Describes a single bit flag variable residing in a 32-bit unsigned double word.

   
Name FBoolProperty
Type class
Header File /Engine/Source/Runtime/CoreUObject/Public/UObject/UnrealType.h
Include Path #include "UObject/UnrealType.h"

Syntax

class FBoolProperty : public FProperty

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FBoolProperty ( FFieldVariant InOwner,
const UECodeGen_Private::FBoolPropertyParams& Prop
)

 Constructor used for constructing compiled in properties UObject/UnrealType.h  

FBoolProperty ( FFieldVariant InOwner,
const FName& InName,
EObjectFlags InObjectFlags
)

   UObject/UnrealType.h  

FBoolProperty ( EInternal InInernal,
FFieldClass* InClass
)

   UObject/UnrealType.h  

FBoolProperty ( UField* InField
)

   UObject/UnrealType.h  

Typedefs

Name Type Remarks Include Path
Super FProperty   UObject/UnrealType.h
TCppType bool Emulate the CPP type API, see TPropertyTypeFundamentals this is incomplete as some operations make no sense for bitfields, for example they don't have a usable address UObject/UnrealType.h
ThisClass FBoolProperty   UObject/UnrealType.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ByteMask uint8 Mask of the byte with the property value. UObject/UnrealType.h  
ByteOffset uint8 Offset from the memeber variable to the byte of the property (0-7). UObject/UnrealType.h  
FieldMask uint8 Mask of the field with the property value. Either equal to ByteMask or 255 in case of 'bool' type. UObject/UnrealType.h  
FieldSize uint8 Variables. UObject/UnrealType.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

uint8 GetBoolFieldSize()

 Return the FieldSize, for debugging purposes UObject/UnrealType.h  

uint8 GetByteMask()

 Return the ByteMask, for debugging purposes UObject/UnrealType.h  

uint8 GetByteOffset ()

 Return the byte offset from this property's storage type to the byte that FieldMask applies to. UObject/UnrealType.h  

uint8 GetFieldMask()

 Return the the mask that defines the relevant bit for this boolean, or 0xFF if IsNativeBool() is true UObject/UnrealType.h  

bool GetOptionalPropertyValue ( void const* B
) const

   UObject/UnrealType.h  

bool GetOptionalPropertyValue_InContainer ( void const* B,
int32 ArrayIndex
) const

   UObject/UnrealType.h  

bool GetPropertyValue ( void const* A
) const

   UObject/UnrealType.h  

bool GetPropertyValue_InContainer ( void const* A,
int32 ArrayIndex
) const

   UObject/UnrealType.h  

bool IsNativeBool()

 If the return value is true this FBoolProperty represents C++ bool type. UObject/UnrealType.h  

void SetBoolSize ( const uint32 InSize,
const bool bIsNativeBool,
const uint32 InBitMask
)

 Sets the bitfield/bool type and size. UObject/UnrealType.h  

void SetPropertyValue ( void* A,
bool Value
) const

   UObject/UnrealType.h  

void SetPropertyValue_InContainer ( void* A,
bool Value,
int32 ArrayIndex
) const

   UObject/UnrealType.h  

Overridden from FProperty

Name Remarks Include Path Unreal Specifiers

virtual void AppendSchemaHash ( FBlake3& Builder,
bool bSkipEditorOnly
) const

 Updates the given HashBuilder with name and type information of this Property. UObject/UnrealType.h  

virtual void ClearValueInternal ( void* Data
) const

   UObject/UnrealType.h  

virtual EConvertFromTypeResult ConvertFromType ( const FPropertyTag& Tag,
FStructuredArchive::FSlot Slot,
uint8* Data,
const UStruct* DefaultsStruct,
const uint8* Defaults
)

 Allows a property to implement backwards compatibility handling for tagged properties UObject/UnrealType.h  

virtual void CopyValuesInternal ( void* Dest,
void const* Src,
int32 Count
) const

   UObject/UnrealType.h  

virtual FString GetCPPMacroType ( FString& ExtendedTypeText
) const

   UObject/UnrealType.h  

virtual FString GetCPPType ( FString* ExtendedTypeText,
uint32 CPPExportFlags
) const

 Returns the text to use for exporting this property to header file. UObject/UnrealType.h  

virtual int32 GetMinAlignment()

   UObject/UnrealType.h  

virtual uint32 GetValueTypeHashInternal ( const void* Src
) const

   UObject/UnrealType.h  
Returns whether this type has a special state for an unset TOptional meaning the size TOptional and T are the same. UObject/UnrealType.h  

virtual bool Identical ( const void* A,
const void* B,
uint32 PortFlags
) const

 Determines whether the property values are identical. UObject/UnrealType.h  

virtual void InitializeValueInternal ( void* Dest
) const

   UObject/UnrealType.h  

virtual void LinkInternal ( FArchive& Ar
)

   UObject/UnrealType.h  

virtual bool NetSerializeItem ( FArchive& Ar,
UPackageMap* Map,
void* Data,
TArray< uint8 >* MetaData
) const

   UObject/UnrealType.h  

virtual void SerializeItem ( FStructuredArchive::FSlot Slot,
void* Value,
void const* Defaults
) const

   UObject/UnrealType.h  

Overridden from FField

Name Remarks Include Path Unreal Specifiers

virtual SIZE_T GetFieldSize()

   UObject/UnrealType.h  

virtual void PostDuplicate ( const FField& InField
)

 Fixups after duplicating a Field UObject/UnrealType.h  

virtual void Serialize ( FArchive& Ar
)

 Begin UObject interface: the following functions mimic UObject interface for easier transition from UProperties to FProperties. UObject/UnrealType.h  

Protected

Name Remarks Include Path Unreal Specifiers

void DetermineBitfieldOffsetAndMask ( uint32& Offset,
uint32& BitMask,
void(*)(void*Obj) SetBit,
SIZE_T SizeOf
)

   UObject/UnrealType.h  

Overridden from FProperty

Name Remarks Include Path Unreal Specifiers

virtual void ExportText_Internal ( FString& ValueStr,
const void* PropertyValueOrContainer,
EPropertyPointerType PropertyPointerType,
const void* DefaultValue,
UObject* Parent,
int32 PortFlags,
UObject* ExportRootScope
) const

   UObject/UnrealType.h  

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

   UObject/UnrealType.h  

Static

Name Remarks Include Path Unreal Specifiers

static UE_API FField * Construct ( const FFieldVariant& InOwner,
const FName& InName,
EObjectFlags InObjectFlags
)

   UObject/UnrealType.h  

static bool GetDefaultPropertyValue()

   UObject/UnrealType.h  

static UE_API FFieldClass * StaticClass()

   UObject/UnrealType.h  

static EClassCastFlags StaticClassCastFlags()

   UObject/UnrealType.h  

static EClassCastFlags StaticClassCastFlagsPrivate()

   UObject/UnrealType.h  

Operators

Name Remarks Include Path Unreal Specifiers

void operator delete ( void* InMem
)

   UObject/UnrealType.h  

void * operator new ( const size_t InSize,
void* InMem
)

   UObject/UnrealType.h  

void * operator new ( const size_t InSize
)

   UObject/UnrealType.h  
  UObject/UnrealType.h  
  UObject/UnrealType.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page