UBoolProperty

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

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

CoreUObject

Header

/Engine/Source/Runtime/CoreUObject/Public/UObject/UnrealType.h

Include

#include "UObject/UnrealType.h"

Syntax

class UBoolProperty : public UProperty

Remarks

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

Constructors

Name Description

Public function

UBoolProperty

(
    FVTableHelper& Helper
)

DO NOT USE. This constructor is for internal usage only for hot-reload purposes.

Public function

UBoolProperty

(
    const FObjectInitializer& ObjectIn...
)

Public function

UBoolProperty

(
    ECppProperty,
    int32 InOffset,
    EPropertyFlags InFlags,
    uint32 InBitMask,
    uint32 InElementSize,
    bool bIsNativeBool
)

Constructor.

Public function

UBoolProperty

(
    const FObjectInitializer& ObjectIn...,
    ECppProperty,
    int32 InOffset,
    EPropertyFlags InFlags,
    uint32 InBitMask,
    uint32 InElementSize,
    bool bIsNativeBool
)

Constructor.

Functions

Name Description

Public function Static

void

 

__DefaultConstructor

(
    const FObjectInitializer& X
)

Public function Static

UObject *...

 

__VTableCtorCaller

(
    FVTableHelper& Helper
)

Public function Static

bool

 

GetDefaultPropertyValue()

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

 

IsNativeBool()

If the return value is true this UBoolProperty 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

UClass *

 

StaticClass()

Returns a UClass object representing this class at runtime

Public function Static

EClassCastFl...

 

StaticClassCastFlags()

Returns the static cast flags for this class

Public function Static

const TCHAR ...

 

StaticPackage()

Returns the package this class belongs in

Public function Static

void

 

StaticRegisterNativesUBoolProperty()

Overridden from UProperty

Name Description

Public function Virtual Const

void

 

ClearValueInternal

(
    void* Data
)

Public function Virtual

EConvertFrom...

 

ConvertFromType

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

Allows a property to implement backwards compatibility handling for tagged properties

Public function Virtual Const

void

 

CopyValuesInternal

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

Public function Virtual Const

void

 

ExportTextItem

(
    FString& ValueStr,
    const void* PropertyValue,
    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

 

GetCPPTypeForwardDeclaration()

Public function Virtual Const

int32

 

GetMinAlignment()

Public function Virtual Const

uint32

 

GetValueTypeHashInternal

(
    const void* Src
)

Public function Virtual Const

bool

 

Identical

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

Determines whether the property values are identical.

Public function Virtual Const

const TCHAR ...

 

ImportText_Internal

(
    const TCHAR* Buffer,
    void* Data,
    int32 PortFlags,
    UObject* Parent,
    FOutputDevice* ErrorText
)

Public function Virtual Const

void

 

InitializeValueInternal

(
    void* Dest
)

Public function Virtual

void

 

LinkInternal

(
    FArchive& Ar
)

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 UObject

Name Description

Public function Virtual

void

 

Serialize

(
    FArchive& Ar
)

Handles reading, writing, and reference collecting using FArchive.

Operators

Name Description

Public function

void *

 

operator new

(
    const size_t InSize,
    EInternal InInternalOnly,
    UObject* InOuter,
    FName InName,
    EObjectFlags InSetFlags
)

For internal use only; use StaticConstructObject() to create new objects.

Public function

void *

 

operator new

(
    const size_t InSize,
    EInternal* InMem
)

For internal use only; use StaticConstructObject() to create new objects.

Typedefs

Name

Description

Super

Typedef for the base class (UProperty)

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

Typedef for UBoolProperty.

Constants

Name

Description

StaticClassFlags

Bitwise union of EClassFlags pertaining to this class.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback