Limen Framework 0.1 Help

ULimenMinimapComponent

Overview

ULimenMinimapComponent is an actor component designed to create and manage a minimap. It initializes a scene capture component, sets up a render target material instance, and attaches itself to the owner's root component. The component provides functions to retrieve the minimap material and scene capture component for use in blueprints.

Properties

Type

Name

Access

Description

UTextureRenderTarget2D

MiniMapRenderTarget

EditDefaultsOnly

The render target used for capturing the minimap.

TSoftObjectPtr<UMaterialInterface>

RenderTargetMaterial

EditDefaultsOnly

The material interface to be used as a template for creating dynamic materials.

FName

MaterialParameter

EditDefaultsOnly

The name of the parameter in the material that will hold the render target texture.

FVector

MiniMapRootOffset

EditDefaultsOnly

The offset from the owner's root component to position the minimap.

Functions

Return Type

Signature

Description

UMaterialInstanceDynamic*

GetMiniMapMaterial() const

Returns the dynamic material instance used for the minimap.

USceneCaptureComponent2D*

GetSceneCapture() const

Returns the scene capture component used to render the minimap.

Usage & Implementation Notes

  • Threading Constraints: This component should be used on the game thread.

  • Replication Requirements: None.

  • Memory Lifetime Management: The component manages its own memory for the material instance and scene capture component, which are reset in UninitializeComponent.

  • Initialization Dependencies: The component depends on the owner's root component to attach the scene capture component.

22 May 2026