ORK Framework  2.26.1
API Documentation
ORKFramework.AIBehaviourShortcut Class Reference
Inheritance diagram for ORKFramework.AIBehaviourShortcut:
ORKFramework.IInventoryShortcut ORKFramework.IRenameable ORKFramework.ICallCombatantSelection ORKFramework.IShortcut ORKFramework.IGUID ORKFramework.IMarkNewContent ORKFramework.IVariableSource ORKFramework.ITimestamp ORKFramework.IContent ORKFramework.ISaveData ORKFramework.CoreIShortcut ORKFramework.IPreviewable ORKFramework.IPortraitContent ORKFramework.IContentSimple ORKFramework.IContent ORKFramework.IContentSimple

Public Member Functions

 AIBehaviourShortcut (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)
 
List< CombatantGetPossibleTargets (Combatant user, List< Combatant > available)
 
bool CanTarget (Combatant user, Combatant target)
 
bool IsUseable (UseableIn useIn)
 
bool CanUse (Combatant c, bool checkTime, bool checkUseCosts)
 
bool IsDropable ()
 
bool Use (Combatant user, List< Combatant > targets, bool useAction)
 
void CallCombatantSelection (BaseMenuPart parent, bool useAction)
 
IContentSimple GetTypeContent ()
 
string GetName ()
 
void SetName (string name)
 
string GetDescription ()
 
string GetIconTextCode ()
 
Texture GetIcon ()
 
GUIContent GetContent ()
 
string GetInfo (Combatant c)
 
ShortcutHUDWrapper GetDrag (Combatant user)
 
IPortrait GetPortrait (int typeID)
 
StatusPreview GetPreview (Combatant combatant, PreviewSelection selectedPreview)
 
void UnmarkID (int id)
 
bool MarkFirstAdd ()
 
bool MarkEachAdd ()
 
bool MarkEachChange ()
 
bool UnmarkView (Combatant owner, int unmarkID)
 
bool UnmarkSelection (Combatant owner, int unmarkID)
 
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...
 

Protected Attributes

float timestamp = 0
 

Properties

virtual string GUID [get, set]
 
int? Quantity [get, set]
 
AIBehaviour Setting [get]
 
bool HasVariables [get]
 
VariableHandler Variables [get]
 
int ItemTypeID [get]
 
InventoryAddType InventoryAddType [get]
 
bool InventorySpacePerStack [get]
 
int StackLimit [get]
 
bool Stealable [get]
 
bool Sellable [get]
 
float Timestamp [get, set]
 
int ID [get]
 
int TypeID [get]
 
bool IsNewContent [get, set]
 
- Properties inherited from ORKFramework.IInventoryShortcut
int ItemTypeID [get]
 
InventoryAddType InventoryAddType [get]
 
bool InventorySpacePerStack [get]
 
int StackLimit [get]
 
bool Stealable [get]
 
bool Sellable [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.IGUID
string GUID [get, set]
 
- Properties inherited from ORKFramework.IMarkNewContent
bool IsNewContent [get, set]
 
- Properties inherited from ORKFramework.IVariableSource
bool HasVariables [get]
 
VariableHandler Variables [get]
 
- Properties inherited from ORKFramework.ITimestamp
float Timestamp [get, set]
 

Member Function Documentation

◆ LoadGame()

void ORKFramework.AIBehaviourShortcut.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.

◆ SaveGame()

DataObject ORKFramework.AIBehaviourShortcut.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.