AdventureSouls.SoulsArmorItem Class Reference

Detailed Description

item that is visualized with a mesh renderer and carries some stat bonuses
the logic that actually applies the bonuses and shows the mesh sits in SoulsArmorSlot
this is done because the slot has access to the character while the item carries no runtime data

https://adventure.softleitner.com/manual/item

Inheritance diagram for AdventureSouls.SoulsArmorItem:

Public Member Functions
override bool	CanEquip (CharacterBase character)
int	Modify (AttributeStat stat, int value)
	applies the modification
Public Member Functions inherited from AdventureCore.ItemBase
virtual bool	CanAdd (InventoryBase inventory, int quantity=1)
virtual bool	OnAdd (InventoryBase inventory, int quantity, out InventoryItem inventoryItem)
virtual bool	CanUse (CharacterBase character, int quantity=1)
virtual bool	OnUse (CharacterBase character, int quantity=1)
virtual void	OnEquip (CharacterBase character)
virtual void	OnUnequip (CharacterBase character)
void	Add (CharacterBase character)
void	Remove (CharacterBase character)
void	Add (CharacterActionBase action)
void	Remove (CharacterActionBase action)
override string	ToString ()

Public Attributes
SkinnedMeshRenderer	Prefab
AttributeStatValue[]	StatValues
AttributeValue[]	Requirements
Public Attributes inherited from AdventureCore.ItemBase
string	Key
string	Name
string	Description
Sprite	Image
GameObject	Visual
ItemCategory	Category
ItemSlotCategory	Slot

Properties
override bool	IsEquippable [get]
int	ModifierPriority [get]
	modifiers are applied in the order of their priority this means higher priority modifiers are applied before lower ones
IEnumerable< AttributeStat >	ModifierStats [get]
	which stats this modifier applies to
Properties inherited from AdventureCore.ItemBase
virtual bool	IsStackable [get]
virtual bool	IsEquippable [get]
virtual bool	IsUsable [get]
Properties inherited from AdventureCore.IStatModifier

Member Function Documentation

CanEquip()

override bool AdventureSouls.SoulsArmorItem.CanEquip ( CharacterBase character )

virtual

Reimplemented from AdventureCore.ItemBase.

Modify()

int AdventureSouls.SoulsArmorItem.Modify ( AttributeStat stat, int value )

inline

applies the modification

Parameters

attribute	the stat that will be modified
value	the value before modification

Returns

the modified value

Implements AdventureCore.IStatModifier.

Property Documentation

ModifierPriority

int AdventureSouls.SoulsArmorItem.ModifierPriority

get

modifiers are applied in the order of their priority
this means higher priority modifiers are applied before lower ones

Implements AdventureCore.IStatModifier.

ModifierStats

IEnumerable<AttributeStat> AdventureSouls.SoulsArmorItem.ModifierStats

get

which stats this modifier applies to

Implements AdventureCore.IStatModifier.