1. Epic GamesDeveloper
  3. FResolveParameterBuffer

FResolveParameterBuffer

A buffer of parameter structs that can be optionally supplied to a UOL when resolving to supply additional context.

API > API/Runtime > API/Runtime/UniversalObjectLocator

Inheritance Hierarchy

References

   
Module UniversalObjectLocator
Header /Engine/Source/Runtime/UniversalObjectLocator/Public/UniversalObjectLocatorResolveParameterBuffer.h
Include #include "UniversalObjectLocatorResolveParameterBuffer.h"

Syntax

struct FResolveParameterBuffer

Remarks

A buffer of parameter structs that can be optionally supplied to a UOL when resolving to supply additional context.

Parameter types are registered through IUniversalObjectLocatorModule::RegisterParameterType and are identified by a unique index. Parameter structs are stored contiguously in memory after an array of headers that specify the offset of each parameter type.

Checking for the presence of a specific parameter type is very fast, amounting to a a simple bit operation.

Variables

  Type Name Description          
Protected variable uint32 AllParameters Bitmask of all the parameters contained within this container          
Protected variable bool bCanFreeMemory Boolean that indicates whether we own the memory pointed to by Memory, or if it was supplied externally          
Protected variable uint16 Capacity Current capacity of Memory in bytes          
Protected variable uint8 * Memory Memory allocation of the layout [header_1 ... header_n entry_0 ... entry_n]
Protected variable uint8 Num The number of parameters (and thus, headers) in this container          

Constructors

  Type Name Description
Public function   Default constructor
Public function   Non-copyable
Public function   Non-moveable

Destructors

  Type Name Description
Public function   Destructor that calls each parameter's destructor, and frees the memory if necessary

Functions

  Type Name Description
Public function T *

AddParameter ( TParameterTypeHandle< T > ParameterTypeHandle,
ArgTypes&&... InArgs
)

 Add a new parameter to this container using its preregistered type handle.
Protected function ParameterType *

AddParameterImpl ( uint32 ParameterBit,
ArgTypes&&... InArgs
)

 Creates and stores a new Parameter object at the given bit.
Protected function void

Destroy ()

 Destroy this buffer and all its parameters
Public function Const const T * Find a parameter of the specified type.
Public function Const const T *

FindParameter ( TParameterTypeHandle< T > ParameterTypeHandle
)

 Find a parameter within this container that was added with the specified handle.
Protected function Const const void *

FindParameterImpl ( uint32 ParameterBit
)

 Implementation function for finding a parameter ptr by its bit
Protected function Const const FResolveParameterHeader &

GetHeader ( uint8 Index
)

 Retrieve the header at the specified index
Protected function Const int32

GetParameterIndex ( uint32 ParameterBit
)

 Compute the index of the parameter that relates to the specified bit
Protected function Const bool

HasParameter ( uint32 ParameterBit
)

 Check whether the parameter for the specified parameter bit is present

Operators

  Type Name Description
Public function FResolveParameterBuffer &  
Public function FResolveParameterBuffer &  

Constants

Name Description
MaxNumParameters  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page