![]() |
ORK Framework
2.22.0
API Documentation
|
Holds all ORK project and in-game data. Use it to access everything ORK related data and procedures. More...
Static Public Member Functions | |
static ORK | Initialize (ORKProjectAsset project) |
Initializes ORK Framework with a ORK Project asset. More... | |
static void | Clear (bool control, bool initVariables) |
Clears ORK Framework. More... | |
static Coroutine | StartCoroutine (IEnumerator routine) |
static GetName | GetNameFunction (ORKDataType type) |
Gets a function to get the name of data type's data set for an index. More... | |
static string[] | GetTypedNames (ORKDataType type, bool addIndex) |
Gets a list of names including types. More... | |
static string[] | GetNames (ORKDataType type, bool addIndex) |
Gets a list of names. More... | |
static string[] | GetNames (ORKDataType type, int index, bool addIndex) |
Gets a list of names for attack/defence attributes. More... | |
static BaseData | Get (ORKDataType type, int index) |
Gets data of the specified type and index. More... | |
static int | Count (ORKDataType type) |
Gets the data count of a data type. More... | |
Static Public Attributes | |
static string | VERSION = "2.22.0" |
ORK Version number. More... | |
static string | PROJECT_PATH = "Assets/ORK Framework/ORKProject.asset" |
static string | EDITOR_PATH = "Assets/ORK Framework/EditorData.asset" |
static string | BACKUP_PATH = "Assets/_ORK_Project_Backups/" |
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 string | LoadedVersion [get] |
Gets the loaded version of the ORK Project asset. More... | |
static ORKCore | Core [get] |
Gets the ORK Framework core handler. More... | |
static AudioSource | Audio [get] |
Gets ORK Framework's main AudioSource, used to play menu sounds. More... | |
static AudioSource | AudioDialogue [get] |
Gets ORK Framework's AudioSource used for dialogue audio clips. More... | |
static GameHandler | 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 GUIHandler | GUI [get] |
Gets the GUI handler. Manages all displayed GUI boxes, HUDs and images. More... | |
static ControlHandler | Control [get] |
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 SaveGameHandler | SaveGame [get] |
Gets the save game handler. Used to save and load the game. More... | |
static MusicHandler | Music [get] |
Gets the music handler. Manages the background music. More... | |
static DataHandler | Data [get] |
Gets the data handler. Holds all data. More... | |
static EditorSettings | EditorSettings [get] |
Gets the editor settings. More... | |
static BackupSettings | Backups [get] |
Gets the backup settings. More... | |
static PluginsSettings | Plugins [get] |
Gets the plugins settings. More... | |
static LanguagesSettings | Languages [get] |
Gets the languages. More... | |
static ColorsSettings | Colors [get] |
Gets the colors. More... | |
static InputKeysSettings | InputKeys [get] |
Gets the input keys. More... | |
static ControlMapsSettings | ControlMaps [get] |
Gets the control maps. More... | |
static FormulaTypesSettings | FormulaTypes [get] |
Gets the formula types. More... | |
static FormulasSettings | Formulas [get] |
Gets the formulas. More... | |
static RequirementsSettings | Requirements [get] |
Gets the requirements. More... | |
static AnimationTypesSettings | AnimationTypes [get] |
Gets the animation types. More... | |
static AnimationsSettings | Animations [get] |
Gets the animations. More... | |
static DamageTypesSettings | DamageTypes [get] |
Gets the damage types. More... | |
static SoundTypesSettings | SoundTypes [get] |
Gets the sound types. More... | |
static PortraitTypesSettings | PortraitTypes [get] |
Gets the portrait types. More... | |
static VariableConditionTemplatesSettings | VariableConditionTemplates [get] |
Gets the variable condition templates. More... | |
static StatusRequirementTemplatesSettings | StatusRequirementTemplates [get] |
Gets the status requirement templates. 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 GameSettings | GameSettings [get] |
Gets the game settings. More... | |
static ConsoleSettings | ConsoleSettings [get] |
Gets the console settings. More... | |
static GameControlsSettings | GameControls [get] |
Gets the game controls. More... | |
static SceneConnectionSettings | SceneConnections [get] |
Gets the scene connections. 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 CameraPositionsSettings | CameraPositions [get] |
Gets the camera positions. More... | |
static MusicClipsSettings | MusicClips [get] |
Gets the music clips. More... | |
static GlobalEventsSettings | GlobalEvents [get] |
Gets the global events. More... | |
static AttackAttributesSettings | AttackAttributes [get] |
Gets the attack attributes. More... | |
static DefenceAttributesSettings | DefenceAttributes [get] |
Gets the defence attributes. More... | |
static StatusTypesSettings | StatusTypes [get] |
Gets the status types. More... | |
static StatusValuesSettings | StatusValues [get] |
Gets the status values. More... | |
static StatusEffectTypesSettings | StatusEffectTypes [get] |
Gets the status effects. More... | |
static StatusEffectsSettings | StatusEffects [get] |
Gets the status effects. More... | |
static StatusBonusesSettings | StatusBonuses [get] |
Gets the status bonuses. More... | |
static AbilityTypesSettings | AbilityTypes [get] |
Gets the ability types. More... | |
static AbilitiesSettings | Abilities [get] |
Gets the abilities. More... | |
static AbilityTreesSettings | AbilityTrees [get] |
Gets the ability trees. More... | |
static StatusDevelopmentsSettings | StatusDevelopments [get] |
Gets the status developments. More... | |
static AbilityDevelopmentsSettings | AbilityDevelopments [get] |
Gets the ability developments. More... | |
static InventorySettings | InventorySettings [get] |
Gets the inventory settings. 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 EquipmentPartsSettings | EquipmentParts [get] |
Gets the equipment parts. More... | |
static WeaponsSettings | Weapons [get] |
Gets the weapons. More... | |
static ArmorsSettings | Armors [get] |
Gets the armors. 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 FactionBenefitsSettings | FactionBenefits [get] |
Gets the faction benefits. More... | |
static FactionSympathySettings | FactionSympathy [get] |
Gets the faction sympathy settings. More... | |
static ClassesSettings | Classes [get] |
Gets the classes. More... | |
static BattleAIsSettings | BattleAIs [get] |
Gets the battle AIs. 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 BattleGridCellTypesSettings | BattleGridCellTypes [get] |
Gets the battle grid cell types. More... | |
static BattleRangeTemplatesSettings | BattleRangeTemplates [get] |
Gets the battle grid shapes. More... | |
static BattleGridFormationsSettings | BattleGridFormations [get] |
Gets the grid formations. More... | |
static CombatantTypesSettings | CombatantTypes [get] |
Gets the combatant types. More... | |
static CombatantsSettings | Combatants [get] |
Gets the combatants. More... | |
static CombatantGroupsSettings | CombatantGroups [get] |
Gets the combatant groups. More... | |
static MoveAIsSettings | MoveAIs [get] |
Gets the move AIs. More... | |
static LootSettings | Loot [get] |
Gets the loot settings. More... | |
static ResearchTypesSettings | ResearchTypes [get] |
Gets the research types. More... | |
static ResearchTreesSettings | ResearchTrees [get] |
Gets the research trees. More... | |
static BattleSettings | BattleSettings [get] |
Gets the battle settings. More... | |
static BattleSystemSettings | BattleSystem [get] |
Gets the battle system settings. More... | |
static BattleSpotsSettings | BattleSpots [get] |
Gets the battle spots. More... | |
static BattleMenusSettings | BattleMenus [get] |
Gets the battle menus. More... | |
static BattleTextsSettings | BattleTexts [get] |
Gets the battle texts. More... | |
static BattleEndSettings | BattleEnd [get] |
Gets the battle end settings. More... | |
static GUILayersSettings | GUILayers [get] |
Gets the GUI layers. More... | |
static GUIBoxesSettings | GUIBoxes [get] |
Gets the GUI boxes. More... | |
static MainMenuSettings | MainMenu [get] |
Gets the main menu settings. More... | |
static SaveGameMenuSettings | SaveGameMenu [get] |
Gets the save game menu 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 SceneObjectTypesSettings | SceneObjectTypes [get] |
Gets the scene object types. More... | |
static SceneObjectsSettings | SceneObjects [get] |
Gets the scene objects. 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 MenuSettings | MenuSettings [get] |
Gets the menu settings. More... | |
static CombatantSelectionsSettings | CombatantSelections [get] |
Gets the combatant selections. More... | |
static QuantitySelectionsSettings | QuantitySelections [get] |
Gets the quantity selections. More... | |
static ShortcutSettings | ShortcutSettings [get] |
Gets the shortcut settings. More... | |
static MenuScreensSettings | MenuScreens [get] |
Gets the menu screens. More... | |
static HUDsSettings | HUDs [get] |
Gets the HUDs. More... | |
static ShopLayoutsSettings | ShopLayouts [get] |
Gets the shop layouts. More... | |
static ShopsSettings | Shops [get] |
Gets the shops. More... | |
Holds all ORK project and in-game data. Use it to access everything ORK related data and procedures.
|
static |
Clears ORK Framework.
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. |
|
static |
Gets the data count of a data type.
type | The data type. |
|
static |
Gets data of the specified type and index.
type | The data type. |
index | The index of the data. |
|
static |
Gets a function to get the name of data type's data set for an index.
type | The data type. |
|
static |
Gets a list of names.
type | The data type. |
addIndex | If true, the index of the data will be added to the name. |
|
static |
Gets a list of names for attack/defence attributes.
type | The data type. |
index | The attribute index. |
addIndex | If true, the index of the data will be added to the name. |
|
static |
Gets a list of names including types.
type | The data type. |
addIndex | If true, the index of the data will be added to the name. |
|
static |
|
static |
ORK Version number.
|
staticget |
Gets the abilities.
The abilities.
|
staticget |
Gets the ability developments.
The ability developments.
|
staticget |
Gets the ability trees.
The ability trees.
|
staticget |
Gets the ability types.
The ability types.
|
staticget |
Gets the action combos.
The action combos.
|
staticget |
|
staticget |
|
staticget |
|
staticget |
Gets the animations.
The animations.
|
staticget |
Gets the animation types.
The animation types.
|
staticget |
Gets the areas.
The areas.
|
staticget |
Gets the area types.
The area types.
|
staticget |
Gets the armors.
The armors.
|
staticget |
Gets the attack attributes.
The attack attributes.
|
staticget |
Gets ORK Framework's main AudioSource, used to play menu sounds.
The audio source.
|
staticget |
Gets ORK Framework's AudioSource used for dialogue audio clips.
The audio source.
|
staticget |
Gets the backup settings.
The backup settings.
|
staticget |
Gets the battle handler. Manages running battles.
The battle handler.
|
staticget |
Gets the battle AIs.
The battle AIs.
|
staticget |
Gets the battle end settings.
The battle end settings.
|
staticget |
Gets the battle grid cell types.
The battle grid cell types.
|
staticget |
Gets the grid formations.
The grid formations.
|
staticget |
Gets the battle menus.
The battle menus.
|
staticget |
Gets the battle grid shapes.
The battle grid shapes.
|
staticget |
Gets the battle settings.
The battle settings.
|
staticget |
Gets the battle spots.
The battle spots.
|
staticget |
Gets the battle system settings.
The battle system settings.
|
staticget |
Gets the battle texts.
The battle texts.
|
staticget |
Gets the camera positions.
The camera positions.
|
staticget |
Gets the classes.
The classes.
|
staticget |
Gets the colors.
The colors.
|
staticget |
Gets the combatant groups.
The combatant groups.
|
staticget |
Gets the combatants.
The combatants.
|
staticget |
Gets the combatant selections.
The combatant selections.
|
staticget |
Gets the combatant types.
The combatant types.
|
staticget |
Gets the console settings.
The console settings.
|
staticget |
Gets the console types.
The console types.
|
staticget |
Gets the control handler. Handles the game control in-game.
The control handler.
|
staticget |
Gets the control maps.
The control maps.
|
staticget |
Gets the crafting recipes.
The crafting recipes.
|
staticget |
Gets the crafting types.
The crafting types.
|
staticget |
Gets the currencies.
The currencies.
|
staticget |
Gets the damage types.
The damage types.
|
staticget |
Gets the data handler. Holds all data.
The data handler.
|
staticget |
Gets the defence attributes.
The defence attributes.
|
staticget |
Gets the difficulties.
The difficulties.
|
staticget |
Gets the editor settings.
The editor settings.
|
staticget |
Gets the equipment parts.
The equipment parts.
|
staticget |
Gets the faction benefits.
The faction benefits.
|
staticget |
Gets the factions.
The factions.
|
staticget |
Gets the faction sympathy settings.
The faction sympathy settings.
|
staticget |
Gets the formulas.
The formulas.
|
staticget |
Gets the formula types.
The formula types.
|
staticget |
Gets the game handler. Keeps track of overall game data in-game.
The game handler.
|
staticget |
Gets the game controls.
The game controls.
|
staticget |
Gets the game settings.
The game settings.
|
staticget |
Gets the global events.
The global events.
|
staticget |
Gets the GUI handler. Manages all displayed GUI boxes, HUDs and images.
The GUI handler.
|
staticget |
Gets the GUI boxes.
The GUI boxes.
|
staticget |
Gets the GUI layers.
The GUI layers.
|
staticget |
Gets the HUDs.
The HUDs.
|
staticget |
Gets a value indicating whether ORK Framework is initialized.
true
if initialized; otherwise, false
.
|
staticget |
Gets the input keys.
The input keys.
|
staticget |
|
staticget |
Gets a value indicating whether ORK Framework is instantiated.
true
if instantiated; otherwise, false
.
|
staticget |
Gets the inventory settings.
The inventory settings.
|
staticget |
Gets the items.
The items.
|
staticget |
Gets the item types.
The item types.
|
staticget |
Gets the languages.
The languages.
|
staticget |
Gets the loaded version of the ORK Project asset.
The loaded version.
|
staticget |
Gets the logs.
The logs.
|
staticget |
Gets the log texts.
The log texts.
|
staticget |
Gets the log types.
The log types.
|
staticget |
Gets the loot settings.
The loot settings.
|
staticget |
Gets the main menu settings.
The main menu settings.
|
staticget |
Gets the menu handler. Manages menu screens and shops in-game.
The menu handler.
|
staticget |
Gets the menu screens.
The menu screens.
|
staticget |
Gets the menu settings.
The menu settings.
|
staticget |
Gets the move AIs.
The move AIs.
|
staticget |
Gets the music handler. Manages the background music.
The music handler.
|
staticget |
Gets the music clips.
The music clips.
|
staticget |
Gets the plugins settings.
The plugins settings.
|
staticget |
Gets the portrait types.
The portrait types.
|
staticget |
Gets the quantity selections.
The quantity selections.
|
staticget |
Gets the quests.
The quests.
|
staticget |
Gets the quest settings.
The quest settings.
|
staticget |
Gets the quest tasks.
The quest tasks.
|
staticget |
Gets the quest types.
The quest types.
|
staticget |
Gets the requirements.
The requirements.
|
staticget |
Gets the research trees.
The research trees.
|
staticget |
Gets the research types.
The research types.
|
staticget |
Gets the save game handler. Used to save and load the game.
The save game handler.
|
staticget |
Gets the save game menu settings.
The save game menu settings.
|
staticget |
Gets the scene connections.
The scene connections.
|
staticget |
Gets the scene objects.
The scene objects.
|
staticget |
Gets the scene object types.
The scene object types.
|
staticget |
Gets the shop layouts.
The shop layouts.
|
staticget |
Gets the shops.
The shops.
|
staticget |
Gets the shortcut settings.
The shortcut settings.
|
staticget |
Gets the sound types.
The sound types.
|
staticget |
Gets the statistics.
The statistics.
|
staticget |
Gets the status bonuses.
The status bonuses.
|
staticget |
Gets the status developments.
The status developments.
|
staticget |
Gets the status effects.
The status effects.
|
staticget |
Gets the status effects.
The status effects.
|
staticget |
Gets the status requirement templates.
The status requirement templates.
|
staticget |
Gets the status types.
The status types.
|
staticget |
Gets the status values.
The status values.
|
staticget |
Gets the teleports.
The teleports.
|
staticget |
Gets the text display settings.
The text display settings.
|
staticget |
Gets the variable condition templates.
The variable condition templates.
|
staticget |
Gets the weapons.
The weapons.