GFInputAction¶
API Reference / Standard / 类索引
- 路径:
addons/gf/standard/input/mapping/gf_input_action.gd - 模块:
Standard - 继承:
Resource - API:
public - 类别:资源定义 (
resource_definition) - 首次版本:
3.17.0
资源化输入动作描述。 只描述“项目想要读取的抽象动作”,不绑定具体按键、设备或玩法逻辑。
成员概览¶
| 类型 | 名称 | 签名 |
|---|---|---|
| 枚举 | ValueType |
enum ValueType |
| 属性 | action_id |
var action_id: StringName = &"" |
| 属性 | display_name |
var display_name: String = "" |
| 属性 | display_category |
var display_category: String = "" |
| 属性 | value_type |
var value_type: ValueType = ValueType.BOOL |
| 属性 | remappable |
var remappable: bool = true |
| 属性 | block_lower_priority_actions |
var block_lower_priority_actions: bool = true |
| 属性 | activation_threshold |
var activation_threshold: float = 0.5 |
| 方法 | get_display_name |
func get_display_name() -> String: |
| 方法 | get_action_id |
func get_action_id() -> StringName: |
枚举¶
ValueType¶
- API:
public
enum ValueType { ## 开关型动作,例如确认、跳跃、攻击。 BOOL, ## 一维轴动作,例如水平移动或缩放。 AXIS_1D, ## 二维轴动作,例如移动方向、瞄准方向。 AXIS_2D, ## 三维轴动作,例如飞行移动、自由相机或六自由度控制。 AXIS_3D, }
动作输出值类型。
属性¶
action_id¶
- API:
public
动作稳定标识。建议使用不会随本地化变化的 snake_case 名称。
display_name¶
- API:
public
显示名称,供设置界面或输入提示使用。
display_category¶
- API:
public
显示分类,供设置界面分组使用。
value_type¶
- API:
public
动作输出值类型。
remappable¶
- API:
public
是否允许玩家在项目层重绑定。
block_lower_priority_actions¶
- API:
public
同一输入事件命中多个动作时,较高优先级动作是否阻止低优先级动作。
activation_threshold¶
- API:
public
判断轴动作是否活跃的阈值。
方法¶
get_display_name¶
- API:
public
获取可显示名称。
返回:显示名称;为空时回退到动作标识或资源文件名。
get_action_id¶
- API:
public
获取稳定动作标识。
返回:动作标识;未显式设置时尝试使用资源路径。