ORK Framework  2.29.0
API Documentation
ORKFramework.Equipment Class Reference
Inheritance diagram for ORKFramework.Equipment:
ORKFramework.BaseLanguageData ORKFramework.BaseIndexData ORKFramework.IContentSimple ORKFramework.BaseData ORKFramework.IBaseData ORKFramework.Armor ORKFramework.Weapon

Public Member Functions

 Equipment (string name)
override void SetData (DataObject data)
 Sets the variables of the class using a ORKFramework.DataObject. More...
string GetName (int lvl)
string GetShortName (int lvl)
GUIContent GetContent (int lvl)
EquipmentPrefabSettings GetPrefabSettings (int lvl)
bool IsEquipableOn (int partID, Combatant combatant, out EquipableOn equipPartSet, ref int partSetIndex)
bool IsEquipable (bool[] ep)
bool IsEquipableOn (int partID)
bool CanEquip (int eID, Combatant combatant)
virtual bool CanCombatantEquip (int eID, Combatant combatant)
IPortrait GetPortrait (IVariableSource variableSource, int typeID, int lvl)
IPortrait GetPortrait (int typeID, int lvl)
- Public Member Functions inherited from ORKFramework.BaseLanguageData
 BaseLanguageData (string name)
void SetLanguageName (string name)
virtual string GetName ()
virtual string GetShortName ()
virtual string GetDescription ()
virtual string GetIconTextCode ()
virtual Texture GetIcon ()
virtual GUIContent GetContent ()
- 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

int itemType = 0
bool dropable = false
bool stealable = false
float sympathyChange = 0
bool oneTimeEquip = false
float inventorySpace = 1
bool inventorySpacePerStack = false
bool ownLimitQuantity = false
bool limitQuantity = false
int quantityLimit = 99
bool ownStackLimitQuantity = false
bool limitStackQuantity = false
int stackQuantityLimit = 99
bool overrideInventoryAddType = false
InventoryAddType inventoryAddType = InventoryAddType.Add
bool ownSelection = false
int selectionID = 0
EquipmentPrefabSettings prefabSettings = new EquipmentPrefabSettings()
PriceSettings price = new PriceSettings()
EquipRequirements equipRequirements = new EquipRequirements()
EquipableOn [] partSet = new EquipableOn[] { new EquipableOn() }
LevelUpType lvlType = LevelUpType.None
int expID = 0
bool ownNotifications = false
InventoryNotification addedNotification
InventoryNotification removedNotification
DurabilityNotification incrDurabNotification
DurabilityNotification decrDurabNotification
DurabilityNotification outwornNotification
bool ownConsoleLevelUp = false
ConsoleTextLevelUp consoleLevelUp
bool ownConsoleAdd = false
ConsoleTextInventory consoleAdd
bool ownConsoleRemove = false
ConsoleTextInventory consoleRemove
bool ownConsoleIncrDurab = false
ConsoleTextDurability consoleIncreaseDurability
bool ownConsoleDecrDurab = false
ConsoleTextDurability consoleDecreaseDurability
bool ownConsoleOutworn = false
ConsoleTextDurability consoleOutworn
TypePrefabViewPortrait [] portrait = new TypePrefabViewPortrait[0]
EquipmentLevel [] level = new EquipmentLevel[] {new EquipmentLevel()}
- Public Attributes inherited from ORKFramework.BaseLanguageData
LanguageContent [] languageInfo


int?? QuantityLimit [get]
int?? StackLimit [get]
- Properties inherited from ORKFramework.BaseLanguageData
virtual int ID [get]
- Properties inherited from ORKFramework.BaseIndexData
virtual int RealID [get, set]
- Properties inherited from ORKFramework.IContentSimple
int ID [get]

Additional Inherited Members

- Protected Attributes inherited from ORKFramework.BaseIndexData
int realID = 0

Member Function Documentation

◆ SetData()

override void ORKFramework.Equipment.SetData ( DataObject  data)

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

dataORKFramework.DataObject containing the data.

Reimplemented from ORKFramework.BaseData.