Limen Framework 0.1 Help

ALimenTool

Overview

ALimenTool is a subclass of ALimenPhysicalItem designed to represent interactive tools within the game world. It manages an ability component and handles the logic for activating and deactivating the tool. The class includes delegates for tracking tool activation state changes and provides public methods to control the tool's active state.

Properties

Type

Name

Access

Description

FToolActivationDelegate

OnToolActiveStateChanged

BlueprintAssignable

Delegate that is broadcast when the tool's active state changes.

ULimenAbilityComponent*

AbilityComponent

EditDefaultsOnly, BlueprintReadOnly

The ability component associated with this tool.

bool

bStartActive

EditDefaultsOnly, BlueprintReadOnly

Whether the tool should start in an activated state.

Functions

Return Type

Signature

Description

void

BeginPlay()

Called when the game starts or when spawned. Initializes the tool's active state based on bStartActive.

bool

ActivateTool()

Activates the tool if it can be activated. Returns true if successful, false otherwise.

void

DeactivateTool()

Deactivates the tool.

bool

ToggleTool()

Toggles the tool's active state between activated and deactivated. Returns the new active state.

bool

CanActivate() const

Determines whether the tool can be activated. Returns true if not already active, false otherwise.

bool

IsActive() const

Checks if the tool is currently active. Returns true if active, false otherwise.

void

ToolActivated()

Called when the tool is activated. Can be overridden to implement specific logic for activation.

void

ToolDeactivated()

Called when the tool is deactivated. Can be overridden to implement specific logic for deactivation.

Usage & Implementation Notes

  • The tool's active state is managed by the bIsActive property, which is toggled by public methods.

  • The ToolActivated() and ToolDeactivated() methods are virtual and can be overridden in derived classes to provide custom behavior when the tool is activated or deactivated.

  • The OnToolActiveStateChanged delegate is broadcast whenever the tool's active state changes.

22 May 2026