ORK Framework  2.25.2
API Documentation
ORKFramework.ResearchItem Class Reference
Inheritance diagram for ORKFramework.ResearchItem:
ORKFramework.ISaveData ORKFramework.IContent ORKFramework.IMarkNewContent ORKFramework.IPreviewable ORKFramework.IUseCostDisplay ORKFramework.IContentSimple ORKFramework.IContent ORKFramework.IContentSimple

Public Member Functions

 ResearchItem (int index, ResearchTree researchTree, ResearchItemSetting setting)
 
string GetName ()
 
string GetDescription ()
 
string GetIconTextCode ()
 
Texture GetIcon ()
 
GUIContent GetContent ()
 
IContentSimple GetTypeContent ()
 
string GetInfo (Combatant combatant)
 
string GetUseCostText (Combatant user)
 
bool CanResearch ()
 
ResearchDisplayType GetResearchDisplayType ()
 
bool CanCancel ()
 
void StartResearch ()
 
void CancelResearch ()
 
void ResearchFinished ()
 
void ManualProgress (float add)
 
void TimeProgress (float add)
 
void Progress (float add)
 
void UpdateDuration (bool checkFinished)
 
void ResetProgress ()
 
void ResetManualProgress ()
 
void ResetTimeProgress ()
 
void UnmarkID (int id)
 
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

ResearchItemSetting Setting [get]
 
ResearchTree ResearchTree [get]
 
ResearchItemState State [get]
 
int ResearchCount [get]
 
float ProgressValue [get]
 
float DurationValue [get]
 
int ID [get]
 
int TypeID [get]
 
bool IsNewContent [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]
 

Member Function Documentation

◆ LoadGame()

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