UByteProperty

Describes an unsigned byte value or 255-value enumeration variable.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

CoreUObject

Header

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

Include

#include "UObject/UnrealType.h"

Syntax

class UByteProperty : public TProperty_Numeric< uint8 >

Remarks

Describes an unsigned byte value or 255-value enumeration variable.

Variables

Name Description

Public variable

UEnum *

 

Enum

Variables.

Constructors

Name Description

Public function

UByteProperty

(
    const FObjectInitializer& ObjectIn...
)

Public function

UByteProperty

(
    FVTableHelper& Helper
)

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

Public function

UByteProperty

(
    ECppProperty,
    int32 InOffset,
    EPropertyFlags InFlags,
    UEnum* InEnum
)

Public function

UByteProperty

(
    const FObjectInitializer& ObjectIn...,
    ECppProperty,
    int32 InOffset,
    EPropertyFlags InFlags,
    UEnum* InEnum
)

Functions

Name Description

Public function Static

void

 

__DefaultConstructor

(
    const FObjectInitializer& X
)

Public function Static

UObject *...

 

__VTableCtorCaller

(
    FVTableHelper& Helper
)

Public function Static

void

 

AddReferencedObjects

(
    UObject* InThis,
    FReferenceCollector& Collector
)

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

 

ExportTextItem

(
    FString& ValueStr,
    const void* PropertyValue,
    const void* DefaultValue,
    UObject* Parent,
    int32 PortFlags,
    UObject* ExportRootScope
)

Public function Virtual Const

UEnum *

 

GetIntPropertyEnum()

Return the UEnum if this property is a UByteProperty with a non-null Enum

Public function Virtual

void

 

GetPreloadDependencies

(
    TArray< UObject* >& OutDeps
)

Called during cooking.

Public function Virtual Const

const TCHAR ...

 

ImportText_Internal

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

Public function Virtual Const

bool

 

NetSerializeItem

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

Public function Virtual

void

 

Serialize

(
    FArchive& Ar
)

Handles reading, writing, and reference collecting using FArchive.

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

 

StaticRegisterNativesUByteProperty()

Overridden from TProperty_WithEqualityAndSerializer

Name Description

Public function Virtual Const

void

 

SerializeItem

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

Overridden from TProperty

Name Description

Public function Virtual Const

FString

 

GetCPPType

(
    FString* ExtendedTypeText,
    uint32 CPPExportFlags
)

Returns the text to use for exporting this property to header file.

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 (TProperty_Numeric< uint8 >)

ThisClass

Typedef for UByteProperty.

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