Skip to Content
This documentation is provided with the HEAT environment and describes this HEAT instance.

HCP Unreal

HCP Unreal is a pair of Unreal Engine 5 plugins that observe actors in a running project and publish their state and events to HEAT Capture. It does not control actors and does not consume gameplay input: capture is purely observational, driven by whatever the project’s own gameplay code does.

PluginTypePurposeDistributed to customers
hcp_unreal_pluginRuntimeEntity registration, capture components, event emitters, WebSocket streaming, Project SettingsYes
hcp_codegen_pluginEditor-onlyGenerates the runtime plugin’s 53 capture components, 79 event emitters and 30 enums from the HEAT ProtoLib schemaNo - internal VRAI tool only

hcp_codegen_plugin is how VRAI keeps the runtime plugin’s generated components in sync with HEAT ProtoLib. The package handed to customers contains only hcp_unreal_plugin, with every generated file already baked in - there is nothing to generate or regenerate after install.

What you need before starting

  • Unreal Engine 5.7 (Win64).
  • A C++ project - hcp_unreal_plugin is not usable from a Blueprint-only project.
  • HEAT Capture running and reachable from the Unreal workstation.

Pages

InstallDeploy the plugin into a project and verify it loads.ConfigureProject Settings, and two settings that currently do nothing.Data producedEntity registration, capture timing, data binding and event emission.TroubleshootingSymptoms, causes and fixes.Interface control documentICD-HCPUNREAL-001.
Opens your browser's print dialog. Choose "Save as PDF" as the destination.