FPayloadId

An identifier for a payload in the virtualization system.

Choose your operating system:

Windows

macOS

Linux

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Virtualization/PayloadId.h

Include

#include "Virtualization/PayloadId.h"

Syntax

class FPayloadId

Remarks

An identifier for a payload in the virtualization system.

Constructors

Name Description

Public function

FPayloadId()

Public function

FPayloadId

(
    const FIoHash& BlakeHash
)

Create a FPayloadId from the given FIoHash

Public function

FPayloadId

(
    const FSharedBuffer& Payload
)

Creates a FPayloadId based on hashing the given FSharedBuffer

Public function

FPayloadId

(
    const FGuid& Guid
)

Used when we already have a FGuid identifying the payload and do not want to pay the cost of loading and rehashing the payload each time we load the editor

Functions

Name Description

Public function Const

const FIoHas...

 

GetIdentifier()

Public function Const

bool

 

IsValid()

Returns true if the id is valid and should reference a payload

Public function

void

 

Reset()

Reset the id to the initial, invalid state so that it does not reference a payload

Public function Const

FGuid

 

ToGuid()

TODO: Although accessors are provided, this is mostly to provide compatibility with existing systems.

Public function Const

FString

 

ToString()

Returns a string representation of the id, useful for debug tools

Operators

Name Description

Public function Const

bool

 

operator!=

(
    const FPayloadId& InPayloadId
)

Public function Const

bool

 

operator!=

(
    const FIoHash& IoHash
)

Public function Const

bool

 

operator==

(
    const FPayloadId& InPayloadId
)

Public function Const

bool

 

operator==

(
    const FIoHash& IoHash
)