ORK Framework  2.25.2
API Documentation
ORKFramework.GridExamineSettings Class Reference
Inheritance diagram for ORKFramework.GridExamineSettings:
ORKFramework.BaseData ORKFramework.IBaseData

Public Member Functions

override void SetData (DataObject data)
 Sets the variables of the class using a ORKFramework.DataObject. More...
void Clear ()
bool CheckAlwaysActive ()
void CloseCombatantInfoBox ()
void CloseCombatantInfoBox (bool autoShow)
void CombatantInfoClosed (bool accepted)
void PlayMoveRange ()
void PlayAttackRange ()
void Start (Combatant combatant, BattleGridCellComponent selectedCell, Notify notify)
void StartAlwaysActive (Combatant combatant, BattleGridCellComponent selectedCell)
void Restart (Combatant combatant)
void Tick ()
void TickExternalCall ()
void TickToggles ()
void Close ()
void SelectCell (BattleGridCellComponent cell, bool isHover)
void ExternalExamine (BattleGridCellComponent cell, bool showCellInfo, bool showCombatantInfo)
void AcceptCell (BattleGridCellComponent cell)
bool CheckAcceptCell (BattleGridCellComponent cell)
- 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 allowCancel = false
bool blockActionUse = false
bool alwaysActive = false
bool alwaysActiveDuringTargetSelection = false
bool alwaysActiveDuringActions = false
bool alwaysActiveOnlyPlayerPhase = false
bool targetExamineCell = false
bool targetExamineCellCombatant = false
bool cameraControlTarget = false
bool ownControlTargetTransition = false
CameraControlTargetTransition controlTargetTransition
bool showInfo = false
InfoBoxChoice info
bool ownCellSelection = false
GridCellSelectionSettings selection
GridCellInfoChoice [] cellInfo = new GridCellInfoChoice[0]
bool showMoveRange = false
bool moveRangeMaxEnemy = true
bool moveRangeMaxAlly = true
bool moveRangeAuto = false
int moveRangeKeyID = 0
AssetSource< AudioClip > moveRangeAudio
float moveRangeVolume = 1.0f
bool showAttackRange = false
bool useCounterRange = false
bool attackRangeAuto = false
int attackRangeKeyID = 0
AssetSource< AudioClip > attackRangeAudio
float attackRangeVolume = 1.0f
GridExamineBestiaryChoice [] combatantInfoDisplay = new GridExamineBestiaryChoice[0]


bool IsExternalCall [get]
bool IsAlwaysActiveOn [get]
bool ExamineTarget [get]

Member Function Documentation

◆ SetData()

override void ORKFramework.GridExamineSettings.SetData ( DataObject  data)

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

dataORKFramework.DataObject containing the data.

Reimplemented from ORKFramework.BaseData.