ORK Framework  2.25.2
API Documentation
ORKFramework.HUDStatus Class Reference
Inheritance diagram for ORKFramework.HUDStatus:
ORKFramework.HUDElement ORKFramework.CoreHUDElement ORKFramework.BaseData ORKFramework.IBaseData

Public Member Functions

override void SetData (DataObject data)
 Sets the variables of the class using a ORKFramework.DataObject. More...
 
bool CheckRequirementsOrigin (Combatant combatant)
 
bool CheckRequirements (Combatant combatant)
 
bool HasTurnOrder ()
 
bool HasPreviewBlink ()
 
bool HasCheckTickUpdate ()
 
void IsVariableUpdate (ref bool isUpdateGlobalVariables, ref bool isUpdateObjectVariables)
 
override void CreateLabels (GUIBox box, out List< BaseLabel > label, Rect displayBounds, Combatant combatant)
 
void CreateLabels (GUIBox box, out List< BaseLabel > label, Rect displayBounds, Combatant combatant, bool isBestiary)
 
void CreateLabelsEditor (GUIBox box, out List< BaseLabel > label, Rect displayBounds, Combatant combatant, bool isBestiary)
 
override bool CheckClick (Combatant combatant, Vector2 position, float releasedAfter, ref bool clickConsumed)
 
- Public Member Functions inherited from ORKFramework.HUDElement
virtual void CreateLabelsEditor (GUIBox box, out List< BaseLabel > label, Rect displayBounds, Combatant combatant)
 
- 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 void CheckUpdate (ref bool isUpdateTurnOrder, ref bool isUpdatePreviewBlink, ref bool isCheckTickUpdate, ref bool isUpdateCombatantConsole, ref bool isUpdateResearch, ref bool isUpdateGlobalVariables, ref bool isUpdateObjectVariables, HUDStatus[] element)
 

Public Attributes

HUDStatusType type = HUDStatusType.Information
 
HUDStatusCombatantOrigin combatantOrigin = HUDStatusCombatantOrigin.User
 
int originTargetIndex = 0
 
StatusTextHUD information
 
FactionTextHUD faction
 
StatusValueHUD status
 
EffectTextHUD effect
 
AtkAttrHUD atkAttr
 
DefAttrHUD defAttr
 
DefIDHUD defID
 
TimebarHUD timebar
 
CastTimeHUD castTime
 
InventorySpaceHUD invSpace
 
PortraitHUD portrait
 
ShortcutHUD shortcut
 
EquipmentHUD equipment
 
DelayTimeHUD delayTime
 
ActionsPerTurnHUD actionsPerTurn
 
GridMoveRangeHUD gridMoveRange
 
ActionTimeHUD actionTime
 
CombatantConsoletHUD console
 
ChanceHUD hitChance
 
ChanceHUD criticalChance
 
ResearchItemHUD researchItem
 
AIBehaviourHUD aiBehaviour
 
AIRulesetHUD aiRuleset
 
bool useRequirements = false
 
bool checkGameStates = false
 
Consider hasStatusPreview = Consider.Ignore
 
Consider isPreviewBlink = Consider.Ignore
 
Consider isMenuUser = Consider.Ignore
 
Consider isShopUser = Consider.Ignore
 
SimpleCombatantRequirement requirement
 
GameState gameState
 
HUDCombatantClickAction [] clickAction = new HUDCombatantClickAction[0]
 
- Public Attributes inherited from ORKFramework.HUDElement
bool box = false
 
bool noFlash = false
 
bool outsideBounds = false
 
HUDElementBounds bounds = new HUDElementBounds()
 
bool showBackground = false
 
DisplayImage bg
 
bool expandBoundsBG = false
 

Member Function Documentation

◆ SetData()

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

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

Parameters
dataORKFramework.DataObject containing the data.

Reimplemented from ORKFramework.HUDElement.