Holds all ORK project and in-game data. Use it to access everything ORK related data and procedures. More...

Public Member Functions
void	Clear ()
	Clears ORK Framework. More...

Static Public Member Functions
static void	Initialize ()
	Initializes ORK Framework. More...

Static Public Attributes
static string	VERSION = "3.17.1"
	ORK Version number. More...

Properties
static ORK	Instance `[get]`
	Get the instance of ORK Framework. Make sure to initialize ORK with a ORK project asset first! More...

static bool	Instantiated `[get]`
	Gets a value indicating whether ORK Framework is instantiated. More...

static bool	Initialized `[get]`
	Gets a value indicating whether ORK Framework is initialized. More...

static AccessHandler	Access `[get]`
	Returns the access handler. More...

static ORKGameHandler	Game `[get]`
	Gets the game handler. Keeps track of overall game data in-game. More...

static Battle	Battle `[get]`
	Gets the battle handler. Manages running battles. More...

static ORKControlHandler	Control `[get, set]`
	Gets the control handler. Handles the game control in-game. More...

static MenuHandler	Menu `[get]`
	Gets the menu handler. Manages menu screens and shops in-game. More...

static ISaveGameHandler	SaveGame `[get, set]`
	Gets the save game handler. Used to save and load the game. More...

static ControlMapsSettings	ControlMaps `[get]`
	Gets the control maps. More...

static AnimationTypesSettings	AnimationTypes `[get]`
	Gets the animation types. More...

static ConsoleTypesSettings	ConsoleTypes `[get]`
	Gets the console types. More...

static DifficultiesSettings	Difficulties `[get]`
	Gets the difficulties. More...

static GameStatistic	Statistic `[get]`
	Gets the statistics. More...

static ORKGameSettings	GameSettings `[get]`
	Gets the game settings. More...

static ConsoleSettings	ConsoleSettings `[get]`
	Gets the console settings. More...

static ORKGameControlsSettings	GameControls `[get]`
	Gets the game controls. More...

static AreaSettings	AreaSettings `[get]`
	Gets the area settings. More...

static AreaTypesSettings	AreaTypes `[get]`
	Gets the area types. More...

static AreasSettings	Areas `[get]`
	Gets the areas. More...

static TeleportsSettings	Teleports `[get]`
	Gets the teleports. More...

static AttackModifiersSettings	AttackModifiers `[get]`
	Gets the attack modifiers. More...

static DefenceModifiersSettings	DefenceModifiers `[get]`
	Gets the defence modifiers. More...

static StatusTypesSettings	StatusTypes `[get]`
	Gets the status types. More...

static StatusValuesSettings	StatusValues `[get]`
	Gets the status values. More...

static StatusEffectsSettings	StatusEffects `[get]`
	Gets the status effects. More...

static AbilityTypesSettings	AbilityTypes `[get]`
	Gets the ability types. More...

static AbilitiesSettings	Abilities `[get]`
	Gets the abilities. More...

static InventorySettings	InventorySettings `[get]`
	Gets the inventory settings. More...

static InventoryContainersSettings	InventoryContainers `[get]`
	Gets the inventory containers. More...

static ItemTypesSettings	ItemTypes `[get]`
	Gets the item types. More...

static CurrenciesSettings	Currencies `[get]`
	Gets the currencies. More...

static ItemsSettings	Items `[get]`
	Gets the items. More...

static EquipmentSlotsSettings	EquipmentSlots `[get]`
	Gets the equipment slots. More...

static EquipmentSettings	Equipment `[get]`
	Gets the equipment. More...

static CraftingSettings	CraftingSettings `[get]`
	Gets the crafting settings. More...

static CraftingTypesSettings	CraftingTypes `[get]`
	Gets the crafting types. More...

static CraftingRecipesSettings	CraftingRecipes `[get]`
	Gets the crafting recipes. More...

static FactionsSettings	Factions `[get]`
	Gets the factions. More...

static ClassSlotsSettings	ClassSlots `[get]`
	Gets the class slots. More...

static ClassesSettings	Classes `[get]`
	Gets the classes. More...

static ActionCombosSettings	ActionCombos `[get]`
	Gets the action combos. More...

static AITypesSettings	AITypes `[get]`
	Gets the AI types. More...

static AIBehavioursSettings	AIBehaviours `[get]`
	Gets the AI behaviours. More...

static AIRulesetsSettings	AIRulesets `[get]`
	Gets the AI rulesets. More...

static FormationsSettings	Formations `[get]`
	Gets the formations. More...

static CombatantTypesSettings	CombatantTypes `[get]`
	Gets the combatant types. More...

static CombatantsSettings	Combatants `[get]`
	Gets the combatants. More...

static ResearchTypesSettings	ResearchTypes `[get]`
	Gets the research types. More...

static ResearchTreesSettings	ResearchTrees `[get]`
	Gets the research trees. More...

static BattleTargetSettings	TargetSettings `[get]`
	Gets the battle target settings. More...

static BattleCameraSettings	BattleCamera `[get]`
	Gets the battle camera settings. More...

static BattleSettings	BattleSettings `[get]`
	Gets the battle settings. More...

static BattleGridSettings	BattleGridSettings `[get]`
	Gets the battle grid settings. More...

static BattleGridHighlightSettings	BattleGridHighlights `[get]`
	Gets the battle grid highlight settings. More...

static BattleSpotsSettings	BattleSpots `[get]`
	Gets the battle spots. More...

static BattleTextsSettings	BattleTexts `[get]`
	Gets the battle texts. More...

static BattleEndSettings	BattleEnd `[get]`
	Gets the battle end settings. More...

static StartMenuSettings	StartMenu `[get]`
	Gets the start menu settings. More...

static ORKSaveGameSettings	SaveGameSettings `[get]`
	Gets the save game menu settings. More...

static LogSettings	LogSettings `[get]`
	Gets the log settings. More...

static LogTypesSettings	LogTypes `[get]`
	Gets the log types. More...

static LogsSettings	Logs `[get]`
	Gets the logs. More...

static LogTextsSettings	LogTexts `[get]`
	Gets the log texts. More...

static QuestSettings	QuestSettings `[get]`
	Gets the quest settings. More...

static QuestTypesSettings	QuestTypes `[get]`
	Gets the quest types. More...

static QuestsSettings	Quests `[get]`
	Gets the quests. More...

static QuestTasksSettings	QuestTasks `[get]`
	Gets the quest tasks. More...

static TextDisplaySettings	TextDisplaySettings `[get]`
	Gets the text display settings. More...

static CursorSettings	CursorSettings `[get]`
	Gets the cursor settings. More...

static ORKUISettings	UISettings `[get]`
	Gets the UI settings. More...

static NotificationSettings	NotificationSettings `[get]`
	Gets the notification settings. More...

static CombatantSelectionsSettings	CombatantSelections `[get]`
	Gets the combatant selection settings. More...

static QuantitySelectionsSettings	QuantitySelections `[get]`
	Gets the quantity selection settings. More...

static ShortcutSettings	ShortcutSettings `[get]`
	Gets the shortcut settings. More...

static MenuScreensSettings	MenuScreens `[get]`
	Gets the menu screens. More...

static ShopLayoutsSettings	ShopLayouts `[get]`
	Gets the shop layout settings. More...

Detailed Description

Holds all ORK project and in-game data. Use it to access everything ORK related data and procedures.

Member Function Documentation

◆ Clear()

void GamingIsLove.ORKFramework.ORK.Clear ( )

Clears ORK Framework.

Parameters

control	If true, the controls and control blocks will also be cleared.
initVariables	If true, the global variables will also be cleared and initialized with the default variables.

◆ Initialize()

static void GamingIsLove.ORKFramework.ORK.Initialize ( )

static

Initializes ORK Framework.

Member Data Documentation

◆ VERSION

string GamingIsLove.ORKFramework.ORK.VERSION = "3.17.1"

static

ORK Version number.

Property Documentation

◆ Abilities

AbilitiesSettings GamingIsLove.ORKFramework.ORK.Abilities

staticget

Gets the abilities.

The abilities.

◆ AbilityTypes

AbilityTypesSettings GamingIsLove.ORKFramework.ORK.AbilityTypes

staticget

Gets the ability types.

The ability types.

◆ Access

AccessHandler GamingIsLove.ORKFramework.ORK.Access

staticget

Returns the access handler.

◆ ActionCombos

ActionCombosSettings GamingIsLove.ORKFramework.ORK.ActionCombos

staticget

Gets the action combos.

The action combos.

◆ AIBehaviours

AIBehavioursSettings GamingIsLove.ORKFramework.ORK.AIBehaviours

staticget

Gets the AI behaviours.

The AI behaviours.

◆ AIRulesets

AIRulesetsSettings GamingIsLove.ORKFramework.ORK.AIRulesets

staticget

Gets the AI rulesets.

The AI rulesets.

◆ AITypes

AITypesSettings GamingIsLove.ORKFramework.ORK.AITypes

staticget

Gets the AI types.

The AI types.

◆ AnimationTypes

AnimationTypesSettings GamingIsLove.ORKFramework.ORK.AnimationTypes

staticget

Gets the animation types.

The animation types.

◆ Areas

AreasSettings GamingIsLove.ORKFramework.ORK.Areas

staticget

Gets the areas.

The areas.

◆ AreaSettings

AreaSettings GamingIsLove.ORKFramework.ORK.AreaSettings

staticget

Gets the area settings.

The area settings.

◆ AreaTypes

AreaTypesSettings GamingIsLove.ORKFramework.ORK.AreaTypes

staticget

Gets the area types.

The area types.

◆ AttackModifiers

AttackModifiersSettings GamingIsLove.ORKFramework.ORK.AttackModifiers

staticget

Gets the attack modifiers.

The attack modifiers.

◆ Battle

Battle GamingIsLove.ORKFramework.ORK.Battle

staticget

Gets the battle handler. Manages running battles.

The battle handler.

◆ BattleCamera

BattleCameraSettings GamingIsLove.ORKFramework.ORK.BattleCamera

staticget

Gets the battle camera settings.

The battle camera settings.

◆ BattleEnd

BattleEndSettings GamingIsLove.ORKFramework.ORK.BattleEnd

staticget

Gets the battle end settings.

The battle end settings.

◆ BattleGridHighlights

BattleGridHighlightSettings GamingIsLove.ORKFramework.ORK.BattleGridHighlights

staticget

Gets the battle grid highlight settings.

The battle grid highlight settings.

◆ BattleGridSettings

BattleGridSettings GamingIsLove.ORKFramework.ORK.BattleGridSettings

staticget

Gets the battle grid settings.

The battle grid settings.

◆ BattleSettings

BattleSettings GamingIsLove.ORKFramework.ORK.BattleSettings

staticget

Gets the battle settings.

The battle settings.

◆ BattleSpots

BattleSpotsSettings GamingIsLove.ORKFramework.ORK.BattleSpots

staticget

Gets the battle spots.

The battle spots.

◆ BattleTexts

BattleTextsSettings GamingIsLove.ORKFramework.ORK.BattleTexts

staticget

Gets the battle texts.

The battle texts.

◆ Classes

ClassesSettings GamingIsLove.ORKFramework.ORK.Classes

staticget

Gets the classes.

The classes.

◆ ClassSlots

ClassSlotsSettings GamingIsLove.ORKFramework.ORK.ClassSlots

staticget

Gets the class slots.

The class slots.

◆ Combatants

CombatantsSettings GamingIsLove.ORKFramework.ORK.Combatants

staticget

Gets the combatants.

The combatants.

◆ CombatantSelections

CombatantSelectionsSettings GamingIsLove.ORKFramework.ORK.CombatantSelections

staticget

Gets the combatant selection settings.

The combatant selection settings.

◆ CombatantTypes

CombatantTypesSettings GamingIsLove.ORKFramework.ORK.CombatantTypes

staticget

Gets the combatant types.

The combatant types.

◆ ConsoleSettings

ConsoleSettings GamingIsLove.ORKFramework.ORK.ConsoleSettings

staticget

Gets the console settings.

The console settings.

◆ ConsoleTypes

ConsoleTypesSettings GamingIsLove.ORKFramework.ORK.ConsoleTypes

staticget

Gets the console types.

The console types.

◆ Control

ORKControlHandler GamingIsLove.ORKFramework.ORK.Control

staticgetset

Gets the control handler. Handles the game control in-game.

The control handler.

◆ ControlMaps

ControlMapsSettings GamingIsLove.ORKFramework.ORK.ControlMaps

staticget

Gets the control maps.

The control maps.

◆ CraftingRecipes

CraftingRecipesSettings GamingIsLove.ORKFramework.ORK.CraftingRecipes

staticget

Gets the crafting recipes.

The crafting recipes.

◆ CraftingSettings

CraftingSettings GamingIsLove.ORKFramework.ORK.CraftingSettings

staticget

Gets the crafting settings.

The crafting settings.

◆ CraftingTypes

CraftingTypesSettings GamingIsLove.ORKFramework.ORK.CraftingTypes

staticget

Gets the crafting types.

The crafting types.

◆ Currencies

CurrenciesSettings GamingIsLove.ORKFramework.ORK.Currencies

staticget

Gets the currencies.

The currencies.

◆ CursorSettings

CursorSettings GamingIsLove.ORKFramework.ORK.CursorSettings

staticget

Gets the cursor settings.

The cursor settings.

◆ DefenceModifiers

DefenceModifiersSettings GamingIsLove.ORKFramework.ORK.DefenceModifiers

staticget

Gets the defence modifiers.

The defence modifiers.

◆ Difficulties

DifficultiesSettings GamingIsLove.ORKFramework.ORK.Difficulties

staticget

Gets the difficulties.

The difficulties.

◆ Equipment

EquipmentSettings GamingIsLove.ORKFramework.ORK.Equipment

staticget

Gets the equipment.

The equipment.

◆ EquipmentSlots

EquipmentSlotsSettings GamingIsLove.ORKFramework.ORK.EquipmentSlots

staticget

Gets the equipment slots.

The equipment slots.

◆ Factions

FactionsSettings GamingIsLove.ORKFramework.ORK.Factions

staticget

Gets the factions.

The factions.

◆ Formations

FormationsSettings GamingIsLove.ORKFramework.ORK.Formations

staticget

Gets the formations.

The formations.

◆ Game

ORKGameHandler GamingIsLove.ORKFramework.ORK.Game

staticget

Gets the game handler. Keeps track of overall game data in-game.

The game handler.

◆ GameControls

ORKGameControlsSettings GamingIsLove.ORKFramework.ORK.GameControls

staticget

Gets the game controls.

The game controls.

◆ GameSettings

ORKGameSettings GamingIsLove.ORKFramework.ORK.GameSettings

staticget

Gets the game settings.

The game settings.

◆ Initialized

bool GamingIsLove.ORKFramework.ORK.Initialized

staticget

Gets a value indicating whether ORK Framework is initialized.

true if initialized; otherwise, false.

◆ Instance

ORK GamingIsLove.ORKFramework.ORK.Instance

staticget

Get the instance of ORK Framework. Make sure to initialize ORK with a ORK project asset first!

◆ Instantiated

bool GamingIsLove.ORKFramework.ORK.Instantiated

staticget

Gets a value indicating whether ORK Framework is instantiated.

true if instantiated; otherwise, false.

◆ InventoryContainers

InventoryContainersSettings GamingIsLove.ORKFramework.ORK.InventoryContainers

staticget

Gets the inventory containers.

The inventory containers.

◆ InventorySettings

InventorySettings GamingIsLove.ORKFramework.ORK.InventorySettings

staticget

Gets the inventory settings.

The inventory settings.

◆ Items

ItemsSettings GamingIsLove.ORKFramework.ORK.Items

staticget

Gets the items.

The items.

◆ ItemTypes

ItemTypesSettings GamingIsLove.ORKFramework.ORK.ItemTypes

staticget

Gets the item types.

The item types.

◆ Logs

LogsSettings GamingIsLove.ORKFramework.ORK.Logs

staticget

Gets the logs.

The logs.

◆ LogSettings

LogSettings GamingIsLove.ORKFramework.ORK.LogSettings

staticget

Gets the log settings.

The log settings.

◆ LogTexts

LogTextsSettings GamingIsLove.ORKFramework.ORK.LogTexts

staticget

Gets the log texts.

The log texts.

◆ LogTypes

LogTypesSettings GamingIsLove.ORKFramework.ORK.LogTypes

staticget

Gets the log types.

The log types.

◆ Menu

MenuHandler GamingIsLove.ORKFramework.ORK.Menu

staticget

Gets the menu handler. Manages menu screens and shops in-game.

The menu handler.

◆ MenuScreens

MenuScreensSettings GamingIsLove.ORKFramework.ORK.MenuScreens

staticget

Gets the menu screens.

The menu screens.

◆ NotificationSettings

NotificationSettings GamingIsLove.ORKFramework.ORK.NotificationSettings

staticget

Gets the notification settings.

The notification settings.

◆ QuantitySelections

QuantitySelectionsSettings GamingIsLove.ORKFramework.ORK.QuantitySelections

staticget

Gets the quantity selection settings.

The quantity selection settings.

◆ Quests

QuestsSettings GamingIsLove.ORKFramework.ORK.Quests

staticget

Gets the quests.

The quests.

◆ QuestSettings

QuestSettings GamingIsLove.ORKFramework.ORK.QuestSettings

staticget

Gets the quest settings.

The quest settings.

◆ QuestTasks

QuestTasksSettings GamingIsLove.ORKFramework.ORK.QuestTasks

staticget

Gets the quest tasks.

The quest tasks.

◆ QuestTypes

QuestTypesSettings GamingIsLove.ORKFramework.ORK.QuestTypes

staticget

Gets the quest types.

The quest types.

◆ ResearchTrees

ResearchTreesSettings GamingIsLove.ORKFramework.ORK.ResearchTrees

staticget

Gets the research trees.

The research trees.

◆ ResearchTypes

ResearchTypesSettings GamingIsLove.ORKFramework.ORK.ResearchTypes

staticget

Gets the research types.

The research types.

◆ SaveGame

ISaveGameHandler GamingIsLove.ORKFramework.ORK.SaveGame

staticgetset

Gets the save game handler. Used to save and load the game.

The save game handler.

◆ SaveGameSettings

ORKSaveGameSettings GamingIsLove.ORKFramework.ORK.SaveGameSettings

staticget

Gets the save game menu settings.

The save game menu settings.

◆ ShopLayouts

ShopLayoutsSettings GamingIsLove.ORKFramework.ORK.ShopLayouts

staticget

Gets the shop layout settings.

The shop layout settings.

◆ ShortcutSettings

ShortcutSettings GamingIsLove.ORKFramework.ORK.ShortcutSettings

staticget

Gets the shortcut settings.

The shortcut settings.

◆ StartMenu

StartMenuSettings GamingIsLove.ORKFramework.ORK.StartMenu

staticget

Gets the start menu settings.

The start menu settings.

◆ Statistic

GameStatistic GamingIsLove.ORKFramework.ORK.Statistic

staticget

Gets the statistics.

The statistics.

◆ StatusEffects

StatusEffectsSettings GamingIsLove.ORKFramework.ORK.StatusEffects

staticget

Gets the status effects.

The status effects.

◆ StatusTypes

StatusTypesSettings GamingIsLove.ORKFramework.ORK.StatusTypes

staticget

Gets the status types.

The status types.

◆ StatusValues

StatusValuesSettings GamingIsLove.ORKFramework.ORK.StatusValues

staticget

Gets the status values.

The status values.

◆ TargetSettings

BattleTargetSettings GamingIsLove.ORKFramework.ORK.TargetSettings

staticget

Gets the battle target settings.

The battle target settings.

◆ Teleports

TeleportsSettings GamingIsLove.ORKFramework.ORK.Teleports

staticget

Gets the teleports.

The teleports.

◆ TextDisplaySettings

TextDisplaySettings GamingIsLove.ORKFramework.ORK.TextDisplaySettings

staticget

Gets the text display settings.

The text display settings.

◆ UISettings

ORKUISettings GamingIsLove.ORKFramework.ORK.UISettings

staticget

Gets the UI settings.

The UI settings.

Public Member Functions

Static Public Member Functions

Static Public Attributes

Properties

Detailed Description

Member Function Documentation

◆ Clear()

◆ Initialize()

Member Data Documentation

◆ VERSION

Property Documentation

◆ Abilities

◆ AbilityTypes

◆ Access

◆ ActionCombos

◆ AIBehaviours

◆ AIRulesets

◆ AITypes

◆ AnimationTypes

◆ Areas

◆ AreaSettings

◆ AreaTypes

◆ AttackModifiers

◆ Battle

◆ BattleCamera

◆ BattleEnd

◆ BattleGridHighlights

◆ BattleGridSettings

◆ BattleSettings

◆ BattleSpots

◆ BattleTexts

◆ Classes

◆ ClassSlots

◆ Combatants

◆ CombatantSelections

◆ CombatantTypes

◆ ConsoleSettings

◆ ConsoleTypes

◆ Control

◆ ControlMaps

◆ CraftingRecipes

◆ CraftingSettings

◆ CraftingTypes

◆ Currencies

◆ CursorSettings

◆ DefenceModifiers

◆ Difficulties

◆ Equipment

◆ EquipmentSlots

◆ Factions

◆ Formations

◆ Game

◆ GameControls

◆ GameSettings

◆ Initialized

◆ Instance

◆ Instantiated

◆ InventoryContainers

◆ InventorySettings

◆ Items

◆ ItemTypes

◆ Logs

◆ LogSettings

◆ LogTexts

◆ LogTypes

◆ Menu

◆ MenuScreens

◆ NotificationSettings

◆ QuantitySelections

◆ Quests

◆ QuestSettings

◆ QuestTasks

◆ QuestTypes

◆ ResearchTrees

◆ ResearchTypes

◆ SaveGame

◆ SaveGameSettings

◆ ShopLayouts

◆ ShortcutSettings

◆ StartMenu