ORK Framework  2.24.0
API Documentation
ORKFramework.PhaseCombatantChoice Class Reference
Inheritance diagram for ORKFramework.PhaseCombatantChoice:
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...
 
void PlayEndPhaseClip ()
 
void PlayChangeCombatantClip ()
 
bool ShowOKButton (GUIBox origin)
 
bool ShowCancelButton (GUIBox origin)
 
bool IsOKButtonActive (GUIBox origin)
 
bool IsCancelButtonActive (GUIBox origin)
 
void Clear ()
 
bool Tick (GUIBox origin)
 
bool UnfocusedTick (GUIBox origin)
 
bool NotControlableTick (GUIBox origin)
 
void Show (List< Combatant > combatants)
 
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)
 
- 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 useCombatantChoice = true
 
bool forceAICombatants = false
 
bool showSelectionBox = true
 
bool autoSelect = false
 
bool autoSelectOne = false
 
bool allowClicking = true
 
bool allowClickingWhileSelected = false
 
int guiBoxID = 0
 
bool onlyAvailable = false
 
bool keepOpen = false
 
ChoiceMessage message = new ChoiceMessage()
 
bool addEndPhase = false
 
bool endPhaseFirst = false
 
LanguageInfoButton endPhaseButton
 
bool ownCombatantChoice = false
 
CombatantChoiceLayout combatantChoice
 
bool useKeys = false
 
int endPhaseKeyID = 0
 
int nextCombatantKeyID = 0
 
int previousCombatantKeyID = 0
 
AssetSource< AudioClip > endPhaseClip
 
float endPhaseVolume = 1.0f
 
AssetSource< AudioClip > changeCombatantClip
 
float changeCombatantVolume = 1.0f
 

Properties

string Message [get]
 

Member Function Documentation

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

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

Parameters
dataORKFramework.DataObject containing the data.

Reimplemented from ORKFramework.BaseData.