ORK Framework  2.34.0
API Documentation
ORKFramework.Item Class Reference
Inheritance diagram for ORKFramework.Item:
ORKFramework.BaseLanguageData ORKFramework.IContent ORKFramework.IPortraitContent ORKFramework.BaseIndexData ORKFramework.IContentSimple ORKFramework.IContentSimple ORKFramework.BaseData ORKFramework.IBaseData

Public Member Functions

 Item (string name)
override void SetData (DataObject data)
 Sets the variables of the class using a ORKFramework.DataObject. More...
bool IsUseable (UseableIn useIn)
void SetReuseAfter (Combatant user, SelectedDataHandler selectedData)
KeyEventSetting GetCustomEvent (string eventKey)
void UseCosts (Combatant user, ItemShortcut item, VariableHandler localVariables, SelectedDataHandler selectedData)
bool CanUse (Combatant user, bool checkTime, bool checkUseCosts, ItemShortcut item, VariableHandler localVariables, SelectedDataHandler selectedData)
bool ConsumeItems (Combatant combatant)
bool CheckItems (Combatant combatant)
void Consume (Combatant user, ItemShortcut item)
void UseAccess (ItemShortcut item, Combatant user, List< Combatant > target, GameObject flyingTextTargetObject, bool fromAction, bool animate, bool doUseCosts, float damageFactor, float damageMultiplier, VariableHandler localVariables, SelectedDataHandler selectedData, ActionCalculationFinished notify, ItemAction action)
void Use (ItemShortcut item, Combatant user, List< Combatant > target, GameObject flyingTextTargetObject, bool fromAction, bool animate, bool doUseCosts, float damageFactor, float damageMultiplier, VariableHandler localVariables, SelectedDataHandler selectedData, ActionCalculationFinished notify, ItemAction action)
ActionResultsPredetermined PredetermineResults (List< Combatant > target)
IContentSimple GetTypeContent ()
override string GetDescription ()
override string GetIconTextCode ()
string GetInfo (Combatant c)
IPortrait GetPortrait (IVariableSource variableSource, int typeID)
IPortrait GetPortrait (int typeID)
string FormatQuantity (int value)
- Public Member Functions inherited from ORKFramework.BaseLanguageData
 BaseLanguageData (string name)
void SetLanguageName (string name)
virtual string GetName ()
virtual string GetShortName ()
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 ownDamageType = false
int damageTypeID = 0
bool hidden = false
bool dropable = false
bool stealable = false
float sympathyChange = 0
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
AssetSource< ORKGameEventinitGameEvent = new AssetSource<ORKGameEvent>()
bool ownNumberFormat = false
string quantityFormat = "0"
ItemPrefabSettings prefabSettings = new ItemPrefabSettings()
PriceSettings price = new PriceSettings()
UseableIn useableIn = UseableIn.Both
bool allowDeadUser = false
bool consumeShowNotification = true
bool consumeShowConsole = true
bool revive = false
bool scanTarget = false
bool scanIgnoreNotScanable = false
bool scanIgnoreNoEntry = false
bool selectionKeepOpen = false
bool ownSelection = false
bool useScreenCombatant = false
int selectionID = 0
ItemAbilityType itemAbility = ItemAbilityType.None
int learnAbilityID = 0
bool isGroupAbility = false
int useAbilityID = 0
AbilityActionType actionType = AbilityActionType.Ability
int abilityLevel = 1
bool abilityShowNotification = true
bool abilityShowConsole = true
VariableSetter variables = new VariableSetter()
bool addItems = false
bool addRandomItem = false
bool itemsShowNotification = true
bool itemsShowConsole = true
ItemGain [] items = new ItemGain[0]
bool learnRecipe = false
int recipeID = 0
int recipeQuantity = 1
bool recipeShowNotification = true
bool recipeShowConsole = true
bool learnLog = false
bool completeLog = false
int logTextID = 0
int logID = 0
bool logShowConsole = true
bool ownTurnActionCost = false
ActionCost turnActionCostSetting
bool ownPhaseActionCost = false
ActionCost phaseActionCostSetting
bool ownCastTime = false
CastTimeSettings castTime
EndAfter reuseType = EndAfter.None
UseBlockScope reuseScope = UseBlockScope.Single
FloatValue reuseAfter
bool ownDelay = false
bool useDelay = false
FloatValue delayTime
bool callGlobalEvent = false
int globalEventID = 0
bool changeClass = false
ClassChange classChange = new ClassChange()
bool setRandomBattleFactor = false
float randomBattleFactor = 0
float randomBattleFactorTime = 60
TurnBasedOrderChanges turnBasedOrderChanges = new TurnBasedOrderChanges()
bool changeTimebar = false
FormulaOperator timebarChangeOperator = FormulaOperator.Add
FloatValue timebarChange
Rounding timebarChangeRounding = Rounding.None
bool changeActionsPerTurn = false
bool changeUsedActionsPerTurn = false
FormulaOperator actionsPerTurnChangeOperator = FormulaOperator.Add
FloatValue actionsPerTurnChange
Rounding actionsPerTurnChangeRounding = Rounding.None
EquipmentPartChange [] equipmentPartChange = new EquipmentPartChange[0]
bool useStartAnimation = true
bool useEndAnimation = true
BattleAnimationSetting battleAnimation = new BattleAnimationSetting()
string [] activationTags = new string[0]
DamageDealerActivation ddActivation = new DamageDealerActivation()
TargetSettings targetSettings = new TargetSettings()
bool useRequirements = false
SimpleCombatantRequirement requirement
bool consume = true
UseCostAutoConsumeType autoConsumeType = UseCostAutoConsumeType.No
StatusChange useCost = new StatusChange()
bool itemShowNotification = true
bool itemShowConsole = true
ItemCost [] itemConsume = new ItemCost[0]
StatusChange userChange = new StatusChange()
TargetStatusChange [] targetChange = new TargetStatusChange[0]
ShortcutVariableChanges variableSettings = new ShortcutVariableChanges()
bool ownBattleInfoText = false
BattleInfo battleInfoText
bool ownNotifications = false
InventoryNotification addedNotification
InventoryNotification removedNotification
bool ownConsoleAddAction = false
ConsoleTextActionPreview consoleAddAction
bool ownConsoleAction = false
ConsoleTextActionPreview consoleAction
bool ownConsoleCast = false
ConsoleTextActionPreview consoleCast
bool ownConsoleCastCancel = false
ConsoleTextActionPreview consoleCastCancel
bool ownConsoleAdd = false
ConsoleTextInventory consoleAdd
bool ownConsoleRemove = false
ConsoleTextInventory consoleRemove
TypePrefabViewPortrait [] portrait = new TypePrefabViewPortrait[0]
KeyEventSetting [] customEvent = new KeyEventSetting[0]
- Public Attributes inherited from ORKFramework.BaseLanguageData
LanguageContent [] languageInfo


int?? QuantityLimit [get]
int?? StackLimit [get]
int TypeID [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]
- Properties inherited from ORKFramework.IContent
int TypeID [get]

Additional Inherited Members

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

Member Function Documentation

◆ SetData()

override void ORKFramework.Item.SetData ( DataObject  data)

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

dataORKFramework.DataObject containing the data.

Reimplemented from ORKFramework.BaseData.