ed/Cog
1
0
Fork 0
mirror of https://github.com/Ed94/Cog.git synced 2026-08-04 06:38:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Arnaud Jamin
2023-10-11 01:33:52 -04:00
committed by GitHub
parent 3c9abe8fc0
commit d47baa3ff7
1 changed files with 9 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+9 -8
View File
@@ -196,8 +196,8 @@ The Cog repository has the following structure:
Cog has multiple plugins to ease the integration for projects that do not use the `Ability System Component` or `Enhanced Input`. For the next steps, it is assumed all the plugins are used. Cog has multiple plugins to ease the integration for projects that do not use the `Ability System Component` or `Enhanced Input`. For the next steps, it is assumed all the plugins are used.
1. Setup up module dependencies:
- Setup up module dependencies:
```c# ```c#
// CogSample.Build.cs // CogSample.Build.cs
using UnrealBuildTool; using UnrealBuildTool;
@@ -238,8 +238,8 @@ public class CogSample : ModuleRules
} }
``` ```
2. In the class of your choice (in the sample we use the GameState class) add a reference to the CogWindowManager:
- In the class of your choice (in the sample we use the GameState class) add a reference to the CogWindowManager:
```cpp ```cpp
// ACogSampleGameState.h // ACogSampleGameState.h
#pragma once #pragma once
@@ -267,8 +267,9 @@ class ACogSampleGameState : public AGameStateBase
#endif //ENABLE_COG #endif //ENABLE_COG
}; };
``` ```
3. Instantiate the CogWindowManager and add some windows:
- Instantiate the CogWindowManager and add some windows:
```cpp ```cpp
// ACogSampleGameState.cpp // ACogSampleGameState.cpp
void ACogSampleGameState::BeginPlay() void ACogSampleGameState::BeginPlay()
@@ -295,18 +296,17 @@ void ACogSampleGameState::BeginPlay()
[...] [...]
#endif //ENABLE_COG #endif //ENABLE_COG
} }
``` ```
3. Define which key will toggle the input from the game to Imgui:
- Define which key will toggle the input from the game to Imgui:
```cpp ```cpp
// ACogSampleGameState.cpp // ACogSampleGameState.cpp
FCogImguiModule::Get().SetToggleInputKey(FCogImGuiKeyInfo(EKeys::Insert)); FCogImguiModule::Get().SetToggleInputKey(FCogImGuiKeyInfo(EKeys::Insert));
``` ```
4. Tick the CogWindowManager:
- Tick the CogWindowManager:
```cpp ```cpp
// ACogSampleGameState.cpp // ACogSampleGameState.cpp
void ACogSampleGameState::Tick(float DeltaSeconds) void ACogSampleGameState::Tick(float DeltaSeconds)
@@ -319,8 +319,8 @@ void ACogSampleGameState::Tick(float DeltaSeconds)
} }
``` ```
6. Implement Cog Interfaces on your desired actor classes:
- Implement Cog Interfaces on your desired actor classes:
```cpp ```cpp
// CogSampleCharacter.h // CogSampleCharacter.h
UCLASS(config=Game) UCLASS(config=Game)
@@ -340,4 +340,5 @@ class ACogSamplePlayerController
, public ICogCommonPossessorInterface , public ICogCommonPossessorInterface
``` ```
7. In Unreal Editor create and configure the Data Assets
- In Unreal Editor create and configure the Data Assets