# component_tool

**Repository Path**: godothub/component_tool

## Basic Information

- **Project Name**: component_tool
- **Description**: Godot引擎组件化插件，将代码拆分为高内聚、低耦合的逻辑块。
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-12-16
- **Last Updated**: 2026-01-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ComponentTool 插件 v1.0.1

ComponentTool是一款Godot引擎的插件，用于将代码组件化，将它们拆分为更加聚合的逻辑块。通过组件化的方式，可以提高代码的复用性、可维护性和可扩展性。

## 功能特性

- ✅ 创建和管理组件
- ✅ 组件启用/禁用控制
- ✅ 基于模板生成组件代码
- ✅ 支持自定义组件类型
- ✅ 可视化组件管理界面

## 安装方法

1. 将`component_tool`文件夹复制到Godot项目的`addons`目录下
2. 在Godot编辑器中，打开"项目设置" > "插件"
3. 找到"ComponentTool"并启用它

## 使用方法

### 创建组件

1. 在编辑器中选择一个节点
2. 点击组件工具面板中的"创建组件"按钮
3. 选择宿主类型和组件位置，下方地址栏根据用户选择的目录位置更新最终生成位置
4. 输入组件名称和代码，下方将自动生成代码预览
5. 点击"创建"按钮生成组件文件，组件将为你保存组件脚本文件，创建子节点并挂载脚本
6. 完善脚本逻辑

### 管理组件

1. 在编辑器中选择一个节点
2. 组件工具面板会显示该节点的所有组件
3. 使用复选框启用或禁用组件

### 完善组件逻辑

创建的组件会自动继承自`Component`基类，包含以下功能：

- `comp_enable`: 控制组件是否启用
- `component_host`: 宿主节点引用
- `component_name`: 组件名称

组件类需要实现以下方法：

- `_enable()`: 组件启用时调用，已经在模板中默认实现
- `_disable()`: 组件禁用时调用

## 示例

以下是一个简单的移动组件示例，大部分代码已经自动生成，你需要完成最关键的组件功能逻辑。
可以注意到 character_body_2d 标明了宿主类型，这样可以可以获得更好的类型提示。

```gdscript
class_name CharacterBody2DMovementComponent
extends Component
# 获得更好的类型提示而不必手动转换类型
var character_body_2d: CharacterBody2D
# 暴露组件属性供外部调整
@export var speed: float = 1000

func _enable():
	character_body_2d = component_host
	component_name = "CharacterBody2DMovementComponent"
	pass

func _disable():
	pass

func _physics_process(delta: float) -> void:
	if not comp_enable:
		return
	# 组件具体逻辑
	var input_dir: Vector2 = Input.get_vector("ui_left", "ui_right", "ui_up", "ui_down")
	character_body_2d.velocity = input_dir * speed
	character_body_2d.move_and_slide()

```

## 项目结构

```
addons/component_tool/
├── component_tool.gd      # 插件主入口
├── core/                 # 核心代码
│   ├── component.gd      # 组件基类
│   ├── component_tool_manager.gd  # 组件管理器
│   └── component_util.gd # 工具函数
├── template/             # 模板文件
│   └── component_template.txt  # 组件模板
└── ui/                   # UI界面
	├── comp_center.gd    # 主界面控制器
	├── comp_item.gd      # 组件项控制器
	└── create_component.gd  # 创建组件界面控制器
```

## 添加自定义模板

用户可以在`template`目录下添加自己的模板文件，文件名可以自定义，但是需要保持`.txt`扩展名。
在创建组件时，用户可以选择自己添加的模板文件，插件会根据用户选择的模板文件生成组件代码。

目前可以替换的模板变量：
- `<ComponentName>`: 组件名称
- `<HostName>`: 宿主类型名称(蛇形命名)
- `<HostType>`: 宿主类型名称(驼峰命名)



## 未来计划

- [完成] 计划在创建组建时可以选择模板，这样户可以添加自己的模板文件，使其更加适用于各种不同的项目。
- [TODO] 支持添加自定义的模板变量，用户可以在模板中添加自己的占位符，插件会根据用户输入的组件名称和宿主类型名称替换模板中的占位符。



## 开发者

- 作者: Smalldy
- 邮箱: [743682730@qq.com]

## 许可证

MIT License