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 > API/Runtime/CoreUObject/UObject

Inheritance Hierarchy

References

   
Module CoreUObject
Header /Engine/Source/Runtime/CoreUObject/Public/UObject/UnrealType.h
Include #include "UObject/UnrealType.h"

Syntax

class FBoolProperty : public FProperty

Remarks

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

Constructors

  Type Name Description
Public function  

FBoolProperty ( UField* InField
)

  
Public function  

FBoolProperty ( EInternal InInernal,
FFieldClass* InClass
)

  
Public function  

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

 Constructor used for constructing compiled in properties
Public function  

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

  

Functions

  Type Name Description
Public function Static FField *

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

  
Public function Const uint8 Return the byte offset from this property's storage type to the byte that FieldMask applies to.
Public function Static bool  
Public function Const uint8 Return the the mask that defines the relevant bit for this boolean, or 0xFF if IsNativeBool() is true
Public function Const bool

GetOptionalPropertyValue ( void const* B
)

  
Public function Const bool

GetOptionalPropertyValue_InContainer ( void const* B,
int32 ArrayIndex
)

  
Public function Const bool

GetPropertyValue ( void const* A
)

  
Public function Const bool

GetPropertyValue_InContainer ( void const* A,
int32 ArrayIndex
)

  
Public function Const bool If the return value is true this FBoolProperty represents C++ bool type.
Public function void

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

 Sets the bitfield/bool type and size.
Public function Const void

SetPropertyValue ( void* A,
bool Value
)

  
Public function Const void

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

  
Public function Static FFieldClass *  
Public function Static uint64  
Public function Static uint64  

Overridden from FProperty

  Type Name Description
Public function Virtual Const void

AppendSchemaHash ( FBlake3& Builder,
bool bSkipEditorOnly
)

 Updates the given HashBuilder with name and type information of this Property.
Public function Virtual Const void

ClearValueInternal ( void* Data
)

  
Public function Virtual EConvertFromTypeResult

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

 Allows a property to implement backwards compatibility handling for tagged properties
Public function Virtual Const void

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

  
Protected function Virtual Const void

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

  
Public function Virtual Const FString

GetCPPMacroType ( FString& ExtendedTypeText
)

  
Public function Virtual Const FString

GetCPPType ( FString* ExtendedTypeText,
uint32 CPPExportFlags
)

 Returns the text to use for exporting this property to header file.
Public function Virtual Const FString  
Public function Virtual Const int32  
Public function Virtual Const uint32

GetValueTypeHashInternal ( const void* Src
)

  
Public function Virtual Const bool Returns whether this type has a special state for an unset TOptional meaning the size TOptional and T are the same.
Public function Virtual Const bool

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

 Determines whether the property values are identical.
Protected function Virtual Const const TCHAR *

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

  
Public function Virtual Const void

InitializeValueInternal ( void* Dest
)

  
Public function Virtual void  
Public function Virtual Const bool

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

  
Public function Virtual Const void

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

  

Overridden from FField

  Type Name Description
Public function Virtual Const SIZE_T  
Public function Virtual void

PostDuplicate ( const FField& InField
)

 Fixups after duplicating a Field
Public function Virtual void Begin UObject interface: the following functions mimic UObject interface for easier transition from UProperties to FProperties.

Operators

  Type Name Description
Public function void

operator delete ( void* InMem
)

  
Public function void *

operator new ( const size_t InSize
)

  
Public function void *

operator new ( const size_t InSize,
void* InMem
)

  

Typedefs

Name Description
Super  
TCppType 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
ThisClass  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page