Limen Framework 0.1 Help

ILimenInventoryItem

Overview

The ILimenInventoryItem interface is used by classes that represent items within an inventory system. It provides a standardized way to access properties such as the item's image, display name, description, actions, quantity, and associated actor. This interface ensures consistency across different implementations of inventory items.

Properties

Type

Name

Access

Description

UTexture*

GetItemImage() const

BlueprintReadOnly

Returns a pointer to the texture representing the item's image.

const FText&

GetDisplayName() const

BlueprintReadOnly

Returns the display name of the item as an FText.

const FText&

GetDescription() const

BlueprintReadOnly

Returns a description of the item as an FText.

TArray<[ULimenItemAction](LimenItemAction.md)*>

GetItemActions() const

BlueprintReadOnly

Returns an array of actions that can be performed on the item.

int32

GetItemQuantity() const

BlueprintReadOnly

Returns the quantity of the item in the inventory.

AActor*

GetActor() const

BlueprintReadOnly

Returns a pointer to the actor associated with the item. This function is templated to allow casting to specific actor types.

Functions

Return Type

Signature

Description

UTexture*

GetItemImage() const

Returns a pointer to the texture representing the item's image.

const FText&

GetDisplayName() const

Returns the display name of the item as an FText.

const FText&

GetDescription() const

Returns a description of the item as an FText.

TArray<[ULimenItemAction](LimenItemAction.md)*>

GetItemActions() const

Returns an array of actions that can be performed on the item.

int32

GetItemQuantity() const

Returns the quantity of the item in the inventory.

AActor*

GetActor() const

Returns a pointer to the actor associated with the item. This function is templated to allow casting to specific actor types.

Usage & Implementation Notes

  • Threading Constraints: None.

  • Replication Requirements: None.

  • Memory Lifetime Management: The lifetime of objects implementing this interface should be managed by their owning inventory system or manager.

  • Initialization Dependencies: Implementing classes must provide concrete implementations for all pure virtual functions defined in the interface.

22 May 2026