ORK Framework  2.31.0
API Documentation
ORKFramework.Menu.Parts.ResearchMenuPart Class Reference
Inheritance diagram for ORKFramework.Menu.Parts.ResearchMenuPart:
ORKFramework.Menu.Parts.BaseMenuPart ORKFramework.IChoice ORKFramework.ITabChoice ORKFramework.Menu.Parts.CoreMenuPart ORKFramework.IChoiceSimple ORKFramework.BaseData ORKFramework.IBaseData

Public Member Functions

override void SetData (DataObject data)
 Sets the variables of the class using a ORKFramework.DataObject. More...
bool ShowOKButton (GUIBox origin)
bool ShowCancelButton (GUIBox origin)
bool IsOKButtonActive (GUIBox origin)
bool IsCancelButtonActive (GUIBox origin)
bool Tick (GUIBox origin)
bool UnfocusedTick (GUIBox origin)
bool NotControlableTick (GUIBox origin)
override bool ShowFirstDescription ()
override bool FocusFirst ()
override bool IsFocused ()
void ResearchChanged (Combatant combatant)
void ProgressChanged ()
override void Refresh ()
override void Show (MenuScreen s)
override void Close (bool closeImmediately)
override void ResetSelection ()
void Show ()
void FocusGained (GUIBox origin)
void FocusLost (GUIBox origin)
void OutOfBoxClick (GUIBox origin)
void Closed (GUIBox origin)
override void CombatantChoiceClosed (bool canceled)
override void ChangeCombatant (Combatant old)
void ShowSelectedPreview ()
void ChoiceSelected (int index, GUIBox origin)
void SelectionChanged (int index, GUIBox origin)
void TabChanged (int index, GUIBox box)
void Canceled (GUIBox origin)
- Public Member Functions inherited from ORKFramework.Menu.Parts.BaseMenuPart
virtual void MarkRefresh ()
virtual void SubMenuClosed (bool canceled)
virtual void ClearOverrides (bool refresh)
virtual bool SetOverrideType (BaseMenuPart backPart, int[] type, bool focus)
virtual bool SetOverrideDefaultAction (BaseMenuPart backPart, bool backAfterUse, MenuActionSetting defaultAction, bool focus)
- 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

bool closeAfterStart = false
bool closeAfterStop = false
bool closeAfterNoReturn = false
bool closeAfterAll = false
bool allTypes = true
bool mergeSubTypes = false
bool enableTypeTooltip = false
TypeSorter typeSorter = new TypeSorter()
bool setStartParentType = false
int startParentTypeID = 0
bool addAllTypeChoice = false
bool allTypeChoiceFirst = true
ContentButton allTypeButton
int [] availableTypeID
bool useTypeKeys = false
int nextTypeKey = 0
int prevTypeKey = 0
GUIBoxAudioType typeKeysAudioType = GUIBoxAudioType.Cursor
MenuTypeDisplay typeDisplay = MenuTypeDisplay.GUIBox
bool showEmptyTypes = false
MenuBoxDisplay displayTree = MenuBoxDisplay.Multi
int guiBoxID = 0
AddBackButton typeBackButton = new AddBackButton()
bool useTypeTitle = false
string [] typeTitle
bool useNewTypeContentLayout = false
ContentLayout typeContentLayout = new ContentLayout(ContentLayoutType.Both, ContentLayoutInfoType.None)
ContentLayout newTypeContentLayout = new ContentLayout(ContentLayoutType.Both, ContentLayoutInfoType.None)
HeaderTexts typeHeaderTexts = new HeaderTexts()
MenuBoxDisplay displayItems = MenuBoxDisplay.Multi
int guiBoxID2 = 0
bool enableTreeTooltip = false
bool showTreePortraits = false
int treePortraitTypeID = 0
ContentSorter treeSorter = new ContentSorter()
AddBackButton treeBackButton = new AddBackButton()
bool useTitleTree = false
string [] titleTree
bool useNewTreeContentLayout = false
ContentLayout treeContentLayout = new ContentLayout(ContentLayoutType.Both, ContentLayoutInfoType.None)
ContentLayout newTreeContentLayout = new ContentLayout(ContentLayoutType.Both, ContentLayoutInfoType.None)
HeaderTexts treeHeaderTexts = new HeaderTexts()
MenuBoxDisplay displayDetails = MenuBoxDisplay.Multi
int guiBoxID3 = 0
bool itemCloseTypeBox = false
bool showItemPortrait = false
bool enableItemTooltip = false
int itemPortraitTypeID = 0
ContentSorter itemSorter = new ContentSorter()
bool addResearchable = true
bool addNotResearchableLimit = false
bool addNotResearchableCosts = false
bool addNotResearchableRequirements = false
bool addInResearch = true
bool addComplete = false
AddBackButton itemBackButton = new AddBackButton()
bool useTitleItem = false
string [] titleItem
bool useNewItemContentLayout = false
HeaderTexts itemHeaderTexts = new HeaderTexts()
ContentLayout itemContentLayout = new ContentLayout(ContentLayoutType.Both, ContentLayoutInfoType.Info)
ContentLayout newItemContentLayout
bool useResearchableLayout = false
ContentLayout itemResearchableContentLayout
ContentLayout newItemResearchableContentLayout
bool useNotResearchableLimitLayout = false
ContentLayout itemNotResearchableLimitContentLayout
ContentLayout newItemNotResearchableLimitContentLayout
bool useNotResearchableCostsLayout = false
ContentLayout itemNotResearchableCostsContentLayout
ContentLayout newItemNotResearchableCostsContentLayout
bool useNotResearchableRequirementsLayout = false
ContentLayout itemNotResearchableRequirementsContentLayout
ContentLayout newItemNotResearchableRequirementsContentLayout
bool useInResearchLayout = false
ContentLayout itemInResearchContentLayout
ContentLayout newItemInResearchContentLayout
bool useCompleteLayout = false
ContentLayout itemCompleteContentLayout
ContentLayout newItemCompleteContentLayout
bool itemExtendedDisplay = false
HUDWrapperPlacement itemHUDPlacement = HUDWrapperPlacement.IgnoreContent
HUDResearchItem [] itemHUDElement
MenuDetailsBoxMode detailsBoxMode = MenuDetailsBoxMode.None
int guiBoxID4 = 0
bool detailsBlockFocus = false
bool detailsCloseTypeBox = false
bool detailsCloseTreeBox = false
bool detailsShowAllButtons = false
bool detailsCancelFirst = false
bool showDetailsPortrait = false
int detailsPortraitTypeID = 0
bool useTitleDetails = false
string [] titleDetails
string [] detailsText
AddBackButton detailsBackButton = new AddBackButton()
ContentLayout detailsContentLayout = new ContentLayout(ContentLayoutType.Both, ContentLayoutInfoType.None)
ContentButton startResearchButton
ContentButton cancelResearchButton
bool detailsExtendedDisplay = false
HUDWrapperPlacement detailsHUDPlacement = HUDWrapperPlacement.IgnoreContent
bool enableDetailsTooltip = false
HUDResearchItem [] detailsHUDElement
bool showStartQuestion = false
ResearchItemQuestionChoice startQuestion
bool showCancelQuestion = false
ResearchItemQuestionChoice cancelQuestion


override ORKDataType TypeDataType [get]
override bool Controlable [get]
override bool IsOpened [get]
override bool IsClosed [get]
- Properties inherited from ORKFramework.Menu.Parts.BaseMenuPart
MenuScreen Screen [get, set]
virtual bool OnScreenCombatant [get]
virtual bool ShouldRefresh [get]
abstract bool IsOpened [get]
abstract bool IsClosed [get]
virtual bool Controlable [get]
virtual ORKDataType TypeDataType [get]

Additional Inherited Members

- Protected Attributes inherited from ORKFramework.Menu.Parts.BaseMenuPart
MenuScreen screen
bool markRefresh = false

Member Function Documentation

◆ SetData()

override void ORKFramework.Menu.Parts.ResearchMenuPart.SetData ( DataObject  data)

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

dataORKFramework.DataObject containing the data.

Reimplemented from ORKFramework.BaseData.