Skip to content

Commit

Permalink
Fix documents.
Browse files Browse the repository at this point in the history
  • Loading branch information
eviltwo committed Mar 4, 2024
1 parent c26cf5a commit d25b9ef
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 9 deletions.
2 changes: 1 addition & 1 deletion src/ActionGameCore/Assets/Interactions/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Changelog

## [0.1.0] - 2024-03-04
## [0.4.0] - 2024-03-04
### Added
- Add intaract system, event and button.
33 changes: 26 additions & 7 deletions src/ActionGameCore/Assets/Interactions/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,31 @@
# Interactions
カメラの中心にあるオブジェクトをプレイヤーが操作できるようにします。(例:電気のスイッチや棚の引き出し)
このパッケージは、カメラの中心にあるオブジェクトを検知し、プレイヤーが操作できるようにします。(例:電気のスイッチや棚の引き出し)

新InputSystemのみ対応。
また、オブジェクトを見た時に"Eキーで開ける"などの文字を出せる仕組みも実装予定です。


# 注意
新InputSystemに対応しており、旧InputManagerは未対応です。

# インポート
UPMを使用して必要なパッケージをインポートできます。
1. InputSystemパッケージをインポートします。
1. このInteractionsパッケージをインポートします。
```
https://github.com/eviltwo/ActionGameCore.git?path=src/ActionGameCore/Assets/Interactions
```

# 初期設定
1. InputActionAssetを作成し、その中に"Interact"というActionを作ります。
1. Main Cameraオブジェクトに `EyePhysicsRaycaster` コンポーネントをアタッチします。
1. メニューの"GameObject > UI > EventSystem"を選びます。(シーンにEventSystemオブジェクトが生成されます。)
1. EventSystemオブジェクトに `InteractSystem` コンポーネントをアタッチします。
- Raycasterの値に先ほどの `EyePhysicsRaycaster` をアサインしてください。

- キーボードの"E"キーを割り当てます。
1. メニューの"GameObject > Create Empty"で空オブジェクトを作成し、 `InteractRaycaster``InteractSystem` コンポーネントをアタッチします。
1. `InteractSystem` のInteractActionReferencesに"Interact"を設定します。

# 3Dボタン
1. CubeなどのColliderが付いているオブジェクトを作成し、 `Button3D` コンポーネントをアタッチします。
- InteractEventに任意の関数を設定します。
- 例えば、CubeのGameObjectのSetActiveを設定します。
1. ゲームを再生し、Cubeを見ながら"E"を押します。Cubeが消えるなど意図通りの関数が実行されたら完了です。

# Change log
[CHANGELOG.md](CHANGELOG.md)
2 changes: 1 addition & 1 deletion src/ActionGameCore/Assets/Interactions/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "com.eviltwo.interactions",
"displayName": "Interactions",
"version": "0.1.0",
"version": "0.4.0",
"unity": "2022.3",
"description": "Eye interaction for 3D objects.",
"author": {
Expand Down

0 comments on commit d25b9ef

Please sign in to comment.