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

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.

   
Name FResolveParameterBuffer
Type struct
Header File /Engine/Source/Runtime/UniversalObjectLocator/Public/UniversalObjectLocatorResolveParameterBuffer.h
Include Path #include "UniversalObjectLocatorResolveParameterBuffer.h"

Syntax

struct FResolveParameterBuffer

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers
Default constructor UniversalObjectLocatorResolveParameterBuffer.h  
Non-copyable UniversalObjectLocatorResolveParameterBuffer.h  
Non-moveable UniversalObjectLocatorResolveParameterBuffer.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FResolveParameterBuffer()

 Destructor that calls each parameter's destructor, and frees the memory if necessary UniversalObjectLocatorResolveParameterBuffer.h  

Constants

Name Type Remarks Include Path
MaxNumParameters int32   UniversalObjectLocatorResolveParameterBuffer.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

 Add a new parameter to this container using its preregistered type handle. UniversalObjectLocatorResolveParameterBuffer.h  

const T * FindParameter ()

 Find a parameter of the specified type. UniversalObjectLocatorResolveParameterBuffer.h  

const T * FindParameter ( TParameterTypeHandle< T > ParameterTypeHandle
) const

 Find a parameter within this container that was added with the specified handle. UniversalObjectLocatorResolveParameterBuffer.h  

Protected

Name Remarks Include Path Unreal Specifiers

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

 Creates and stores a new Parameter object at the given bit. UniversalObjectLocatorResolveParameterBuffer.h  

void Destroy()

 Destroy this buffer and all its parameters UniversalObjectLocatorResolveParameterBuffer.h  

const void * FindParameterImpl ( uint32 ParameterBit
) const

 Implementation function for finding a parameter ptr by its bit UniversalObjectLocatorResolveParameterBuffer.h  

const FResolveParameterHeader & GetHeader ( uint8 Index
) const

 Retrieve the header at the specified index UniversalObjectLocatorResolveParameterBuffer.h  

int32 GetParameterIndex ( uint32 ParameterBit
) const

 Compute the index of the parameter that relates to the specified bit UniversalObjectLocatorResolveParameterBuffer.h  

bool HasParameter ( uint32 ParameterBit
) const

 Check whether the parameter for the specified parameter bit is present UniversalObjectLocatorResolveParameterBuffer.h  

Operators

Name Remarks Include Path Unreal Specifiers
  UniversalObjectLocatorResolveParameterBuffer.h  
  UniversalObjectLocatorResolveParameterBuffer.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page