ORK Framework  2.24.0
API Documentation
ORKFramework.BattleGridHighlightSettings Class Reference
Inheritance diagram for ORKFramework.BattleGridHighlightSettings:
ORKFramework.BaseData ORKFramework.IBaseData

Public Member Functions

void Tick ()
 
bool IsHidden (GridHighlightType type)
 
GridHighlightType GetSelectionHighlight (GridHighlightType type, BattleGridCellComponent cell)
 
GridHighlightType GetCombatantCellHighlight (Combatant combatant)
 
bool IsEnabled (GridHighlightType type)
 
GridHighlight GetHighlight (GridHighlightType type)
 
- Public Member Functions inherited from ORKFramework.BaseData
virtual DataObject GetData ()
 Gets a ORKFramework.DataObject representing the class. More...
 
virtual void SetData (DataObject data)
 Sets the variables of the class using a ORKFramework.DataObject. More...
 
virtual void EditorAutoSetup (string fieldName)
 Called for all fields using the autoSetup option of the ORKFramework.ORKEditorLayoutAttribute. More...
 

Public Attributes

bool hideUnusedPrefabs = true
 
BaseGridHighlight areaHighlight = new BaseGridHighlight()
 
BaseGridHighlight selectionHighlight = new BaseGridHighlight()
 
BaseGridHighlight noSelectionHighlight = new BaseGridHighlight()
 
bool useCombatantCells = false
 
bool uiHidesCombatantCells = false
 
bool useTurnEndedCombatantCells = false
 
GridHighlight combatantCellPlayer
 
GridHighlight combatantCellAlly
 
GridHighlight combatantCellEnemy
 
GridHighlight combatantCellPlayerTurnEnded
 
GridHighlight combatantCellAllyTurnEnded
 
GridHighlight combatantCellEnemyTurnEnded
 
bool useCombatantSelections = false
 
bool uiHidesCombatantSelections = false
 
GridHighlight combatantSelectionPlayer
 
GridHighlight combatantSelectionAlly
 
GridHighlight combatantSelectionEnemy
 
bool uiHidesPlacement = false
 
GridHighlight placementHighlight = new GridHighlight(BaseGridHighlightType.Area)
 
GridHighlight placementSelectionHighlight = new GridHighlight(BaseGridHighlightType.Selection)
 
GridHighlight noPlacementSelectionHighlight = new GridHighlight(BaseGridHighlightType.NoSelection)
 
bool uiHidesMoveCommand = false
 
bool moveRangeBlockedHighlightOccupied = true
 
GridHighlight moveRangeHighlight = new GridHighlight(BaseGridHighlightType.Area)
 
GridHighlight moveRangeBlockedHighlight = new GridHighlight()
 
GridHighlight moveRangePassableHighlight = new GridHighlight()
 
GridHighlight moveSelectionHighlight = new GridHighlight(BaseGridHighlightType.Selection)
 
GridHighlight noMoveSelectionHighlight = new GridHighlight(BaseGridHighlightType.NoSelection)
 
GridHighlight movePathHighlight = new GridHighlight()
 
bool uiHidesAvailableTarget = false
 
bool availableTargetActionSelection = false
 
bool availableTargetTargetSelection = false
 
GridHighlight availableTargetPlayerHighlight = new GridHighlight(BaseGridHighlightType.Selection)
 
GridHighlight availableTargetAllyHighlight = new GridHighlight(BaseGridHighlightType.Selection)
 
GridHighlight availableTargetEnemyHighlight = new GridHighlight(BaseGridHighlightType.Selection)
 
bool uiHidesTargetCell = false
 
GridHighlight targetCellSelectionHighlight = new GridHighlight(BaseGridHighlightType.Selection)
 
GridHighlight noTargetCellSelectionHighlight = new GridHighlight(BaseGridHighlightType.NoSelection)
 
bool uiHidesOrientation = false
 
GridHighlight orientationSelectionHighlight = new GridHighlight(BaseGridHighlightType.Selection)
 
bool uiHidesMarkedCell = false
 
GridHighlight markedCellHighlight = new GridHighlight(BaseGridHighlightType.Area)
 
bool uiHidesUseRange = false
 
bool useRangeActionSelection = false
 
bool useRangeTargetSelection = false
 
GridHighlight useRangeHighlight = new GridHighlight(BaseGridHighlightType.Area)
 
bool uiHidesAffectRange = false
 
bool affectRangeActionSelection = false
 
bool affectRangeTargetSelection = false
 
GridHighlight affectRangeHighlight = new GridHighlight(BaseGridHighlightType.Area)
 
bool uiHidesExamine = false
 
bool examineCombatantIsBlocked = false
 
GridHighlight examineHighlight = new GridHighlight(BaseGridHighlightType.Selection)
 
GridHighlight examineBlockedHighlight = new GridHighlight(BaseGridHighlightType.Selection)
 
bool uiHidesSelectingCombatant = false
 
bool selectingPriority = false
 
bool selectingCombatantActionSelection = false
 
bool selectingCombatantTargetSelection = false
 
GridHighlight selectingPlayerHighlight = new GridHighlight(BaseGridHighlightType.Selection)
 
GridHighlight selectingAllyHighlight = new GridHighlight(BaseGridHighlightType.Selection)
 
GridHighlight selectingEnemyHighlight = new GridHighlight(BaseGridHighlightType.Selection)
 
bool uiHidesGridFormation = false
 
GridHighlight gridFormationHighlight = new GridHighlight(BaseGridHighlightType.Area)
 
GridHighlight gridFormationPositionHighlight = new GridHighlight(BaseGridHighlightType.Selection)