ORK Framework  2.27.1
API Documentation
ORKFramework.GridCellInfoChoice Class Reference
Inheritance diagram for ORKFramework.GridCellInfoChoice:
ORKFramework.BaseData ORKFramework.IChoice ORKFramework.IBaseData ORKFramework.IChoiceSimple

Public Member Functions

override void SetData (DataObject data)
 Sets the variables of the class using a ORKFramework.DataObject. More...
 
bool Tick (GUIBox origin)
 
bool UnfocusedTick (GUIBox origin)
 
bool NotControlableTick (GUIBox origin)
 
void TickToggle ()
 
bool ShowOKButton (GUIBox origin)
 
bool ShowCancelButton (GUIBox origin)
 
bool IsOKButtonActive (GUIBox origin)
 
bool IsCancelButtonActive (GUIBox origin)
 
void Show (Combatant combatant, BattleGridCellComponent gridCell)
 
void Show ()
 
void FocusGained (GUIBox origin)
 
void FocusLost (GUIBox origin)
 
void OutOfBoxClick (GUIBox origin)
 
void Close ()
 
void Closed (GUIBox origin)
 
void ChoiceSelected (int index, GUIBox origin)
 
void SelectionChanged (int index, GUIBox origin)
 
void Canceled (GUIBox origin)
 
- 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...
 

Static Public Member Functions

static string CellInfoReplace (string text, BattleGridCellComponent cell, Combatant combatant)
 

Public Attributes

int guiBoxID = 0
 
bool uiHidesBox = false
 
ToggleKeySetting toggleKey = new ToggleKeySetting()
 
bool showForEmpty = true
 
bool showForOccupied = true
 
bool showForMarked = true
 
bool showForGuests = true
 
bool atCellObject = false
 
string childName = ""
 
Vector2 positionOffset = Vector2.zero
 
bool useTitle = false
 
string [] title
 
string [] infoText = ArrayHelper.CreateArray(ORK.Languages.Count, "")
 

Member Function Documentation

◆ SetData()

override void ORKFramework.GridCellInfoChoice.SetData ( DataObject  data)
virtual

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

Parameters
dataORKFramework.DataObject containing the data.

Reimplemented from ORKFramework.BaseData.