Limen Framework 0.1 Help

ULimenGameInstance

Overview

ULimenGameInstance is derived from UGameInstance and serves as the central game instance class in the Limen framework. It provides static methods to retrieve the game instance associated with a given world, ensuring type safety through template specialization.

Properties (Table: Type | Name | Access | Description)

Type

Name

Access

Description

None

None

None

None

Functions (Table: Return Type | Signature | Description)

Return Type

Signature

Description

GameInstanceClass*

GetGameInstance<UWorld* World>()

Retrieves an instance of GameInstanceClass from the specified world. If the instance is valid, it returns a pointer to the instance; otherwise, it returns nullptr.

Usage & Implementation Notes

  • Threading Constraints: This function should be called on the game thread.

  • Replication Requirements: Not applicable as this is a server-side class.

  • Memory Lifetime Management: The lifetime of the game instance is managed by Unreal Engine's garbage collection system. Ensure that any resources held by the game instance are properly cleaned up when the instance is destroyed.

  • Initialization Dependencies: This function assumes that the world has been initialized and that the game instance is set on the world.

22 May 2026