When should I use $unref()?

Use $unref() after calling an Unreal Engine API that took a $ref container as an argument. It extracts the actual value (like a TArray or FName) that the engine populated.

How do I get the actual Unreal Engine object from a React ref?

You should access the '.nativePtr' property of the ref object within your ref callback or effect to interact with the underlying C++ UE Widget.

What is the main difference between a React ref and a PuerTS $ref?

A React ref is used to get a reference to a component or Widget instance to call its methods, while a PuerTS $ref is specifically for handling C++ 'out' parameters where the UE API needs to fill a container with data.

Why does my code throw a TypeError when calling UE.DataTableFunctionLibrary.GetDataTableRowNames?

This usually happens because you are passing a standard variable instead of a PuerTS $ref container. UE APIs with 'out' parameters require the $ref wrapper to correctly bridge the data from C++ to TypeScript.

ReactUMG Reference Management

Name: ReactUMG Reference Management
Author: 15195999826

by15195999826

Game Development

Guides developers in distinguishing between React component references and PuerTS C++ out-parameter references within Unreal Engine UI development.

About

This skill provides specialized guidance for developers using ReactUMG to build Unreal Engine interfaces. It clarifies the critical distinction between React's standard 'ref' system, used for accessing native Widget instances via nativePtr, and PuerTS's '$ref/$unref' patterns used for handling C++ 'out' parameters. By providing implementation patterns for common Unreal Engine APIs like DataTable lookups and mouse capture events, it helps prevent common type errors and ensures seamless integration between React logic and the Unreal Engine C++ backend.

Key Features

Distinguishes React component refs from PuerTS $ref containers
Provides patterns for accessing nativePtr in UE Widgets
Explains $ref and $unref syntax for C++ 'out' parameters
Covers specific UE API patterns like DataTable and Mouse Capture
0 GitHub stars
Identifies and resolves common PuerTS type errors

Use Cases

Accessing native Unreal Engine Widget methods from within a React component
Handling C++ functions that return data through pointer arguments in PuerTS
Implementing complex UI interactions like mouse capture and event replies in ReactUMG

About

Key Features

Distinguishes React component refs from PuerTS $ref containers
Provides patterns for accessing nativePtr in UE Widgets
Explains $ref and $unref syntax for C++ 'out' parameters
Covers specific UE API patterns like DataTable and Mouse Capture
0 GitHub stars
Identifies and resolves common PuerTS type errors

Use Cases

Accessing native Unreal Engine Widget methods from within a React component
Handling C++ functions that return data through pointer arguments in PuerTS
Implementing complex UI interactions like mouse capture and event replies in ReactUMG