Merge #1232

1232: Add some docs for actions. r=Xaeroxe a=derekdreery Explains the structure of `Bindings::action`. Co-authored-by: Richard Dodd <richard.o.dodd@gmail.com> Co-authored-by: Richard Dodd (dodj) <richard.o.dodd@gmail.com>
amethyst · Dec 13, 2018 · a510bc9 · a510bc9
2 parents 9287198 + 0d0a507
commit a510bc9
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/amethyst_input/src/bindings.rs b/amethyst_input/src/bindings.rs
@@ -18,6 +18,10 @@ where
     AC: Hash + Eq,
 {
     pub(super) axes: HashMap<AX, Axis>,
+    /// The inner array here is for button combinations, the other is for different possibilities.
+    ///
+    /// So for example if you want to quit by either "Esc" or "Ctrl+q" you would have
+    /// `[[Esc], [Ctrl, Q]]`.
     pub(super) actions: HashMap<AC, SmallVec<[SmallVec<[Button; 2]>; 4]>>,
 }