ORK Framework  3.17.1
API Documentation
GamingIsLove.ORKFramework.UI Namespace Reference

Classes

class  AbilityBattleMenuItem
 
class  AbilityBMItem
 
class  AbilityHUDStatusTextType
 
class  AbilityTooltipCheck
 
class  AbilityTypeBMItem
 
class  AbilityTypeTooltipCheck
 
class  AbilityUseCountHUDCondition
 
class  AcceptSVDInputOption
 
class  ActionCostHUDStatusTextType
 
class  ActionInfo
 
class  ActionInfoNotifications
 
class  ActionInformationHUDStatusTextType
 
class  ActionsPerTurnHUDStatusTextType
 
class  ActionsPerTurnHUDValueBarType
 
class  ActionTimeHUDStatusTextType
 
class  ActionTimeHUDValueBarType
 
class  ActiveBattleMenu
 
class  AddBackButton
 
class  AddRemoveButton
 
class  AddUIKeyHUD
 
class  AddUnequipButton
 
class  AIBehaviourBattleMenuItem
 
class  AIBehaviourBMItem
 
class  AIBehaviourHUDStatusTextType
 
class  AIBehaviourMultiSlotItem
 
class  AIBehaviourSlotBMItem
 
class  AIBehaviourTooltipCheck
 
class  AIBehaviourTypeBMItem
 
class  AIRulesetBattleMenuItem
 
class  AIRulesetBMItem
 
class  AIRulesetHUDStatusTextType
 
class  AIRulesetMultiSlotItem
 
class  AIRulesetSlotBMItem
 
class  AIRulesetTooltipCheck
 
class  AIRulesetTypeBMItem
 
class  AITypeTooltipCheck
 
class  AreaTooltipCheck
 
class  AreaTypeTooltipCheck
 
class  AssignShortcutMenu
 
class  AssignShortcutMenuAction
 
class  AssignShortcutMenuItem
 
class  AttackBattleMenuItem
 
class  AttackModifierAttributeHUDStatusTextType
 
class  AttackModifierAttributePreviewChangeHUDCondition
 
class  AttackModifierHUDStatusTextType
 
class  AttackModifierTooltipCheck
 
class  AutoBattleMenuItem
 
class  AutoBMItem
 
class  AutoSaveSlotStartMenuOption
 
class  BackBMItem
 
class  BackCraftingListItem
 
class  BackManagerMenuItem
 
class  BackMenuAction
 
class  BaseBattleMenuItem
 
class  BaseButtonListItem
 
class  BaseCombatantInformationDisplay
 
class  BaseCombatantReactionPortrait
 
class  BaseCraftingListItem
 
class  BaseHUDStatusTextType
 
class  BaseLootDialogueSettings
 
class  BaseManagerMenuItem
 
class  BaseMenuAction
 
class  BaseMultiSlotItem
 
class  BaseORKHUDValueBarType
 
class  BaseSequenceLootDialogueType
 
class  BaseStartMenuOption
 
class  BaseSVDInputOption
 
class  BaseUIBattleActionsHUDSettings
 
class  BaseUICombatantHUDSettings
 
class  BaseUICombatantObjectHUDSettings
 
class  BaseUILatestTurnHUDSettings
 
class  BaseUIObjectHUDSettings
 
class  BaseUIQuestHUDSettings
 
class  BaseUIResearchItemSettings
 
class  BaseUIResearchTreeSettings
 
class  BaseUIShortcutSettings
 
class  BaseUIStatusEffectSettings
 
class  BaseUIStatusValueSettings
 
class  BaseUITimebarHUDSettings
 
class  BaseUITurnOrderHUDSettings
 
class  BattleActionsHUDInstance
 
class  BattleActionsHUDSetting
 
class  BattleGainsText
 
class  BattleMenuBattleMenuItem
 
class  BattleMenuBMItem
 
class  BattleMenuTargetMenuSettings
 
class  BMItem
 
class  BonusAttackModifierAttributeHUDStatusTextType
 
class  BonusDefenceModifierAttributeHUDStatusTextType
 
class  BonusDefenceModifierIDHUDStatusTextType
 
class  BonusStatusValueHUDStatusTextType
 
class  ButtonListMenuItem
 
class  CancelCraftingListItem
 
class  CancelMenuAction
 
class  CancelSVDInputOption
 
class  CastTimeHUDStatusTextType
 
class  CastTimeHUDValueBarType
 
class  ChanceHUDStatusTextType
 
class  ChanceHUDValueBarType
 
class  ChangeMemberBattleMenuItem
 
class  ChangeMemberBMItem
 
class  ChangeMenuUserHUDClickAction
 
class  ChangePlayerHUDClickAction
 
class  ChangeTypesManagerMenuItem
 
class  ChoiceMessage
 
class  ChoiceMessageWithUIKeyHUD
 
class  ClassAbilityBattleMenuItem
 
class  ClassHUDStatusTextType
 
class  ClassMultiSlotItem
 
class  ClassSingleBattleMenuItem
 
class  ClassSingleBMItem
 
class  ClassSlotBattleMenuItem
 
class  ClassSlotBMItem
 
class  ClassSlotClassBMItem
 
class  ClassSlotTooltipCheck
 
class  ClassTooltipCheck
 
class  ClearCraftingListItem
 
class  CloseCurrentMenuScreenHUDClickAction
 
class  CloseGameButtonListItem
 
class  CloseManagerMenuItem
 
class  CombatantBoxSettings
 
class  CombatantChoiceLayout
 
class  CombatantConsoleHUDStatusTextType
 
class  CombatantGainsText
 
class  CombatantHUDInstance
 
class  CombatantHUDLimitedDisplayTime
 
class  CombatantHUDSetting
 
class  CombatantInformationDisplay
 
class  CombatantInformationHUDStatusTextType
 
class  CombatantListInformationDisplay
 
class  CombatantNavigationBarPoint
 
class  CombatantObjectHUDInstance
 
class  CombatantObjectHUDSetting
 
class  CombatantPage
 
class  CombatantPrefabViewInstance
 
class  CombatantReactionPortrait
 
class  CombatantSelection
 
class  CombatantSelectionAsset
 
class  CombatantSelectionControl
 
class  CombatantSequenceLootDialogueType
 
class  CombatantStatusHUDCondition
 
class  CombatantTooltipCheck
 
class  CombatantTypeTooltipCheck
 
class  CommandBattleMenuItem
 
class  CommandBMItem
 
class  ConsoleHUDInstance
 
class  ConsoleHUDSetting
 
class  ConsoleTypeTooltipCheck
 
class  ContentWithUIKeyHUD
 
class  ContinueStartMenuOption
 
class  CraftingListMenuAction
 
class  CraftingListMenuItem
 
class  CraftingRecipeTooltipCheck
 
class  CraftingTypeTooltipCheck
 
class  CreateCraftingListItem
 
class  CurrencyTooltipCheck
 
class  CustomStartMenuOption
 
class  DefaultActionManagerMenuItem
 
class  DefenceModifierAttributeHUDStatusTextType
 
class  DefenceModifierAttributePreviewChangeHUDCondition
 
class  DefenceModifierHUDStatusTextType
 
class  DefenceModifierIDHUDStatusTextType
 
class  DefenceModifierTooltipCheck
 
class  DefendBattleMenuItem
 
class  DefendBMItem
 
class  DefendTooltipCheck
 
class  DelayTimeHUDStatusTextType
 
class  DelayTimeHUDValueBarType
 
class  DescriptionContent
 
class  DifficultyControl
 
class  DifficultyHUDCondition
 
class  DragSettings
 
class  DropMenuAction
 
class  DurabilityHUDCondition
 
class  DurabilityHUDValueBarType
 
class  EndBattleMenuItem
 
class  EndBMItem
 
class  EquipmentBattleMenuItem
 
class  EquipmentBMItem
 
class  EquipmentHUDStatusTextType
 
class  EquipmentMultiSlotItem
 
class  EquipmentSlotBMItem
 
class  EquipmentSlotTooltipCheck
 
class  EquipmentTooltipCheck
 
class  EscapeBattleMenuItem
 
class  EscapeBMItem
 
class  EscapeTooltipCheck
 
class  ExitGameButtonListItem
 
class  ExitStartMenuOption
 
class  FactionBenefitTooltipCheck
 
class  FactionTooltipCheck
 
class  GiveMenuAction
 
class  GlobalMachineGameButtonListItem
 
class  GlobalMachineManagerMenuItem
 
class  GlobalMachineStartMenuOption
 
class  GridExamineBattleMenuItem
 
class  GridExamineBMItem
 
class  GridExamineTooltipCheck
 
class  GridMoveBattleMenuItem
 
class  GridMoveBMItem
 
class  GridMoveRangeHUDStatusTextType
 
class  GridMoveRangeHUDValueBarType
 
class  GridMoveTooltipCheck
 
class  GridOrientationBattleMenuItem
 
class  GridOrientationBMItem
 
class  GridOrientationTooltipCheck
 
class  GroupMenuItem
 
class  HUDAbilityListSettings
 
class  HUDAbilitySettings
 
class  HUDActionTargetListSettings
 
class  HUDAIBehaviourListSettings
 
class  HUDAIBehaviourSlotInputSettings
 
class  HUDAIRulesetListSettings
 
class  HUDAIRulesetSlotInputSettings
 
class  HUDAttackModifierAttributeListSettings
 
class  HUDAttackModifierListSettings
 
class  HUDClassSlotInputSettings
 
class  HUDClassSlotListSettings
 
class  HUDCombatantActionListSettings
 
class  HUDCombatantActionSettings
 
class  HUDCombatantTargetSettings
 
class  HUDDefenceModifierAttributeListSettings
 
class  HUDDefenceModifierIDListSettings
 
class  HUDDefenceModifierListSettings
 
class  HUDEquipmentListSettings
 
class  HUDEquipmentSlotInputSettings
 
class  HUDInventoryListSettings
 
class  HUDQuestListSettings
 
class  HUDQuestRewardListSettings
 
class  HUDQuestRewardTextSettings
 
class  HUDQuestRewardWrapper
 
class  HUDQuestTaskListSettings
 
class  HUDQuestTaskRequirementListSettings
 
class  HUDQuestTaskRequirementTextSettings
 
class  HUDQuestTaskRequirementWrapper
 
class  HUDQuestTaskTextSettings
 
class  HUDQuestTextSettings
 
class  HUDResearchItemListSettings
 
class  HUDShortcutSlotInputSettings
 
class  HUDShortcutSlotListSettings
 
class  HUDStateChangeSettings
 
class  HUDStatusEffectListSettings
 
class  HUDStatusTextSettings
 
class  HUDStatusValueListSettings
 
interface  ICallCombatantSelection
 
interface  ICombatantSelectionOrigin
 
interface  IMergeableMenu
 
interface  IMoveableMenu
 
class  InformationDisplay
 
class  InformationPage
 
class  InformationStartMenuOption
 
class  InformationUpdateSettings
 
class  InventoryContainerSlotHUDStatusTextType
 
class  InventoryExchangeItemBox
 
class  InventorySpaceHUDStatusTextType
 
class  InventorySpaceHUDValueBarType
 
class  IsBestiaryCompleteHUDCondition
 
class  IsInBestiaryHUDCondition
 
interface  ISortableMenu
 
class  IsPlayerHUDCondition
 
class  ItemBattleMenuItem
 
class  ItemBMItem
 
class  ItemHUDStatusTextType
 
class  ItemsCraftingListItem
 
class  ItemTooltipCheck
 
class  ItemTypeBMItem
 
class  ItemTypeTooltipCheck
 
class  ItemUseCountHUDCondition
 
interface  ITimebarPositions
 
interface  IUIResearchTree
 Used by UI module implementations for displaying research tree UI. More...
 
interface  IUIResearchTreeSource
 Used by menu screens to communicate with an IUIResearchTree implementation. More...
 
interface  IUIShortcut
 
class  KeyUIResearchItemSettings
 
class  KeyUIShortcutSettings
 
class  KeyUIStatusEffectSettings
 
class  KeyUIStatusValueSettings
 
class  LanguageStartMenuOption
 
class  LatestTurnHUDInstance
 
class  LatestTurnHUDSetting
 
class  LayoutScreenCombatantNotificationSettings
 
class  LayoutScreenCustomLootNotificationSettings
 
class  LayoutScreenLootDialogueControl
 
class  LayoutScreenLootDialogueSettings
 
class  LayoutScreenLootDisplaySettings
 
class  LayoutScreenLootNotificationSettings
 
class  LevelPointsHUDStatusTextType
 
class  LevelPointsHUDValueBarType
 
class  LevelUpDialogueControl
 
class  LevelUpMenuAction
 
class  LevelUpSequenceLootDialogueType
 
class  LevelUpText
 
class  LoadButtonListItem
 
class  LoadGameStartMenuOption
 
class  LogTooltipCheck
 
class  LogTypeTooltipCheck
 
class  LootDialogueOutcomeNotificationSettings
 
class  LootDialogueSettings
 
class  LootSequenceLootDialogueType
 
class  ManagerMenuItem
 
class  MenuActionSetting
 
class  MenuListMenuItem
 
class  MenuPortraitContent
 
class  MenuPortraitSelection
 
class  MenuPortraitTypeSelection
 
class  MenuScreen
 
class  MenuScreenAsset
 
class  MenuScreenBattleMenuItem
 
class  MenuScreenBMItem
 
class  MenuScreenButtonListItem
 
class  MenuScreenHUDClickAction
 
class  MenuTargetSelection
 
class  MenuTypeSettings
 
class  MenuUserHUDCondition
 
class  MergeMenuAction
 
class  MoveMenuAction
 
class  MultiContentMenuSettings
 
class  MultiSlotMenuItem
 
class  MultiSlotMenuTypeSettings
 
class  NewGameStartMenuOption
 
class  NoneMenuAction
 
class  NoneTooltipCheck
 
class  ObjectHUDInstance
 
class  ObjectHUDSelection
 
class  ObjectHUDSetting
 
class  OpenURLStartMenuOption
 
class  OptionsStartMenuOption
 
class  ORK_HUDTextSettings
 
class  ORK_HUDValueBarSettings
 
class  ORKBaseUISystemExtension
 
class  ORKContentLayout
 
class  ORKSlotContentLayout
 
class  ORKUnityUISystemExtension
 
class  PageKeys
 
class  PassiveAbilityHUDCondition
 
class  PassiveAbilityStateHUDCondition
 
class  PlayerEnemyHUDCondition
 
class  PrefabViewBackgroundSettings
 
class  PrefabViewCameraSettings
 
class  PrefabViewCombatant
 
class  PrefabViewInstance
 
class  PrefabViewPrefabSettings
 
class  PrefabViewSettings
 
class  PriceText
 
class  PriceTextSettings
 
class  QuantityCall
 
class  QuantityData
 
class  QuantityDefault
 
class  QuantitySelection
 
class  QuantitySelectionAsset
 
class  QuantitySelectionControl
 
class  QuantityText
 
class  QuantityTextSettings
 
class  QuestHUDCondition
 
class  QuestHUDInstance
 
class  QuestHUDSetting
 
class  QuestListSettings
 
class  QuestRewardHUDCondition
 
class  QuestTaskHUDCondition
 
class  QuestTaskRequirementHUDCondition
 
class  QuestTaskRequirementHUDValueBarType
 
class  QuestTaskTooltipCheck
 
class  QuestTooltipCheck
 
class  QuestTypeHUDCondition
 
class  QuestTypeTooltipCheck
 
class  RandomBattleInputOption
 
class  RememberSelectionsInputOption
 
class  RemoveMenuAction
 
class  ResearchCountHUDValueBarType
 
class  ResearchItemHUDStatusTextType
 
class  ResearchItemStateHUDCondition
 
class  ResearchItemTooltipCheck
 
class  ResearchProgressHUDValueBarType
 
class  ResearchTreeTooltipCheck
 
class  ResearchTypeTooltipCheck
 
class  ResearchUIHelper
 
class  ReuseHUDCondition
 
class  ReuseTimeHUDStatusTextType
 
class  ReuseTimeHUDValueBarType
 
class  SaveButtonListItem
 
class  SchematicBattleMenuItem
 
class  SchematicBMItem
 
class  SchematicGameButtonListItem
 
class  SchematicManagerMenuItem
 
class  SchematicMenuAction
 
class  SchematicStartMenuOption
 
class  SelectedDataBattleMenuItem
 
class  SelectTargetHUDClickAction
 
class  SellMenuAction
 
class  SequenceLootDialogueControl
 
class  SequenceLootDialogueDisplay
 
class  SequenceLootDialogueSettings
 
class  SequenceLootDialogueType
 
class  ShopAbility
 
class  ShopAIBehaviour
 
class  ShopAIRuleset
 
class  ShopAsset
 
class  ShopBaseItem
 
class  ShopBuyCombatantInfo
 
class  ShopBuySellPart
 
class  ShopClass
 
class  ShopCombatant
 
class  ShopContentHUDCondition
 
class  ShopCraftingRecipe
 
class  ShopDescriptionPart
 
class  ShopEquipment
 
class  ShopItem
 
class  ShopLayout
 
class  ShopLayoutAsset
 
class  ShopListPart
 
class  ShopModeButton
 
class  ShopNamePart
 
class  ShopPurchaseSelection
 
class  ShopQuest
 
class  ShopScreen
 
class  ShopSetting
 
class  ShopTypePart
 
class  ShopUserHUDCondition
 
class  ShortcutHUDStatusTextType
 
class  ShortcutLootDisplaySettings
 
class  ShortcutMultiSlotItem
 
class  ShortcutSlotBattleMenuItem
 
class  ShortcutSlotHUDStatusTextType
 
class  ShortcutSlotManagerMenuItem
 
class  ShortcutTypeHUDCondition
 
class  SimpleLootDialogueControl
 
class  SimpleLootDialogueSettings
 
class  SortMenuAction
 
class  SplitMenuAction
 
class  StartMenuOption
 
class  StatusBonusHUDCondition
 
class  StatusEffectCombatantReactionPortrait
 
class  StatusEffectDurationHUDValueBarType
 
class  StatusEffectHUDStatusTextType
 
class  StatusEffectTooltipCheck
 
class  StatusPreviewBlinkHUDCondition
 
class  StatusPreviewHUDCondition
 
class  StatusValueChangeCombatantReactionPortrait
 
class  StatusValueChangedStateHUDCondition
 
class  StatusValueDistributionInputOption
 
class  StatusValueHUDStatusTextType
 
class  StatusValueHUDValueBarType
 
class  StatusValuePreviewChangeHUDCondition
 
class  StatusValueSVDInputOption
 
class  StatusValueTooltipCheck
 
class  StatusValueUpgradeTooltipCheck
 
class  SubMenu
 
class  SubMenuItem
 
class  SwitchMenuUserBattleMenuItem
 
class  SwitchMenuUserBMItem
 
class  TargetBMItem
 
class  TargetInformationLayout
 
class  TeleportControl
 
class  TextImageContentWithUIKeyHUD
 
class  TimebarCombatantSettings
 
class  TimebarHUDInstance
 
class  TimebarHUDSetting
 
class  TimebarHUDStatusTextType
 
class  TimebarHUDValueBarType
 
class  ToggleQuestsTasksVisibleHUDClickAction
 
class  ToggleQuestTaskMarkerHUDClickAction
 
class  ToggleQuestVisibleHUDClickAction
 
class  ToItemBoxMenuAction
 
class  TurnOrderHUDInstance
 
class  TurnOrderHUDSetting
 
class  UIResearchItemSettings
 
class  UIResearchMultiButtonSettings
 
class  UIResearchSingleButtonSettings
 
class  UIResearchTreeCreator
 
class  UIResearchTreeSettings
 
class  UIShortcutSettings
 
class  UIStatusEffectSettings
 
class  UIStatusValueInputContent
 
class  UIStatusValueSettings
 
class  UnequipMenuAction
 
class  UnityUIBattleActionsHUDSettings
 
class  UnityUICombatantHUDSettings
 
class  UnityUICombatantObjectHUDSettings
 
class  UnityUILatestTurnHUDSettings
 
class  UnityUIObjectHUDSettings
 
class  UnityUIQuestHUDSettings
 
class  UnityUIResearchItemSettings
 
class  UnityUIResearchTreeSettings
 
class  UnityUIShortcutSettings
 
class  UnityUIStatusEffectSettings
 
class  UnityUIStatusValueSettings
 
class  UnityUITimebarHUDSettings
 
class  UnityUITurnOrderHUDSettings
 
class  UseCountHUDStatusTextType
 
class  UseMenuAction
 
class  UseShortcutHUDClickAction
 

Enumerations

enum  ORKContentLayoutType {
  Text, Icon, TextAndIcon, Custom,
  Info, LevelUpCost, None
}
 
enum  ORKIconContentType { Icon, TypeIcon, IconFallback, TypeIconFallback }
 
enum  ORKSlotContentLayoutType {
  Text, Icon, TextAndIcon, SlotText,
  SlotIcon, SlotTextAndIcon, Custom, Info,
  LevelUpCost, None
}
 
enum  AddUIKeyHUDType { None, UIKeySetup, HUD }
 
enum  ShopPurchaseMode { Buy, BuyAndUse }
 
enum  QuestTaskRequirementType { FinishedTask, Item, EnemyKill, Count }
 
enum  SequenceLootDialogueDisplayType { One, Defined, All }
 
enum  BattleGainsTextType { Gains, Combatant, LevelUp }
 
enum  HUDAbilityType { Attack, CounterAttack, Ability, ClassAbility }
 
enum  HUDCombatantActionListType { User, Target }
 
enum  HUDCombatantActionType { Current, Casting, Next }
 
enum  HUDCombatantTargetType {
  GroupTarget, IndividualTarget, LastTarget, AttackedBy,
  Selected
}
 
enum  HUDStatusEffectCountLimit { All, One, Defined }
 
enum  HUDStatusEffectBonusDisplay { All, Add, Remove }
 
enum  StatusValueListType { StatusValueType, StatusType, Defined, All }
 
enum  AIBehaviourSlotHUDClickUseType { None, Unequip, Drag }
 
enum  AIBehaviourHUDSlotState { None, Empty, Equipped, Blocked }
 
enum  AIRulesetSlotHUDClickUseType { None, Unequip, Drag }
 
enum  AIRulesetHUDSlotState { None, Empty, Equipped, Blocked }
 
enum  ClassSlotHUDClickUseType { None, Unequip, Drag }
 
enum  ClassHUDSlotState { None, Empty, Equipped, Unavailable }
 
enum  EquipmentSlotHUDClickUseType { None, Unequip, Drag }
 
enum  EquipmentHUDSlotState { None, Empty, Equipped, Unavailable }
 
enum  ShortcutHUDInnerAssignType { None, Keep, Remove, Swap }
 
enum  ShortcutHUDClickUseType { None, Use, Assign, Drag }
 
enum  ShortcutHUDSlotState {
  None, Empty, Active, Useable,
  Inactive
}
 
enum  ShortcutHUDListType { Range, Defined }
 
enum  ValueBarUnusedFillType { Auto, Empty, Full }
 
enum  GroupMenuAction {
  Change, Remove, Screen, Back,
  Cancel, Schematic, Sort, Transfer,
  ChangeReserve, RemoveReserve
}
 
enum  InventoryExchangeSourceType { User, Object, ItemBox }
 
enum  MenuScreenCloseSchematicStart { BeforeFading, WhileFading, AfterFading }
 
enum  MenuTargetRange { User, Group, All }
 

Functions

delegate bool AddQuantity (IShortcut shortcut, bool showNotification, bool showConsole, bool markNewContent)
 
delegate void RemoveQuantity (IShortcut shortcut, int quantity, bool showNotification, bool showConsole)
 
delegate void QuantityCallback (IShortcut shortcut, int quantity, QuantitySelectionMode mode)