ORK Framework  2.22.0
API Documentation
ORKFramework.ItemShortcut Class Reference
Inheritance diagram for ORKFramework.ItemShortcut:
ORKFramework.IInventoryShortcut ORKFramework.ITargetRange ORKFramework.ICastTime ORKFramework.IRenameable ORKFramework.IShortcut ORKFramework.IMarkNewContent ORKFramework.IContent ORKFramework.ISaveData ORKFramework.CoreIShortcut ORKFramework.IPreviewable ORKFramework.IContentSimple ORKFramework.IContent ORKFramework.IContentSimple

Public Member Functions

 ItemShortcut (int id, int quantity)
 
IInventoryShortcut Split (int newQuantity)
 
IShortcut GetCopy (int newQuantity)
 
bool IsEqual (IShortcut shortcut)
 
int BuyPrice (Combatant user)
 
int SellPrice (Combatant user)
 
float GetOccupiedSpace (int quantity)
 
float GetCastTime (Combatant user)
 
void PlayCastAudio (Combatant user)
 
bool CanCancelCasting ()
 
bool CanCastMove ()
 
void ShowCastingConsoleText (Combatant user, List< Combatant > target, Dictionary< Combatant, StatusChangeInformation > statusChangesTarget)
 
void ShowCancelCastingConsoleText (Combatant user, List< Combatant > target, Dictionary< Combatant, StatusChangeInformation > statusChangesTarget)
 
void InitVariables ()
 
bool HasPossibleTargets (Combatant user, List< Combatant > available)
 
List< CombatantGetPossibleTargets (Combatant user, List< Combatant > available)
 
bool CanTarget (Combatant user, Combatant target)
 
virtual bool IsNoneTarget ()
 
virtual bool IsSingleTarget ()
 
virtual bool IsGroupTarget ()
 
virtual bool ToggleTargetRange ()
 
bool IsUseable (UseableIn useIn)
 
float GetActionCost (Combatant user)
 
bool CanUse (Combatant user, bool checkTime, bool checkUseCosts)
 
bool IsDropable ()
 
void CallCombatantSelection (BaseMenuPart parent, bool useAction)
 
bool Use (Combatant user, List< Combatant > targets, bool useAction)
 
bool AutoUse (Combatant user)
 
string GetReuseTimeText (Combatant user, int decimals)
 
IContentSimple GetTypeContent ()
 
string GetName ()
 
void SetName (string name)
 
string GetDescription ()
 
string GetIconTextCode ()
 
Texture GetIcon ()
 
GUIContent GetContent ()
 
string GetInfo (Combatant c)
 
ShortcutHUDWrapper GetDrag (Combatant user)
 
string GetLevelUpCostString (Combatant combatant)
 
IPortrait GetPortrait (int typeID)
 
void UnmarkID (int id)
 
bool MarkFirstAdd ()
 
bool MarkEachAdd ()
 
bool MarkEachChange ()
 
bool UnmarkView (Combatant owner, int unmarkID)
 
bool UnmarkSelection (Combatant owner, int unmarkID)
 
StatusPreview GetPreview (Combatant combatant, PreviewSelection selectedPreview)
 
DataObject SaveGame ()
 Used to save the data - you need to add the data to a ORKFramework.DataObject. More...
 
void LoadGame (DataObject data)
 Used to load the data - you need to get the data from the ORKFramework.DataObject. More...
 

Properties

int Quantity [get, set]
 
Item Setting [get]
 
InventoryAddType InventoryAddType [get]
 
bool InventorySpacePerStack [get]
 
int StackLimit [get]
 
bool Stealable [get]
 
bool Sellable [get]
 
CastTimeSettings CastTimeSettings [get]
 
bool HasVariables [get]
 
VariableHandler Variables [get]
 
bool OnScreenCombatant [get]
 
int ID [get]
 
int TypeID [get]
 
bool IsNewContent [get, set]
 
- Properties inherited from ORKFramework.IInventoryShortcut
InventoryAddType InventoryAddType [get]
 
bool InventorySpacePerStack [get]
 
int StackLimit [get]
 
bool Stealable [get]
 
bool Sellable [get]
 
bool HasVariables [get]
 
VariableHandler Variables [get]
 
- Properties inherited from ORKFramework.IShortcut
int Quantity [get, set]
 
- Properties inherited from ORKFramework.IContent
int TypeID [get]
 
- Properties inherited from ORKFramework.IContentSimple
int ID [get]
 
- Properties inherited from ORKFramework.IMarkNewContent
bool IsNewContent [get, set]
 
- Properties inherited from ORKFramework.ICastTime
CastTimeSettings CastTimeSettings [get]
 

Member Function Documentation

void ORKFramework.ItemShortcut.LoadGame ( DataObject  data)

Used to load the data - you need to get the data from the ORKFramework.DataObject.

Parameters
dataA ORKFramework.DataObject containing the data.

Implements ORKFramework.ISaveData.

DataObject ORKFramework.ItemShortcut.SaveGame ( )

Used to save the data - you need to add the data to a ORKFramework.DataObject.

Returns
A ORKFramework.DataObject containing the data.

Implements ORKFramework.ISaveData.