Universal Fighting Engine

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Input Options ======
Before your game can work you need to link the key from Unity's Input Manager to UFE.

{{ :global:global_inputunity.png?nolink |}}

**Input Manager:** UFE is compatible with 4 different input options.

  * **Unity Input Manager:** UFE will attempt to use [[https://docs.unity3d.com/Documentation/Components/class-InputManager.html|Unity's default Input Manager]]. UFE comes with a pre-designed InputManager (located under [[http://docs.unity3d.com/Manual/comp-ManagerGroup.html|Project Settings]]). You can find a copy of this file under the ''ProjectSettings'' folder.
  * **cInput (3rd party required):** UFE will attempt to load [[http://cinput2.weebly.com/|cInput 2.0]] if you have it installed. For more information on how to use its references check out their [[http://cinput2.weebly.com/reference-manual.html|reference manual]].
  * ** Rewired (3rd party required):** UFE will attempt to load [[http://guavaman.com/projects/rewired/|Rewired]]. For more information on how to install this plugin [[http://guavaman.com/projects/rewired/docs/Integration.html#UniversalFightingEngine|click here]].
  * **Control Freak (3rd party required):** Allows the use of mobile control for player 1. A prefab example of Control Freak usage is provided under the ThirdPartyAssets folder. For more information on Control Freak [[https://assetstore.unity.com/packages/tools/input-management/control-freak-2-touch-input-made-easy-11562|click here]].
  * **Custom Class**: Use this option to create your own inherited input class. You can also use a component available under UFE called "GUIControlsInterface.cs". Just create a new game object in your hierarchy with the component, then add it to your UFE Manager. Hit the play button and you will see GUI buttons representing controls for player 1. For more information, refer to this [[http://www.ufe3d.com/forum/viewtopic.php?pid=7309#p7309|forum post]].

**Force Digital Input:** If disabled, UFE will apply horizontal forces relative to analog input sensitivity.

**Confirm Button:** Choose which of the control buttons will be used to //confirm// options under menus.

**Cancel Button:** Choose which of the control buttons will be used to //cancel/go back// under menus.

----
==== Player Inputs (Unity Input Manager) ====
These values must match with the values under [[https://docs.unity3d.com/Documentation/Components/class-InputManager.html|Unity's default Input Manager]]. If you correctly installed UFE, the inputs registered in the demo file should match with the //Input Settings//.


**Input Type:** Select if this input is an Axis or a button.
  * **Horizontal Axis:** Must match an element under the Input Manager with ''Axis'' set to //X Axis//.
  * **Vertical Axis:** Must match an element under the Input Manager with ''Axis'' set to //Y Axis//.
  * **Button:** Must match a button registered under the Input Manager with ''Type'' set to //Key or Mouse Button//.

**(Axis) Keyboard Axis Reference:** The name of the related ''Axis'' under the [[https://docs.unity3d.com/Documentation/Components/class-InputManager.html|Input Manager]]. Make sure ''Type'' is set to //Key or Mouse Button//.

**(Axis) Joystick Axis Reference:** The name of the related ''Axis'' under the [[https://docs.unity3d.com/Documentation/Components/class-InputManager.html|Input Manager]]. Make sure ''Type'' is set to //Joystick Axis//.

**(Button) Input Manager Reference:** The name of the related ''Axis'' under the [[https://docs.unity3d.com/Documentation/Components/class-InputManager.html|Input Manager]]. Make sure ''Type'' is set to //Key or Mouse Button//.

**(Image) Axis/Button Icon:** The image corresponding to axis direction or button pressed.  This is used in debug mode for onscreen display of inputs. For more information check out this [[http://www.ufe3d.com/forum/viewtopic.php?id=147|article]].


----
==== Control Freak (Mobile Controls) ====
For more on Control Freak visit their [[https://assetstore.unity.com/packages/tools/input-management/control-freak-2-touch-input-made-easy-11562|website]].


**Control Freak 1.x**
  - Import Control Freak to your project.
  - Switch the input manager on Input Options to Control Freak. You will see a new option: ''Control Freak Preferences''. Unfold it.
  - Drag one of the 2 presets from ''UFE\ThirdPartyAssets\Control-Freak-1'' to the //Prefab// option: __CF-UFE-2Buttons__ (2 buttons) or __CF-UFE-4Buttons__ (4 buttons). Use the [[http://docs.unity3d.com/Manual/Inspector.html|Inspector]] to adjust these files to your liking.
  - Run the game. The mobile controls will control player 1.


**Control Freak 2.0**
  - Import [[https://assetstore.unity.com/packages/tools/input-management/control-freak-2-touch-input-made-easy-11562|Control Freak 2]] to your project.
  - A pop-up will ask you to update the Input Manager. Proceed with the installation.
  - Under ''Plugins\Control-Freak-2\Add-Ons\'' click on ''CF2-UFE.unitypackage'' and import it to your project.
  - Switch the input manager on Input Options to Control Freak. You will see a new option: ''Control Freak Preferences''. Unfold it.
  - Drag one of the presets from ''UFE\ThirdPartyAssets\Control-Freak-2\Prefabs\'' to the //Prefab// option. Use the [[http://docs.unity3d.com/Manual/Inspector.html|Inspector]] to adjust these files to your liking.


  * To have it working on Android you need set the Scripting Backend in your Build -> Player Settings to **IL2CPP**. For more on that check out [[https://forum.unity.com/threads/universal-fighting-engine-2.541442/#post-3815395|this post]].
  * For more on exporting to Android [[http://docs.unity3d.com/Manual/android-GettingStarted.html|click here]]. 
  * For more on exporting to iOS [[http://docs.unity3d.com/Manual/iphone-GettingStarted.html|click here]].


----
==== Special Notes ====

  * By default, UFE will always attempt to load Unity's default input manager.
  * If cInput is installed you will see a new option under the options menu inside the game: Change Controls. This will attempt to load the default cInput GUISkin. You will find this file under the cInput templates folder.
  * Each player must have both Horizontal Axis and Vertical Axis defined.
  * If you are using Unity's Input Manager, you must set the Joystick Axis reference as well.
  * Make sure you link the buttons to buttons and axis to axis.

----
Code access: 

''UFE.config.player1_Inputs''

''UFE.config.player2_Inputs''


Code example: 
<code c#>
// Full code example: .\UFE\Engine\Scripts\Core\UI\Base\CharacterSelectionScript.cs
// Change from Keyboard to Joystick
foreach (InputReferences inputRef in UFE.config.player1_Inputs){
	if (inputRef.inputType == InputType.HorizontalAxis){
		if (inputRef.inputButtonName == "P1KeyboardHorizontal") 
			inputRef.inputButtonName = "P1JoystickHorizontal";
	}else if (inputRef.inputType == InputType.VerticalAxis){
		if (inputRef.inputButtonName == "P1KeyboardVertical") 
			inputRef.inputButtonName = "P1JoystickVertical";
	}
}</code>
----

[[global:start|< Back to Global Editor]]
Universal Fighting Engine

User Tools

Site Tools

Page Tools
