ORK 4 RPG Framework Logo
  • ORK 4 GUIDE
    • Documentation
    • Tutorials
    • Extensions
    • API
  • ORK 3 GUIDE
    • Documentation
    • Tutorials
    • API
  • Support
  • Forum
  • Get ORK

ORK 4 Documentation

  • Getting Started
    • Welcome
    • First Steps (Unity)
  • Features
    • The Status System
    • Schematics
    • Schematic Nodes
    • Dialogue Importer
    • Variables
    • Selected Data
  • Components
    • Battle Components
    • Combatant Components
    • Control Components
    • Cursor Prefab Components
    • Game Starters
    • Interactable Components
    • Move AI Components
    • Scene Setup Components
  • Editor
    • The ORK 4 Editor
    • Sections & Sub-Sections
    • Node Editor
    • Schematic Editor
    • Asset Sources
    • Unity Overlay Toolbar
  • Section: System
    • System Settings
    • Languages
    • Organizer Types
    • Game States & Conditions
    • General Condition Templates
    • Object Pools
    • Prefab Savers
    • Scene Connections
  • Section: Controls
    • Game Controls
    • Interaction Settings
    • Player Controls
    • Camera Controls
    • Input Keys
    • Control Maps
    • Camera Positions
    • Battle Camera
  • Section: Gameplay
    • Game Settings
    • Formulas
    • Difficulties
    • Shortcut Slots & Settings
    • Custom Settings & Global Custom Settings
    • Global Machines
    • Machine Templates
  • Section: Status
    • Status Values
    • Status Effects
    • Attack Modifiers
    • Defence Modifiers
    • Abilities & Ability Developments
    • Status Developments
    • Research Trees
    • Damage Types
    • Status Bonuses & Templates
    • Status Condition Templates
  • Section: Inventory
    • Inventory Settings
    • Inventory Containers
    • Currencies
    • Items
    • AI Rulesets
    • Crafting Recipes
    • Equipment Slots & Slot Set Templates
    • Equipment & Available Equipment Templates
    • Shops
    • Loot
  • Section: Combatants
    • Combatants
    • Combatant Groups
    • Class Slots
    • Classes
    • Factions & Faction Benefits
    • Animations
    • Move AIs
    • Formations
    • Action Combos
  • Section: Battles
    • Battle Systems
    • Turn Based Battles
    • Active Time Battles
    • Real Time Battles
    • Phase Battles
    • Battle Spots
    • Battle AIs
    • Battle Actions Settings
    • Special Commands Settings
    • Target Settings
    • Target Selection Templates
    • Battle Range Templates
    • Battle Grid Settings
    • Battle Grid Highlights
    • Battle Grid Cell Types
    • Battle Grid Formations
  • Section: Content
    • Content Types
    • Music
    • Sound Templates
    • Areas
    • Teleports
    • Quests & Quest Tasks
    • Logs & Log Texts
    • Object Contents
  • Section: UI
    • UI Settings
    • UI Layers
    • UI Layouts
    • UI Boxes
    • HUDs
    • Notifications
    • Cursor Settings
  • Section: Menus
    • Start Menu
    • Save Game Settings
    • Option Categories
    • Menu Screens
    • Menu Requirements
    • Battle Menus
    • Loot Dialogues
    • Item Collection
    • Combatant Selections
    • Quantity Selections
    • Shop Layouts
  • Section: Texts
    • Text Settings
    • Formatting Settings
    • Flying Texts
    • Use Cost Display
    • Status Preview Display
    • Bonus Display
    • Status Change Display
    • Console Settings & Console Types
    • Text Codes
  • Sections: Editor
    • Editor Settings
    • Backups
    • Variables
    • Plugins
  • Scripting
    • Access Handler
    • Custom Nodes
    • Custom Save Data
    • Custom Component Save Data

ORK 4 Tutorials

  • ORK 4 Unity Quickstart Tutorials (3D)
    • ORK 4 Unity Quickstart 3D
    • 01 Initial ORK Setup
    • 02 Player Setup
    • 03 Music & Scenes
    • 04 UI System Setup
    • 05 UI Boxes
    • 06 Flying Texts
    • 07 Status Values
    • 08 Status Effects
    • 09 First Abilities
    • 10 Fighter Setup
    • 11 First Enemies & Battle AI
    • 12 Battle System Setup
    • 13 Animating Battle Start and End
    • 14 Random Battles
    • 15 Animating Actions
    • 16 Player Battle HUD
    • 17 Elemental Attacks
    • 18 Animating More Actions
    • 19 Inventory & Loot
    • 20 Equipment
    • 21 Loot, Start Equipment & Viewers
    • 22 Magic Abilities
    • 23 Caster Setup
    • 24 More Enemies
    • 25 Start Menu & Save Games
    • 26 Menu Screens
    • 27 Interactions
    • 28 Item Collectors
    • Quickstart Extended
  • Battle Tutorials
    • Active Time Battles
    • Phase Battles
    • Real TT 01 Real Time Battles & Tab Targeting
    • Real TT 02 Control Map, Use Ranges & Battle Area
    • Real TT 03 Camera Control, Battle AI & Reuse Time
    • Real TT 04 Damage Detection, Action Animation & Player HUD
    • Real TT 05 Switch Player & Final Adjustments
    • Hit & Miss
    • Critical Hits
    • Cast Time
    • Reuse Time
    • Grid 01: Battle Grid Setup
    • Grid 02: Highlights
    • Grid 03: Cell Types
    • Grid 04: Move Command
    • Grid 05: Scene Grid Setup
    • Grid 06: Battle Ready
    • Grid 07 Use & Affect Ranges
    • Grid 08: Better Camera Control
  • Gameplay Tutorials
    • Multiple Interaction Controllers
    • Player Group Spawn & Follow
    • Spawn Hunting Enemies
    • Gamepad Controls (Unity Input System)
    • Combined Inputs
    • Control Map for Keyboard (Shortcuts)
    • Control Map for Gamepad (Shortcuts)
    • Quests 01: Menu Screen
    • Quests 02: Hunting
    • Quests 03: Collect Potion Materials
    • Quests 04: Collect Equipment Materials
    • Quests 05: Quest Mark HUDs
    • Crafting 01: Menu Screen
    • Crafting 02: Materials & Recipes
    • Crafting 03: Getting Materials
    • Crafting 04: Proficiency & Critical Outcome
    • Shop
    • Inventory Containers
  • Schematics Tutorials
    • UI Animation Schematics
    • Flying Text Animation Schematics
    • HUD Conditional Schematics
  • UI Tutorials
    • Unity UI: Initial Setup
    • Unity UI: Status Value UI Setup
    • Unity UI: Status Effect UI Setup
    • Unity UI: Shortcut UI Setup
    • Unity UI: Dragging Notification
    • Unity UI: Interaction HUD
    • Unity UI: Shortcut HUD
    • Unity UI: Turn Order HUD
    • Unity UI: Cast Time HUD
    • Unity UI: Quest HUD
    • Unity UI: Tooltip HUD
    • Unity UI: Move Range HUD
    • Menus 01 UI Box Setup
    • Menus 02 Template HUDs
    • Menus 03 Menu Setup
    • Menus 04 Main Menu
    • Menus 05 Inventory
    • Menus 06 Equipment
    • Menus 07 Ability
    • Menus 08 Group
    • Menus 09 Quest
    • Menus 10 Crafting
  • Module 01: Status System
    • Introduction to Modular Tutorials
    • M01.1: Status Values
      • Introduction to Status Values
      • Health
      • Mana
      • Barrier
      • Base Experience
      • Class Experience
      • Spendable Experience
      • Normal Stats
    • M01.2: Modifiers
      • Introduction to Modifiers
      • Element
      • Attack Type
      • Size
      • Race
    • M01.3: Status Effects
      • Introduction to Status Effects
      • Buffs
      • Debuffs
      • Poison
      • Regeneration
      • Blind
      • Stun
      • Sleep
      • Silence
      • Enchants
      • Charm
      • Doom
      • Reflect
  • Module 02: Actions
    • Introduction to Actions
    • M02.1: Formulas
      • Introduction to Formulas
      • Physical Damage Formula
      • Magical Damage Formula
      • Hit Chance
      • Critical Chance
    • M02.2: Abilities
      • Introduction to Abilities
      • Base Attack
      • Elemental Magic Spells
      • Steal Ability
      • Drain
      • Healing Spell
      • Cure
      • Buff Abilities
      • Debuff Abilities

ORK 4 Extensions

  • Plugins
    • Save Game Compression Plugin
  • Schematic Nodes
    • Footstepper Nodes (Unity)
  • Scripts
    • A* Pathfinding Movement Component (Unity)
    • PolyNav 2D Movement Component (Unity)
    • Cinemachine Camera Control Type (Unity)
    • Rewired Input Key (Unity)
    • Unity Legacy Input Key (Unity)
    • Core GameKit Wrapper (Unity)
    • Pool Boss Wrapper (Unity)
View Categories
  • Guide
  • ORK 4
  • ORK 4 Documentation
  • Section: Gameplay

Custom Settings & Global Custom Settings

0:00 / 10:24
  • View as Markdown Open this page as plain Markdown (opens in a new tab)
  • Open in ChatGPT Ask questions about this page (opens in a new tab)
  • Open in Claude Ask questions about this page (opens in a new tab)
  • Open in Google AI Studio Ask questions about this page (Google account required) (opens in a new tab)

Custom settings are an easy way to add custom systems to your project.

Custom settings are an easy way to add your own settings to the editor and functionality to the game. There are globally available settings (see global custom settings below) and as settings bound to separate instances of content (e.g. combatants or items, see custom settings below).

Global Custom Settings #

Global custom settings are available, as the name suggests, globally – i.e. from everywhere and at all times.

Global custom settings are found in Gameplay > Global Custom Settings.

Each global custom setting will create it’s own in-game instance and will be saved with save games. When enabling Clear New Game, starting a new game will automatically create a new, clean instance when starting a new game (e.g. to remove any changes made to the instance by a previous game.

Using #

You can call custom functionality via the Use function of it’s implementation (see details in the scripting information below). The Use function can start different functionality based on the passed on parameters, e.g. via the info string parameter.

The function can be used without scripting by built-in functionality in schematics (Use Global Custom Settings node), menu screens (Use Global Custom Settings button type in Button List menu parts), abilities, items, status effects, battle menus, research items and body parts (Use Global Custom Settings status change type).

Beside using this, you can also implement custom nodes to call functionality (other than the Use function) of your global custom settings classes.

Scripting #

To add your own global custom settings, you need to write a custom class extending from BaseGlobalCustomSettingsType class.

The class has to implement the CreateInstance function, which returns in instance class implementing the IGlobalCustomSettingsInstance interface. Additionally, the class has to add the EditorSettingsInfo attribute to add editor information for the type selection dropdown of the global custom settings.

The instance class is used for keeping track of any in-game changes as well as saving and loading the data of the instance with save games.

Accessing #

Global custom settings can be accessed via ORK.GlobalCustomSettings, either getting a setting by it’s index in the editor or by using it’s GUID.

Via index:

int index = 0;
GlobalCustomSettings settings = ORK.GlobalCustomSettings.Get(index);

Via GUID:

string guid = "YOUR_GUID";
GlobalCustomSettings settings = ORK.GlobalCustomSettings.Get(guid);

You can access the in-game instance via the GlobalCustomSettings class by using the Instance property.

E.g. to cast it to a specific setting’s instance instead of the IGlobalCustomSettingsInstance interface:

DebugGlobalCustomSettingsType.Instance instance = ORK.GlobalCustomSettings.Get(index).Instance as DebugGlobalCustomSettingsType.Instance;
if(instance != null)
{
    // your code
}

Casting it to your specific class instance allows you to access other functionality beside the functions provided by the interface.

Initialization and Unloading #

Global custom settings instances don’t require a specific function for initializing it’s content – if you need to handle some custom setup, call this in the constructor of your instance class.

However, the instance requires the Unload function, which will be called when an old instance is replaced by a new instance (e.g. when loading a save game or starting a new game with creating a new instance). This function can be used to handle things to clean up an old instance, e.g. to remove event hooks.

Debug Class Example #

Below you can see the an example implementation of the Debug global custom settings type.

This class outputs a text to the console and increases a counter by 1 each time it’s used. The counter is saved with save games.

namespace GamingIsLove.ORKFramework
{
    [EditorSettingInfo("Debug", "Test implementation, outputs information on user and target to the console.\n" +
        "Each call to the 'Use' function will increase a counter, which can also be output to the console.")]
    public class DebugGlobalCustomSettingsType : BaseGlobalCustomSettingsType
    {
        [EditorHelp("Debug Type", "Select the debug type will be used:\n" +
            "- Log: Printed to 'Debug.Log'.\n" +
            "- Warning: Printed to 'Debug.LogWarning'.\n" +
            "- Error: Printed to 'Debug.LogError'.", "")]
        [EditorFoldout("Debug Settings", "")]
        public DebugType type = DebugType.Log;

        [EditorSeparator]
        public VariableOrigin<ObjectSelection> variable = new VariableOrigin<ObjectSelection>();

        [EditorHelp("Text", "The text that will be printed to the console.", "")]
        [EditorEndFoldout]
        [EditorSeparator]
        [EditorTitleLabel("Console Output")]
        [EditorLabel("<user> = user information, <target> = target information\n" +
            "<count> = use counter, <info> = info text")]
        public TextContent text = new TextContent("<user>:<target>:<count>:<info>");

        public DebugGlobalCustomSettingsType()
        {

        }

        public override IGlobalCustomSettingsInstance CreateInstance()
        {
            return new Instance(this);
        }


        /*
        ============================================================================
        Instance class
        ============================================================================
        */
        public class Instance : IGlobalCustomSettingsInstance
        {
            protected DebugGlobalCustomSettingsType settings;

            protected int count = 0;

            public Instance(DebugGlobalCustomSettingsType settings)
            {
                this.settings = settings;
            }

            public virtual void Unload()
            {

            }

            public virtual void Use(object user, object target, string info, VariableHandler variables, SelectedDataHandler selectedData)
            {
                this.count++;

                UIText content = new UIText(this.settings.text, null,
                    this.settings.variable.GetFirstHandler(new DataCall(user, target, variables, selectedData)));
                content.Replace("<count>", ORK.FormattingSettings.numberFormatting.intNumberFormat.FormatLong(this.count));
                content.Replace("<user>", user is IContent ? ((IContent)user).GetName() : "" + user);
                content.Replace("<target>", target is IContent ? ((IContent)target).GetName() : "" + target);
                content.Replace("<info>", info);

                if(DebugType.Log == this.settings.type)
                {
                    Debug.Log(content.Text);
                }
                else if(DebugType.Warning == this.settings.type)
                {
                    Debug.LogWarning(content.Text);
                }
                else if(DebugType.Error == this.settings.type)
                {
                    Debug.LogError(content.Text);
                }
            }

            public virtual DataObject SaveGame()
            {
                DataObject data = new DataObject();
                data.Set("count", this.count);
                return data;
            }

            public virtual void LoadGame(DataObject data)
            {
                if(data != null)
                {
                    data.Get("count", ref this.count);
                }
            }
        }
    }
}

Custom Settings #

Custom settings can be added to combatants, classes, items, equipment, abilities and status effects.

Each instance of those contents will have their own instances of the added custom settings, e.g. each combatant has it’s own custom settings instances, each status effect added to a combatant has it’s own instances of it’s added custom settings.

The data of those instances are saved with the save data of the content they belong to, e.g. with a combatant, an item or equipment.

Using #

Using the correct custom settings of a content can depend on a settings key set up to identify it. Otherwise, the use is similar to global custom settings, i.e. you call the instance’s Use function.

The function can be used in schematics via the Use Custom Settings node and call it call it for content stored in selected data. Abilities, items and status effects can use the Use Custom Settings status change type to call their own instance’s Use function.

Beside using this, you can also implement custom nodes to call functionality (other than the Use function) of your custom settings classes.

Scripting #

To add your own custom settings, you need to write a custom class extending from BaseCustomSettingsType class.

The class has to implement the CreateInstance function, which returns in instance class implementing the ICustomSettingsInstance interface. Additionally, the class has to add the EditorSettingsInfo attribute to add editor information for the type selection dropdown of the custom settings.

The instance class is used for keeping track of any in-game changes as well as saving and loading the data of the instance with save games.

Accessing #

Since custom settings are bound to instances of content like combatants or items, they’re also accessed via those instances. Basically, everything implementing the ICustomSettings interface can give access to the instance of a custom setting added to it.

This is currently available in the following classes representing an instance of a content:

  • abilities via the AbilityShortcut class
  • classes via the ClassShortcut class
  • combatants via the Combatant class
  • equipment via the EquipShortcut class
  • items via the ItemShortcut class
  • status effects via the StatusEffect class

The ICustomSettings interface provides 2 functions to interact with the custom settings instance.

The UseCustomSettings function calls the Use function of the instance for a provided settings key, e.g. on an item (ItemShortcut class):

item.UseCustomSettings("key", user, target, "info", variables, selectedData);

The user and target parameters can be anything, e.g. a combatant, while the info string provides the context for the call. You can use it to call different functionality in your custom settings instance. Passing on variables or selected data is optional, e.g. pass on null if you don’t need them.

The GetCustomSettingsInstance function returns the instance of custom settings for a provided key, e.g. on a combatant (Combatant class):

DebugCustomSettingsType.Instance instance = combatant.GetCustomSettingsInstance("debug") as DebugCustomSettingsType.Instance;

The above example also casts the instance to a specific class implementation. If the returned instance doesn’t match the cast class type, the instance will be null.

Initialization #

Custom settings provide two initialization functions, the Init function for initialization of a new instance and the InitLoad function when initializing an instance before loading data from a save game. Both pass on the source they belong to, e.g. the instance of the combatant or item they’re bound to.

Debug Class Example #

Below you can see the an example implementation of the Debug custom settings type.

This class outputs a text to the console and increases a counter by 1 each time it’s used. The counter is saved with save games.

namespace GamingIsLove.ORKFramework
{
    [EditorSettingInfo("Debug", "Test implementation, outputs information on the instance, user and target to the console.\n" +
        "Each call to the 'Use' function will increase a counter, which can also be output to the console.")]
    public class DebugCustomSettingsType : BaseCustomSettingsType
    {
        [EditorHelp("Debug Type", "Select the debug type will be used:\n" +
            "- Log: Printed to 'Debug.Log'.\n" +
            "- Warning: Printed to 'Debug.LogWarning'.\n" +
            "- Error: Printed to 'Debug.LogError'.", "")]
        public DebugType type = DebugType.Log;

        [EditorSeparator]
        public VariableOrigin<ObjectSelection> variable = new VariableOrigin<ObjectSelection>();

        [EditorHelp("Text", "The text that will be printed to the console.", "")]
        [EditorSeparator]
        [EditorTitleLabel("Console Output")]
        [EditorLabel("<count> = use counter, <content> = content information (e.g. item)\n" +
            "<user> = user information, <target> = target information\n" +
            "<info> = info text")]
        public TextContent text = new TextContent("<content>:<user>:<target>:<count>:<info>");

        public DebugCustomSettingsType()
        {

        }

        public override string ToString()
        {
            return "Debug";
        }

        public override ICustomSettingsInstance CreateInstance()
        {
            return new Instance(this);
        }


        /*
        ============================================================================
        Instance class
        ============================================================================
        */
        public class Instance : ICustomSettingsInstance
        {
            protected DebugCustomSettingsType settings;

            protected int count = 0;

            public Instance(DebugCustomSettingsType settings)
            {
                this.settings = settings;
            }

            public virtual void Init(object source)
            {

            }

            public virtual void InitLoad(object source)
            {

            }

            public virtual void Use(object source, object user, object target, string info, VariableHandler variables, SelectedDataHandler selectedData)
            {
                this.count++;

                UIText content = new UIText(this.settings.text, null, 
                    this.settings.variable.GetFirstHandler(new DataCall(user, target, variables, selectedData)));
                content.Replace("<count>", ORK.FormattingSettings.numberFormatting.intNumberFormat.FormatLong(this.count));
                content.Replace("<content>", source is IContent ? ((IContent)source).GetName() : "" + source);
                content.Replace("<user>", user is IContent ? ((IContent)user).GetName() : "" + user);
                content.Replace("<target>", target is IContent ? ((IContent)target).GetName() : "" + target);
                content.Replace("<info>", info);

                if(DebugType.Log == this.settings.type)
                {
                    Debug.Log(content.Text);
                }
                else if(DebugType.Warning == this.settings.type)
                {
                    Debug.LogWarning(content.Text);
                }
                else if(DebugType.Error == this.settings.type)
                {
                    Debug.LogError(content.Text);
                }
            }

            public virtual DataObject SaveGame()
            {
                DataObject data = new DataObject();
                data.Set("count", this.count);
                return data;
            }

            public virtual void LoadGame(DataObject data)
            {
                if(data != null)
                {
                    data.Get("count", ref this.count);
                }
            }
        }
    }
}

 

Table of Contents
  • Global Custom Settings
    • Using
    • Scripting
      • Accessing
      • Initialization and Unloading
      • Debug Class Example
  • Custom Settings
    • Using
    • Scripting
      • Accessing
      • Initialization
      • Debug Class Example
Sitemap
  • Showcase
  • ORK 4 Guide
    • Documentation
    • Tutorials
    • Extensions
    • API
  • ORK 3 Guide
    • Documentation
    • Tutorials
    • API
  • ORK 2 Hub
    • Tutorials
    • Plugins
    • API
  • Support
  • Forum
  • Get ORK
  • Contact
  • Blog
  • Makinom
  • gamingislove.com
Categories
  • News (75)
  • ORK 2 (137)
    • Tutorial (137)
      • Game tutorial (50)
      • Gameplay (32)
      • How-to (55)
  • Release (158)
Search

© 2015 Gaming is Love e.U.

Disclosure: This site may contain affiliate links, which means I may receive a commission if you click a link and purchase something that I have recommended. While clicking these links won’t cost you any money, they will help me fund my development projects while recommending great assets!