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: Controls

Input Keys

0:00 / 4:47
  • 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)

Set up input from different sources to be used in ORK Framework

Input keys are found in Controls > Input Keys.

Input keys build a control layer between ORK and various input sources (e.g. the game engine’s input system or 3rd party solutions). This allows inputs to be set via Control HUDs (for virtual on screen controls, e.g. on mobile platforms), schematics (Set Input Key node) or via scripting.

General Settings #

The general settings define settings not bound to a specific input key.

Unity: Load Input Actions #

This is only available in Unity and used for input actions of the new input system.

It allows you to load not yet used input actions from a provided input action asset.
New input keys will be created for each input action that hasn’t yet been used by another input key.

Input Rebinding #

Input rebinding allows the player to change the input source for an input key. Rebinding is based on the input ID currently used for the options menu – i.e. also depending on where it was called from. E.g. for local multiplayer, each player can define their own controls via menu screens.

You can define what happens when rebinding an already used input, e.g. keeping both inputs, swapping the inputs or setting the other input to none.

Rebinding can only use input sources that are added to the settings here.

Cancel Key #

Optionally define an input key used to cancel input rebinding.

Please note that the cancel key’s input source can’t be used for rebinding. E.g. when bound to Escape, the escape key can’t be used to bind any other input to it.

Bind Audio #

Optionally play an audio clip when binding an input key to a new input source.

Rebind Info Dialogue #

Optionally show a rebind info dialogue while rebinding an input.

The dialogue can show content information about the input key as well as the current bound input source (e.g. key code).

Input Search #

Rebinding will search the defined input sources that are added here. Inputs are found on pressing down an input (e.g. key or mouse down).

You can add the input sources you want to be able to be found. The available types depend on the game engine.

Input IDs #

Input IDs allow having multiple input origins for an input key. They’re used to create different control styles/layouts or allow local multiplayer controls.

The default (global) input ID is 0 when starting a game. Machine components can either use the default input ID or override it, i.e. this can be used to have machines with the same schematic react to different input.

The global input ID can also be changed in-game, e.g. for switching control styles.

The minimum input ID is 0, an input ID of -1 can be used to check for any inputs of an input key (ignoring input ID).

Example #

The Accept and Cancel input keys have 2 input origins each.

Accept uses joystick button 1 for input ID 0 and joystick button 2 for input ID 1.

Cancel uses joystick button 2 for input ID 0 and joystick button 1 for input ID 1.

Switching the global input ID between 0 and 1 allows switching the Accept and Cancel input key’s buttons.

Input Origins #

The input origin defines where an input ID key’s input is coming from. There are several input origins available out of the box and you can use the Custom input origin to quickly connect 3rd party input systems via reflection.

You can also create custom input origins by deriving your class from the BaseInputIDKeySetting. Check out the included input origins for examples.

ORK Input Origins #

The following input origins are available in all game engines.

Custom #

A custom control script is used.

Input Key #

Other input keys are used.

Key Combo #

A key combo sequence is used.

Mouse #

A mouse button is used (uses mouse cursor position change as axis).

Please note that the axis is based on mouse cursor movement, i.e. it’ll not work during locked cursor.

None #

No direct input is used. Input from a HUD, schematics or code can still be used.

Touch #

A touch is used (uses touch position change as axis).

This is only used if the game engine supports touch inputs.

Unity Input Origins #

The following input origins are available in Unity.

Acceleration #

A selected axis of the last linear acceleration of a device is used.

Action (Input System) #

An input action from the Unity input system is used.

Gamepad Button (Input System) #

The defined gamepad button is used.

Gyroscope #

A selected axis of gyroscope data of a device is used.

Key Code (via extension) #

The key mapped to the selected key code is used.

This uses the legacy input system and requires the legacy input extension (download here).

Keyboard Key (Input System) #

The defined keyboard keys are used.

Rewired (via extension) #

A Rewired input is used.

This uses Rewired and requires the Rewired extension (download here).

Unity Input Manager (via extension) #

A key defined in the Unity input manager is used.

This uses the legacy input system and requires the legacy input extension (download here).

Table of Contents
  • General Settings
    • Unity: Load Input Actions
    • Input Rebinding
      • Cancel Key
      • Bind Audio
      • Rebind Info Dialogue
      • Input Search
  • Input IDs
    • Example
  • Input Origins
    • ORK Input Origins
      • Custom
      • Input Key
      • Key Combo
      • Mouse
      • None
      • Touch
    • Unity Input Origins
      • Acceleration
      • Action (Input System)
      • Gamepad Button (Input System)
      • Gyroscope
      • Key Code (via extension)
      • Keyboard Key (Input System)
      • Rewired (via extension)
      • Unity Input Manager (via extension)
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!