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

Public Member Functions

virtual bool ShowOKButton (GUIBox origin)
 
virtual bool ShowCancelButton (GUIBox origin)
 
virtual bool IsOKButtonActive (GUIBox origin)
 
virtual bool IsCancelButtonActive (GUIBox origin)
 
virtual bool Tick (GUIBox origin)
 
virtual bool UnfocusedTick (GUIBox origin)
 
virtual bool NotControlableTick (GUIBox origin)
 
override bool ShowFirstDescription ()
 
override void ResetSelection ()
 
override bool FocusFirst ()
 
override bool IsFocused ()
 
virtual void FocusGained (GUIBox origin)
 
virtual void FocusLost (GUIBox origin)
 
virtual void OutOfBoxClick (GUIBox origin)
 
override void Refresh ()
 
override void Show (MenuScreen s)
 
virtual void Show ()
 
override void ChangeCombatant (Combatant old)
 
override void Close (bool closeImmediately)
 
virtual void Closed (GUIBox origin)
 
virtual void ChoiceSelected (int index, GUIBox origin)
 
virtual void SelectionChanged (int index, GUIBox origin)
 
virtual void Canceled (GUIBox origin)
 
- Public Member Functions inherited from ORKFramework.Menu.Parts.BaseMenuPart
virtual void MarkRefresh ()
 
virtual void CombatantChoiceClosed (bool canceled)
 
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 SetData (DataObject data)
 Sets the variables of the class using a ORKFramework.DataObject. More...
 
virtual void EditorAutoSetup (string fieldName)
 Called for all fields using the autoSetup option of the ORKFramework.ORKEditorLayoutAttribute. More...
 

Public Attributes

int guiBoxID = 0
 
bool isMenu = false
 
bool menuOpenSelected = false
 
bool waitForTransition = true
 
int prevKeyID = 0
 
int nextKeyID = 0
 
GUIBoxAudioType changeAudioType = GUIBoxAudioType.Cursor
 
float keyTimeout = 0.25f
 
float keyHoldTimeout = 0.25f
 
ContentLayout contentLayout = new ContentLayout(ContentLayoutType.Both, ContentLayoutInfoType.None)
 
HeaderTexts headerTexts = new HeaderTexts()
 
bool useTitle = false
 
string [] title
 
AddBackButton backButton = new AddBackButton()
 
MenuListMenuItem [] item = new MenuListMenuItem[0]
 

Protected Member Functions

virtual bool CheckTick (GUIBox origin)
 
virtual void UseChangeKeys (GUIBox origin, int currentIndex, int change)
 
virtual void SetKeyTimeout ()
 
virtual void OpenCurrent (bool keepFocus)
 

Protected Attributes

GUIBox box
 
int current = 0
 
int lastOpened = -1
 
ChoiceContent [] choice
 
int [] choiceAction
 
bool [] lastCheck
 
float lastTime = 0
 
MenuScreen currentScreen
 
bool isTransitioning = false
 
bool transitioningKeepFocus = false
 
float keyTimestamp = 0
 
bool keyHolding = false
 
- Protected Attributes inherited from ORKFramework.Menu.Parts.BaseMenuPart
MenuScreen screen
 
bool markRefresh = false
 

Properties

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]