ORK Framework  2.27.0
API Documentation
ORKFramework.BattleGridSettings Class Reference
Inheritance diagram for ORKFramework.BattleGridSettings:
ORKFramework.BaseData ORKFramework.IBaseData

Public Member Functions

void InitSelection (GridSelectionType type, Combatant combatant)
void CloseAlwaysActiveExamineTarget ()
void ClearCellSelection ()
void CloseSelections (Combatant combatant)
void RotateToSelectedCell (bool gridRotation)
void Tick ()
void TargetCellSelectionCursor (BattleGridCellComponent cell)
void EndBattle ()
Vector3 GetCorner (Vector3 center, int direction, float distanceToCenter)
- 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

BattleGridType type = BattleGridType.Square
bool squareDiagonalDistanceOne = false
HexagonalGridType hexagonalType = HexagonalGridType.HorizontalEven
float cellSize = 1
Vector2 cellOffset = Vector2.zero
LayerMask rayLayerMask = -1
float rayDistance = 100.0f
GridCellSelectionSettings cellSelection = new GridCellSelectionSettings()
GridOrientationSelectionSettings orientationSelection = new GridOrientationSelectionSettings()
GridCombatantPlacementSettings combatantPlacement = new GridCombatantPlacementSettings()
GridMoveCommandSettings moveCommand = new GridMoveCommandSettings()
GridTargetCellSelectionSettings targetCellSelection = new GridTargetCellSelectionSettings()
GridExamineSettings examine = new GridExamineSettings()


GridSelectionType SelectionType [get, set]
Combatant SelectingCombatant [get, set]
BattleGridCellComponent SelectedCell [get, set]
bool IsSquare [get]
bool IsHorizontalHex [get]
bool IsVerticalHex [get]
Vector2 CellSize [get]
float CellRadius [get]
Vector2 CellDistance [get]
Vector2 CellOffset [get]