Status Effects
Status effects are entities which can be collected by the player and may trigger some kind of environmental or movement effect on the player. Available status effects are outlines in the com.deco2800.game.effects.StatusEffect enum, but are summarized below:
| Effect Name | Duration (Seconds) | Is Debuff | Details |
|---|---|---|---|
| BOMB | 4 | true | Obscures the player screen (not yet implemented) |
| JUMP | 6 | false | Increases jump height |
| FAST | 4 | false | Increases player speed |
| SLOW | 4 | true | Decreases player speed |
| STUCK | 2 | true | Stops the player |
| TIME_STOP | 2 | false | Stops the void |
A series of methods and Components make these status effects work. On a high level, the spawnStatusEffect(StatusEffect, x, y) method in LevelGameArea can be used to spawn any status effect on the map. In the future, these effects will be able to be saved/loaded from the level file.
The StatusEffectController component is used for triggering status effects on players which collide with the entity, it listens for "collisionStart" events and if collided by an entity with an associated StatusEffectTargetComponent, it will trigger a StatusEffectTrigger event with the StatusEffect as an argument. It will automatically "dispose" of itself by ignoring future contacts.
The StatusEffectTargetComponent is associated with entities which can receive status effects. This component listens for StatusEffectTrigger events and when it receives one, triggers the appropriate effect on the entity or environment.
Currently this component is designed only to work with the player as it relies on other player-specific components, however if desired this component could be adapted to work with any entity.
The StatusEffectUIComponent also listens for StatusEffectTrigger events. When an event is triggered, it will create a spiral countdown clearly showing the time remaining on the effect.
Again, this component could easily be applied to other entities if necessary in future development.
A class diagram is provided below.
