You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+57-19Lines changed: 57 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,9 +37,9 @@ ___
37
37
- Player Character and Non Player Character class examples
38
38
- Effect samples (Damage, armor buff/debuff, fire armor/damage, bleed status ...)
39
39
- Turn-Based GAS Example
40
+
- RogueLite Toolbox Plugin
40
41
___
41
-
42
-
####Check out the**[Unreal Source Discord](https://discord.gg/unrealsource)** if you have any questions!
42
+
Check out the**[Unreal Source Discord](https://discord.gg/unrealsource)** if you have any questions!
43
43
---
44
44
##Features
45
45
###Native gameplay tags
@@ -260,9 +260,14 @@ The controller will be listening to those updates from the ActiveEffect Event se
260
260
___
261
261
###Turn-Based GAS Example
262
262
This system extends the Gameplay Ability System (GAS) to support turn-based mechanics, allowing effects like damage-over-time, delayed healing, or stat buffs/debuffs that activate/expire/tick across multiple turns.
263
-
(Developed by Steve :Mushroom: and Light)
263
+
(Developed by Steve (optimisor) and Light (light04) from UnrealSource)
264
+

265
+
266
+
####Message from EvilHippo
267
+
_Special thanks to Light for making the prototype for Steve, and Steve for going through it and accepting publishing his work on this project!
268
+
Pretty sure this will come VERY handy for the various GAS users._
264
269
265
-
Setup Steps:
270
+
####Setup Steps:
266
271
1. Implement the Turn System Interface
267
272
- Add`TurnSystemInterface.h` to your`GameState` class, this is required to manage the "Turn" (see`TurnExampleGameStateBase.h` for reference).
268
273
2. Integrate Turn-Based Components
@@ -272,34 +277,50 @@ Setup Steps:
272
277
4. Configure Turn Logic
273
278
- Open your Turn-Based GameplayEffect Blueprint and adjust settings under`Components -> Turn Based Support` (examples:`GE_Turn_Based_Double_Heal`,`GE_Turn_Based_Fire_DoT`,`GE_Turn_Based_Fire_Resistance_Buff`).
| Inhibition Delay Turns| Turns until the effect activates (0 = instant).|
286
+
| Duration Turns| Turns until the effect expires*after activation* (0 = expires immediately).|
287
+
| GE To Apply On Uninhibition| Optional GE triggered when the effect activates.|
288
+
| GE To Apply On Removal| Optional GE triggered when the effect expires.|
289
+
| Enable Periodic GE| If enabled, applies a GE every turn*after activation*.|
290
+
| GE To Apply Periodically| GE to trigger each turn (e.g., damage-over-time).|
291
+
| Limit Periodic Applications| Restrict how many times the periodic GE is applied.|
292
+
| Max Periodic Applications| Max triggers for the periodic GE.|
293
+
294
+
####Key Notes
290
295
- Turn-Based GEs are**always infinite** – their lifespan is controlled by`Duration Turns`.
291
296
-**Modifiers are optional**: Leave them empty if no buff/debuff stat change is needed.
292
297
293
-
TLDR
298
+
####TLDR
294
299
1. Inherit`TurnBasedGameplayEffect` in a Blueprint.
295
300
2. Configure`Turn Based Support` settings:
296
301
- Set activation delay (`Inhibition Delay Turns`) and duration (`Duration Turns`).
297
302
- Add optional GEs for activation, expiry, or periodic effects (e.g., DoT).
298
303
3. Effects auto-manage turn tracking – just call`Increment Turn` in your game loop.
299
304
305
+
####HUD
306
+
307
+

308
+
309
+
Adding the`Custom UI Component` will automatically show the gameplay effects on the HUD with tue Turn number on top:
310
+
- (X): Inhibition turns
311
+
- X: Turn remaining
300
312
___
301
313
##ChangeLog:
302
-
###2025/02/15 (Steve :Mushroom:):
314
+
###2025/02/16 (EvilHippo):
315
+
```
316
+
- Now can be shown as "Active effect like others"
317
+
- Inhibited effect from the start will trigger showing the effect icon (especially for Turn based effects)
318
+
- New Icons
319
+
- Refactor of some methods / new delegate to listen to turn changes
320
+
- Turn changes are now replicated to all clients.
321
+
- Changing turn by pressing T instead of clicking a button
322
+
```
323
+
###2025/02/15 (Steve :Mushroom: / Light):
303
324
```
304
325
- Added Turn-Based functionality for GAS via C++ classes (TurnSystemInterface.h, TurnExampleGameStateBase.h, TurnBasedGameplayEffectComponent.h, TurnBasedGameplayEffect.h)
305
326
- Added 3 Turn-Based Examples
@@ -309,7 +330,24 @@ ___
309
330
- Added Increment Turn button + Turn Counter to UI
310
331
- Enabled `Show Mouse Cursor` (required to be able to click the Increment Turn button)
311
332
```
333
+
###2025/02/13 (EvilHippo):
334
+
```
335
+
First version of the new Custom RogueLite Toolbox (CRL)
336
+
- New Map
337
+
- New effects
338
+
- AGR Pro integrated for Melee damage
339
+
- Base abilities (Punch / Dash)
340
+
- Damage handling wth Backstab
341
+
- New Attribute set
342
+
- New TargetFinder to streamline Sphere (or other) traces using tag requirements (and more)
343
+
344
+
CRL fixes
312
345
346
+
- Now GA can register modifiers (from Attacker only for now)