Difference between revisions of "Template:Input/Documentation"

Revision as of 21:17, 18 October 2013

Description

This settings table is meant to contain all information relating to input settings. If a setting is hackable or requires additional notes, add the information below the table in a header like so:

=== [[Controller support]] ===
Fixbox here
...

and make note of it in the table in the following fashion See [[#Controller support|Controller support]]. Any smaller notes can and should be included directly in the table.

Below is a more thorough explanation of each of the possible arguments. Each can be appended with notes to fill in the information in the Notes column.

Arguments

key remap - Whether the keyboard and mouse buttons are rebindable. Defines Property:Key remapping;
acceleration option - Whether the game uses mouse acceleration/smooting. Clarify which in the notes. Defines Property:Mouse acceleration;
mouse menu - Whether the mouse can be used to navigate the menu. Defines Property:Mouse input in menus;
invert mouse y-axis - Whether the mouse Y-axis can be inverted. This only applies to games with some sort of camera control. Defines Property:Mouse Y-axis inversion;
controller support - Whether the game supports controllers. Defines Property:Controller support;
full controller - Whether the game supports using just the controller, aka "Big Picture". Defines Property:Full controller support;
controller remap - Whether the controller buttons are rebindable. Property:Controller remapping;
invert controller y-axis - Whether the controller Y-axis can be inverted. This only applies to games with some sort of camera control. Defines Property:Controller Y-axis inversion;
touchscreen - Whether the game is optimized for touchscreens. Defines Property:Touchscreen optimised.

Syntax

{{Input settings
|key remap                 = 
|key remap notes           = 
|acceleration option       = 
|acceleration option notes = 
|mouse menu                = 
|mouse menu notes          = 
|invert mouse y-axis       = 
|invert mouse y-axis notes = 
|controller support        = 
|controller support notes  = 
|full controller           = 
|full controller notes     = 
|controller remap          = 
|controller remap notes    = 
|invert controller y-axis  = 
|invert controller y-axis notes= 
|touchscreen               = 
|touchscreen notes         = 
}}

@@ Line 11: / Line 11: @@
 ;Arguments
-* {{Code|key remap}}           - Defines [[Property:Key remapping]];
+* {{Code|key remap}}           - Whether the keyboard and mouse buttons are rebindable. Defines [[Property:Key remapping]];
-* {{Code|acceleration option}} - Defines [[Property:Mouse acceleration]];
+* {{Code|acceleration option}} - Whether the game uses mouse acceleration/smooting. Clarify which in the notes. Defines [[Property:Mouse acceleration]];
-* {{Code|mouse menu}}          - Defines [[Property:Mouse input in menus]];
+* {{Code|mouse menu}}          - Whether the mouse can be used to navigate the menu. Defines [[Property:Mouse input in menus]];
-* {{Code|invert mouse y-axis}} - Defines [[Property:Mouse Y-axis inversion]];
+* {{Code|invert mouse y-axis}} - Whether the mouse Y-axis can be inverted. This only applies to games with some sort of camera control. Defines [[Property:Mouse Y-axis inversion]];
-* {{Code|controller support}}  - Defines [[Property:Controller support]];
+* {{Code|controller support}}  - Whether the game supports controllers. Defines [[Property:Controller support]];
-* {{Code|full controller}}     - Defines [[Property:Full controller support]];
+* {{Code|full controller}}     - Whether the game supports using just the controller, aka "Big Picture". Defines [[Property:Full controller support]];
-* {{Code|controller remap}}    - Defines [[Property:Controller remapping]];
+* {{Code|controller remap}}    - Whether the controller buttons are rebindable. [[Property:Controller remapping]];
-* {{Code|invert controller y-axis}} - Defines [[Property:Controller Y-axis inversion]];
+* {{Code|invert controller y-axis}} - Whether the controller Y-axis can be inverted. This only applies to games with some sort of camera control. Defines [[Property:Controller Y-axis inversion]];
-* {{Code|touchscreen}}         - Defines [[Property:Touchscreen optimised]].
+* {{Code|touchscreen}}         - Whether the game is optimized for touchscreens. Defines [[Property:Touchscreen optimised]].
 ;Syntax