ARDEM
API Reference
A

AArdemCharacter

inherits ACharacter

The base player-controlled character. Inherit to override core survival logic, damage handling, and movement.

7 properties8 methods4 overrides2 events

Properties

Health
floatread

Current health points (0.0 – 100.0).

MaxHealth
floatread / write

Maximum health capacity. Modify to apply perks or buffs.

bIsAlive
boolread

True while the character has Health > 0.

InventoryComponent
UArdemInventoryComponent*read

Attached inventory. Use to query and modify items.

SurvivalComponent
UArdemSurvivalComponent*read

Tracks hunger, thirst, body temperature, and fatigue.

WeaponComponent
UArdemWeaponComponent*read

Handles currently equipped weapon and ballistics.

DisplayName
FStringread / write

Player display name shown in the world and HUD.

Methods

float GetHealth() const
method

Returns current health value.

void SetHealth(float NewHealth)
method

Directly set health. Clamps to [0, MaxHealth]. Does not fire damage events.

void DealDamage(float Amount, AArdemCharacter* Instigator)
method

Apply damage from another actor. Fires OnDamageReceived and respects armor.

void Heal(float Amount)
method

Restore health up to MaxHealth.

bool GiveItem(const FString& ItemSlug, int32 Quantity = 1)
method

Add items to inventory by slug. Returns false if inventory is full.

void SendChatMessage(const FString& Message)
method

Display a server-side chat message visible only to this player.

bool Teleport(FVector Location, FRotator Rotation)
method

Instantly move the player to a world location.

void Kill()
method

Force-kill the character, triggering the full death sequence.

Overrides

virtual void OnDamageReceived(float Amount, AArdemCharacter* Instigator)
override

Called whenever this character takes damage. Override to intercept or modify incoming damage.

virtual void OnDeath()
override

Called when Health reaches 0. Override to add custom death logic or drop items.

virtual void OnRespawn(FVector SpawnLocation)
override

Called immediately before the character respawns. Override to restore gear or stats.

virtual bool CanPickUpItem(UArdemItemBase* Item) const
override

Return false to prevent this player from picking up a specific item.

Events & Delegates

FOnPlayerJoin OnPlayerJoin
event

Delegate fired when this character fully enters the world. Bind in subsystem Initialize().

FOnPlayerLeave OnPlayerLeave
event

Delegate fired when this player disconnects or leaves the session.