docs: rebuild Input API content
This commit is contained in:
@@ -1,31 +1,32 @@
|
||||
# InputManager::GetButtonUp
|
||||
|
||||
获取相关状态或对象。
|
||||
查询一个具名逻辑按钮当前是否处于抬起状态。
|
||||
|
||||
```cpp
|
||||
bool GetButtonUp(const Containers::String& buttonName) const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Input/InputManager.h`,当前页面用于固定 `InputManager` 类目录下的方法级 canonical 路径。
|
||||
## 行为说明
|
||||
|
||||
**参数:**
|
||||
- `buttonName` - 参数语义详见头文件声明。
|
||||
如果按钮名已注册,当前实现会对映射后的键调用 `IsKeyUp()`。如果按钮名未注册,当前实现直接返回 `true`。
|
||||
|
||||
**返回:** `bool` - 返回值语义详见头文件声明。
|
||||
这个“未注册也算 Up”是当前行为,不一定符合所有上层代码的直觉。
|
||||
|
||||
**示例:**
|
||||
## 参数
|
||||
|
||||
- `buttonName` - 逻辑按钮名称。
|
||||
|
||||
## 返回值
|
||||
|
||||
- `bool` - 当前是否处于抬起状态;未注册按钮也会返回 `true`。
|
||||
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Input/InputManager.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Input::InputManager object;
|
||||
// 根据上下文补齐参数后调用 InputManager::GetButtonUp(...)。
|
||||
(void)object;
|
||||
}
|
||||
bool released = XCEngine::Input::InputManager::Get().GetButtonUp("Jump");
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](InputManager.md)
|
||||
- [返回模块目录](../Input.md)
|
||||
- [返回类型总览](InputManager.md)
|
||||
- [GetButton](GetButton.md)
|
||||
|
||||
Reference in New Issue
Block a user