FInkHandle Struct Reference

Generic registration handle returned by all Register* functions on AInkRuntime and UInkThread. More...

#include <InkHandles.h>

Public Member Functions
bool	IsValid () const
	Returns true if this handle refers to an active registration.
void	Cancel () const
	Cancels the registration this handle refers to.

Detailed Description

Generic registration handle returned by all Register* functions on AInkRuntime and UInkThread.

Call Cancel() to cancel the registration. Letting the handle go out of scope does NOT automatically cancel — you must call Cancel() explicitly. For Blueprint graphs, pass the handle to AInkRuntime::Unregister() or UInkThread::Unregister() — those are thin wrappers around Cancel().

The same handle type is used for variable observers, tag functions, and external functions — the registering function name already makes the context clear at the call site.

Member Function Documentation

Cancel()

void FInkHandle::Cancel ( ) const

inline

Cancels the registration this handle refers to.

Safe to call multiple times.

---

The documentation for this struct was generated from the following file:

• unreal/inkcpp/Source/inkcpp/Public/InkHandles.h