ORK Framework  2.34.0
API Documentation
ORKFramework.Menu.Parts.GroupMenuPart Class Reference
Inheritance diagram for ORKFramework.Menu.Parts.GroupMenuPart:
ORKFramework.Menu.Parts.BaseMenuPart ORKFramework.IChoice ORKFramework.IDragOrigin ORKFramework.IChoiceDrop ORKFramework.IChoiceDragSort 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 ()
override void Refresh ()
override void Show (MenuScreen s)
override void ChangeCombatant (Combatant old)
override void Close (bool closeImmediately)
void GroupChanged (Group group)
override void ResetSelection ()
void Show ()
void FocusGained (GUIBox origin)
void FocusLost (GUIBox origin)
void OutOfBoxClick (GUIBox origin)
void Closed (GUIBox origin)
void ChoiceSelected (int index, GUIBox origin)
void SelectionChanged (int index, GUIBox origin)
void Canceled (GUIBox origin)
void Dropped (DragInfo drag)
bool DroppedOnCombatant (Combatant c, DragInfo drag)
bool DroppedToWorld (Vector3 position, DragInfo drag)
void ChoiceDropped (int index, GUIBox origin, DragInfo drag, ref GUIBoxAudioType playDropAudio)
void ChoiceDragSort (GUIBox origin, int index, int newIndex)
- 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 EditorAutoSetup (string fieldName)
 Called for all fields using the autoSetup option of the ORKFramework.ORKEditorLayoutAttribute. More...

Public Attributes

bool showActionBox = true
MenuBoxDisplay display = MenuBoxDisplay.Multi
int guiBoxID = 0
bool useActionTitle = false
string [] actionTitle
ContentLayout actionContentLayout = new ContentLayout(ContentLayoutType.Both, ContentLayoutInfoType.None)
HeaderTexts actionHeaderTexts = new HeaderTexts()
GroupMenuItem [] menuItem
MenuBoxDisplay displayText = MenuBoxDisplay.Multi
int guiBoxID2 = 0
bool allowDragSortGroup1 = false
bool changeMenuUserGroup1 = false
AddBackButton backButtonGroup1 = new AddBackButton()
bool useTitle = false
string [] title
ContentLayout contentLayout = new ContentLayout(ContentLayoutType.Both, ContentLayoutInfoType.None)
HeaderTexts headerTextsGroup1 = new HeaderTexts()
ContentButton emptySlot = new ContentButton("Empty")
int guiBoxID3 = 0
bool allowDragSortGroup2 = false
bool changeMenuUserGroup2 = false
bool closeTypeBox = false
AddBackButton backButtonGroup2 = new AddBackButton()
bool useTitleGroup2 = false
string [] titleGroup2
HeaderTexts headerTextsGroup2 = new HeaderTexts()
ContentButton emptySlotGroup2 = new ContentButton("Empty")
bool enableDrag = false
bool enableClick = false
int clickCount = 2
bool enableTooltip = false
bool ownCombatantChoice = false
CombatantChoiceLayout combatantChoice
bool useSortCombatantChoice = false
CombatantChoiceLayout sortCombatantChoice


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.GroupMenuPart.SetData ( DataObject  data)

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

dataORKFramework.DataObject containing the data.

Reimplemented from ORKFramework.BaseData.

Member Data Documentation

◆ menuItem

GroupMenuItem [] ORKFramework.Menu.Parts.GroupMenuPart.menuItem
Initial value:
= new GroupMenuItem[] {
new GroupMenuItem(GroupMenuAction.Change),
new GroupMenuItem(GroupMenuAction.Remove)