ORK Framework  3.17.1
API Documentation
GamingIsLove.ORKFramework.ItemShortcut Class Reference
Inheritance diagram for GamingIsLove.ORKFramework.ItemShortcut:
GamingIsLove.ORKFramework.IKeySchematicStarter GamingIsLove.ORKFramework.UI.ICallCombatantSelection GamingIsLove.ORKFramework.IReuseTime GamingIsLove.ORKFramework.IUseCostDisplay GamingIsLove.ORKFramework.UI.IUIShortcut GamingIsLove.ORKFramework.IRenameable GamingIsLove.ORKFramework.ICastTime GamingIsLove.ORKFramework.ITargetRange GamingIsLove.ORKFramework.IInventoryShortcut< Item >

Public Member Functions

 ItemShortcut (Item item, int quantity)
 
IInventoryShortcut Split (int newQuantity)
 
IShortcut GetCopy (int newQuantity)
 
bool IsEqual (IShortcut shortcut)
 
string FormatQuantity (int quantity)
 
int BuyPrice (Combatant user)
 
int SellPrice (Combatant user)
 
virtual SelectedDataHandler GetSelectedData ()
 
bool IsItemType (ItemType type, bool checkParent)
 
void GetItemType (List< ItemType > addToList)
 
float GetOccupiedSpace (int quantity)
 
int GetQuantityForSpace (float availableSpace)
 
void StartKeySchematic (string callKey, object machineObject, object startingObject, VariableHandler localVariables, Notify finishedCallback)
 
virtual UIShortcutSettings GetUISettings ()
 
CastTime GetCastTimeSetting (Combatant user)
 
void ShowCastingConsoleText (Combatant user, List< Combatant > target, Dictionary< Combatant, StatusChangeInformation > statusChangesTarget)
 
void ShowCancelCastingConsoleText (Combatant user, List< Combatant > target, Dictionary< Combatant, StatusChangeInformation > statusChangesTarget)
 
void InitVariables ()
 
void UpdateVariableChanges ()
 
bool HasPossibleTargets (Combatant user, List< Combatant > available)
 
List< CombatantGetPossibleTargets (Combatant user, List< Combatant > available)
 
bool CanTarget (Combatant user, Combatant target)
 
bool CanTargetToggled (Combatant user, Combatant target)
 
virtual bool IsNoneTarget ()
 
bool IsNoneTargetSelection ()
 
virtual bool IsSingleTarget ()
 
virtual bool IsGroupTarget ()
 
virtual bool CanToggleTargetRange ()
 
virtual bool CanToggleTargetType ()
 
bool InRange (Combatant user, Combatant target)
 
bool IsUseable (UseableIn useIn)
 
bool CanUse (Combatant user, bool checkTime, bool checkUseCosts)
 
bool IsDropable ()
 
void CallCombatantSelection (ICombatantSelectionOrigin parent, bool useAction)
 
bool Use (Combatant user, List< Combatant > targets, bool useAction)
 
bool AutoUse (Combatant user)
 
ReuseTime GetReuseTimeSetting (Combatant user)
 
bool IsReuseBlocked (Combatant user)
 
string GetReuseTimeText (Combatant user, int decimals)
 
string GetReuseTimeFormatted (float seconds)
 
float GetReuseTime (Combatant user)
 
float GetMaxReuseTime (Combatant user)
 
virtual void FireUseCountChanged ()
 
virtual void SetUseCount (int useCount, int maxUseCount)
 
virtual void ResetUseCount (Combatant user, UseCountResetType resetType)
 
virtual void ChangeUseCount (int change, FloatOperator floatOperator)
 
IContent GetTypeContent ()
 
string GetName ()
 
string GetShortName ()
 
string GetDescription ()
 
string GetIconTextCode ()
 
Texture GetIconTexture ()
 
virtual Sprite GetIconSprite ()
 
virtual string GetCustomContent (string contentKey)
 
string GetInfo (Combatant combatant)
 
string GetUseCostText (Combatant user)
 
float GetActionCost (Combatant user)
 
float GetActionCost (Combatant user, BattleSystem battleSystem)
 
DragShortcutWrapper GetDrag (Combatant user)
 
IPortrait GetPortrait (PortraitTypeAsset portraitType)
 
void UnmarkNewContent (object value)
 
bool MarkFirstAdd ()
 
bool MarkEachAdd ()
 
bool MarkEachChange ()
 
bool UnmarkView (Combatant owner, object value)
 
bool UnmarkSelection (Combatant owner, object value)
 
StatusPreview GetPreview (Combatant combatant, PreviewSelection selectedPreview)
 
DataObject SaveGame ()
 
void LoadGame (DataObject data)
 

Static Public Member Functions

static ItemShortcut GetItemShortcut (object value)
 

Protected Attributes

float timestamp = 0
 
int useCount = -1
 
int maxUseCount = -1
 
Notify useCountChangedHandler
 

Properties

NotifyShortcut QuantityChanged
 
Notify SimpleQuantityChanged
 
Notify UseCountChanged
 
virtual string GUID [get, set]
 
bool IsHidden [get]
 
int Quantity [get, set]
 
string QuantityFormatted [get]
 
Item Setting [get]
 
ItemType ItemType [get]
 
InventoryAddType InventoryAddType [get]
 
bool? InventorySpacePerStack [get]
 
int? StackLimit [get]
 
bool? IsFullStack [get]
 
bool? Stealable [get]
 
bool? Sellable [get]
 
float Timestamp [get, set]
 
bool HasVariables [get]
 
VariableHandler Variables [get]
 
virtual int UseCount [get, set]
 
virtual int MaxUseCount [get]
 
virtual bool HasUseCount [get]
 
int ID [get]
 
string RenameableName [get, set]
 
string RenameableDescription [get, set]
 
bool IsNewContent [get, set]
 
- Properties inherited from GamingIsLove.ORKFramework.IRenameable
string RenameableName [get, set]
 
string RenameableDescription [get, set]