ORK Framework  2.29.0
API Documentation
ORKFramework.ItemGain Class Reference
Inheritance diagram for ORKFramework.ItemGain:
ORKFramework.BaseData ORKFramework.IBaseData

Public Member Functions

override void SetData (DataObject data)
 Sets the variables of the class using a ORKFramework.DataObject. More...
 
ItemGainSimple ToSimpleGain (Combatant combatant)
 
string GetName ()
 
string GetDescription ()
 
string GetIconTextCode ()
 
IShortcut CreateShortcutChance (Combatant user, Combatant target)
 
IShortcut CreateShortcut (Combatant user, Combatant target)
 
int GetQuantity (Combatant user, Combatant target)
 
float GetChance (Combatant user, Combatant target)
 
bool IsItem ()
 
bool IsWeapon ()
 
bool IsArmor ()
 
bool IsCurrency ()
 
bool IsAIBehaviour ()
 
bool IsAIRuleset ()
 
bool IsCraftingRecipe ()
 
bool CheckChance (Combatant user, Combatant target)
 
bool Add (Inventory inventory, bool useChance, bool showNotification, bool showConsole)
 
bool Remove (Inventory inventory, bool useChance, bool showNotification, bool showConsole)
 
bool Has (Inventory inventory)
 
void GetFromInventory (Inventory inventory, bool useChance, ref List< IShortcut > list)
 
- Public Member Functions inherited from ORKFramework.BaseData
virtual DataObject GetData ()
 Gets a ORKFramework.DataObject representing the class. More...
 
virtual void EditorAutoSetup (string fieldName)
 Called for all fields using the autoSetup option of the ORKFramework.ORKEditorLayoutAttribute. More...
 

Public Attributes

ItemDropType type = ItemDropType.Item
 
int id = 0
 
int level = 1
 
FloatValue quantityValue = new FloatValue(1)
 
FloatValue chanceValue = new FloatValue(100)
 

Member Function Documentation

◆ SetData()

override void ORKFramework.ItemGain.SetData ( DataObject  data)
virtual

Sets the variables of the class using a ORKFramework.DataObject.

Parameters
dataORKFramework.DataObject containing the data.

Reimplemented from ORKFramework.BaseData.