Skip to content

Commit 6f162f9

Browse files
committed
Update readme.
1 parent e704a34 commit 6f162f9

3 files changed

Lines changed: 33 additions & 1 deletion

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ Also, KeybindLib is a library mod, so it doesn't change any gameplay mechanics o
124124

125125
### Building
126126

127-
KeybindLib's build system is in the [`build`](./build) directory. See the readme there for a guide to building KeybindLib.
127+
KeybindLib's build system is in the [`build`](./build) directory. See [`build/README.md`](./build/README.md) for a guide to building KeybindLib.
128128

129129
## License
130130

src/ExampleMod/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ If you have any questions, feel free to message me on Discord (`Esper#8989`) or
1919

2020
- `key.nest` (Nest, `N`): Causes you to jump, but does not start the jetpack. Does not require you to press it again to jump again.
2121

22+
- `key.jump` (Jump, `Space`): The vanilla jump action, but it prints `Thanks for jumping!` in the console upon release.
23+
2224
## License
2325
Copyright (c) 2021 Esper Thomson
2426

src/KeybindLib/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@
1212
- [#ctor()](#M-KeybindLib-Bind-ButtonBind-#ctor-InControl-InputControlType- 'KeybindLib.Bind.ButtonBind.#ctor(InControl.InputControlType)')
1313
- [BindDefault()](#M-KeybindLib-Bind-ButtonBind-BindDefault-InControl-PlayerAction- 'KeybindLib.Bind.ButtonBind.BindDefault(InControl.PlayerAction)')
1414
- [KeyAction](#T-KeybindLib-Keybind-KeyAction 'KeybindLib.Keybind.KeyAction')
15+
- [KeyActionRegisteredTooEarlyException](#T-KeybindLib-KeybindRegistry-KeyActionRegisteredTooEarlyException 'KeybindLib.KeybindRegistry.KeyActionRegisteredTooEarlyException')
16+
- [KeyAction](#P-KeybindLib-KeybindRegistry-KeyActionRegisteredTooEarlyException-KeyAction 'KeybindLib.KeybindRegistry.KeyActionRegisteredTooEarlyException.KeyAction')
1517
- [KeyBind](#T-KeybindLib-Bind-KeyBind 'KeybindLib.Bind.KeyBind')
1618
- [#ctor()](#M-KeybindLib-Bind-KeyBind-#ctor-InControl-Key- 'KeybindLib.Bind.KeyBind.#ctor(InControl.Key)')
1719
- [BindDefault()](#M-KeybindLib-Bind-KeyBind-BindDefault-InControl-PlayerAction- 'KeybindLib.Bind.KeyBind.BindDefault(InControl.PlayerAction)')
@@ -157,6 +159,24 @@ Event handler.
157159
- [KeybindLib.Keybind.KeyPressed](#E-KeybindLib-Keybind-KeyPressed 'KeybindLib.Keybind.KeyPressed')
158160
- [KeybindLib.Keybind.KeyReleased](#E-KeybindLib-Keybind-KeyReleased 'KeybindLib.Keybind.KeyReleased')
159161

162+
<a name='T-KeybindLib-KeybindRegistry-KeyActionRegisteredTooEarlyException'></a>
163+
## KeyActionRegisteredTooEarlyException `type`
164+
165+
##### Namespace
166+
167+
KeybindLib.KeybindRegistry
168+
169+
##### Summary
170+
171+
An exception thrown when a [KeyAction](#T-KeybindLib-Keybind-KeyAction 'KeybindLib.Keybind.KeyAction') is registered before this mod has been PreLoaded.
172+
173+
<a name='P-KeybindLib-KeybindRegistry-KeyActionRegisteredTooEarlyException-KeyAction'></a>
174+
### KeyAction `property`
175+
176+
##### Summary
177+
178+
The [KeyAction](#P-KeybindLib-KeybindRegistry-KeyActionRegisteredTooEarlyException-KeyAction 'KeybindLib.KeybindRegistry.KeyActionRegisteredTooEarlyException.KeyAction') that was registered too early.
179+
160180
<a name='T-KeybindLib-Bind-KeyBind'></a>
161181
## KeyBind `type`
162182

@@ -442,6 +462,16 @@ Registers a [KeyAction](#T-KeybindLib-Keybind-KeyAction 'KeybindLib.Keybind.KeyA
442462
| keyAction | [KeybindLib.Keybind.KeyAction](#T-KeybindLib-Keybind-KeyAction 'KeybindLib.Keybind.KeyAction') | The [KeyAction](#T-KeybindLib-Keybind-KeyAction 'KeybindLib.Keybind.KeyAction') to run when the key is pressed. |
443463
| keyReleased | [System.Boolean](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Boolean 'System.Boolean') | If set to true, runs when the key is released instead of when it's pressed. |
444464

465+
##### Exceptions
466+
467+
| Name | Description |
468+
| ---- | ----------- |
469+
| [KeybindLib.KeybindRegistry.KeyActionRegisteredTooEarlyException](#T-KeybindLib-KeybindRegistry-KeyActionRegisteredTooEarlyException 'KeybindLib.KeybindRegistry.KeyActionRegisteredTooEarlyException') | Thrown when this method is called before PreLoad. |
470+
471+
##### Remarks
472+
473+
You cannot register a [KeyAction](#T-KeybindLib-Keybind-KeyAction 'KeybindLib.Keybind.KeyAction') until after the PreLoad step.
474+
445475
<a name='T-KeybindLib-Main'></a>
446476
## Main `type`
447477

0 commit comments

Comments
 (0)