Skip to content

Item

GetOwner function

Syntax:

lua
Character|Actor Item:GetOwner()

GetOwnerInventory function

Syntax:

lua
Inventory Item:GetOwnerInventory()

GetId function

Syntax:

lua
int Item:GetId()

GetName function

Syntax:

lua
string Item:GetName()

GetShortDesc function

Syntax:

lua
string Item:GetShortDesc()

GetLongDesc function

Syntax:

lua
string Item:GetLongDesc()

SetStackSize function

Syntax:

lua
void Item:SetStackSize( int stackSize )

CanUseItem function

Syntax:

lua
bool Item:CanUseItem( Character player )

GetIntStat function

Syntax:

lua
int Item:GetIntStat( string stat )

Available stats:

CurrentEnchantID
ActiveAmmunition
MaxStackSize
CreationTime
ItemVersion
SpellcastID
DrinkAmount
FoodAmount
ItemTier

SetIntStat function

Syntax:

lua
bool Item:SetIntStat( string stat, int value )

GetFloatStat function

Syntax:

lua
float Item:GetFloatStat( string stat )

Available stats:

ArmorValue
EncumbranceWeight
MaxDurability
CurrentDurability
BurnTime

SetFloatStat function

Syntax:

lua
bool Item:SetFloatStat( string stat, float value )

ModifyDurability function

Syntax:

lua
void Item:ModifyDurability( float value )

SetDurability function

Syntax:

lua
void Item:SetDurability( float value )

IsBroken function

Syntax:

lua
bool Item:IsBroken()

DeleteItem function

Syntax:

lua
bool Item:DeleteItem( [ int quantity = 1 ] )