ORK Framework  2.29.0
API Documentation
ORKFramework.ItemBoxChoice Class Reference
Inheritance diagram for ORKFramework.ItemBoxChoice:
ORKFramework.BaseData ORKFramework.IChoice ORKFramework.IDragOrigin ORKFramework.IChoiceDrop ORKFramework.IBaseData ORKFramework.IChoiceSimple

Public Member Functions

override void SetData (DataObject data)
 Sets the variables of the class using a ORKFramework.DataObject. More...
string GetItemListText ()
bool Tick (GUIBox origin)
bool UnfocusedTick (GUIBox origin)
bool NotControlableTick (GUIBox origin)
bool ShowOKButton (GUIBox origin)
bool ShowCancelButton (GUIBox origin)
bool IsOKButtonActive (GUIBox origin)
bool IsCancelButtonActive (GUIBox origin)
void Show (ItemCollector ic)
void Show ()
void FocusGained (GUIBox origin)
void FocusLost (GUIBox origin)
void OutOfBoxClick (GUIBox origin)
void Close ()
void Closed (GUIBox origin)
void CreateChoices ()
void ChoiceSelected (int index, GUIBox origin)
void SelectionChanged (int index, GUIBox origin)
void Canceled (GUIBox origin)
bool AddQuantity (IShortcut shortcut, bool showNotification, bool showConsole, bool markNewContent)
void RemoveQuantity (IShortcut shortcut, int quantity, bool showNotification, bool showConsole)
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)
- 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

ItemCollectionAnimation animateBefore = new ItemCollectionAnimation()
ItemCollectionAnimation animateAfter = new ItemCollectionAnimation()
bool useInventoryExchangeMenu = false
int menuScreenID = 0
bool enableDrag = false
bool enableClick = false
int clickCount = 2
bool enableTooltip = false
bool receiveDrops = false
QuantityCall dropQuantity
QuantityCall takeQuantity = new QuantityCall()
int guiBoxID = 0
bool useInventoryAddType = false
bool allowCancel = true
bool autoClose = false
bool useItemButtons = true
bool useChoice = false
bool useTitle = false
string [] title
ContentLayout contentLayout = new ContentLayout(ContentLayoutType.Both, ContentLayoutInfoType.Info)
string [] message = ArrayHelper.CreateArray(ORK.Languages.Count, "")
string [] messageEmpty = ArrayHelper.CreateArray(ORK.Languages.Count, "")
bool lineSeparation = true
string separator = ", "
string [] itemText = ArrayHelper.CreateArray(ORK.Languages.Count, "%n (%)")
bool useNotCollectable = false
string [] notCollectableText
bool showTakeAll = false
bool takeAllFirst = false
ContentButton takeAllButton
bool showExit = false
bool exitFirst = false
ContentButton exitButton
bool showDescription = false
DescriptionMenuPart description


string Message [get]
string Title [get]

Member Function Documentation

◆ SetData()

override void ORKFramework.ItemBoxChoice.SetData ( DataObject  data)

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

dataORKFramework.DataObject containing the data.

Reimplemented from ORKFramework.BaseData.