-
Notifications
You must be signed in to change notification settings - Fork 4
Achievements System
Note: A typical game, at the time of writing the code guideline will see a bunch of achievement popups for the first 30-35 seconds. This is because the time condition for each achievement has been reduced. Relevant Files:
- AchievementsDisplay.java: Responsible for displays the achievement UI popups on the screen.
/* Listen to achievement events*/
entity.getEvents().addListener("updateAchievement", this::updateAchievementsUI);
/**
* Renders the current achievement notification on the table
*
* @param achievement Configuration with properties and conditions for corresponding achievement
*/
private void renderAchievement(BaseAchievementConfig achievement) {
CharSequence text = achievement.message;
achievementLabel = new Label(text, skin, "small");
achievementImg = new Image(ServiceLocator.getResourceService()
.getAsset(achievement.iconPath, Texture.class));
table.add(achievementImg).size(300f, 150f);
table.row();
table.add(achievementLabel);
}
- AchievementStatsComponent.java: Responsible for dispatching updateAchievement calls to the achievement display file. Keeps track of the game time, and listens to events from the AchievementsHelper. Based on the payload of events, it validates all the achievements. (done per frame) since there are many variables at play.
@Override
public void create() {
super.create();
AchievementsHelper.getInstance().getEvents()
.addListener(AchievementsHelper.HEALTH_EVENT, this::setHealth);
AchievementsHelper.getInstance().getEvents()
.addListener(AchievementsHelper.ITEM_PICKED_UP_EVENT, this::setItemCount);
}
- AchievementsHelper.java: Tracks important events like item pickup, health updates etc across the game.
- AchievementFactory.java: Responsible for inflating an arraylist of achievements with the condition and other properties
- AchievementsConfig.java: Gets inflated by the "achievement" property of "achieve.json"
- BaseAchievementConfig.java: Represents each item of the "achievements" array in "achieve.json"
- ConditionConfig.java: Gets inflated by the "condition" property of "achieve.json"
- achieve.json: Houses an array of achievements with relevant names and conditions.
- AsyncTaskQueue.java: For dispatching sequential long running tasks (Each achievement popup has to be rendered for 5 seconds)
/**
* Achievement UI updates are guaranteed to execute sequentially,
* and no more than one update will be active at any given time
*
* @param achievement Configuration with properties and conditions for corresponding achievement
*/
private void updateAchievementsUI(BaseAchievementConfig achievement) {
/* Queue expensive task to run on a separate single thread
* to run asynchronously. */
AsyncTaskQueue.enqueueTask(() -> {
try {
/* Render achievement card */
renderAchievement(achievement);
/* Wait for some time */
Thread.sleep(RENDER_DURATION);
/* Remove card from screen */
table.clear();
} catch (InterruptedException ignored) {
} catch (Exception e) {
e.printStackTrace();
}
});
}
@Override
public void dispose() {
super.dispose();
/* If the in game screen is out of focus, cancel all future tasks. This has to be
* done in order to prevent memory leaks, unforeseen exceptions and
* other nasty bugs.*/
AsyncTaskQueue.cancelFutureTasksNow();
// ...
}
For displaying achievement popups and pushing long running rendering tasks.
Camera Angle and The Player's Perspective
Achievements Trophies and Cards
πΎ Obstacle/Enemy
βMonster Manual
βObstacles/Enemies
ββ- Alien Plants
ββ- Variation thorns
ββ- Falling Meteorites
ββ- FaceHugger
ββ- AlienMonkey
βSpaceship & Map Entry
βParticle effect
[code for debuff animations](code for debuff animations)
Main Character Movement, Interactions and Animations - Code Guidelines
ItemBar & Recycle system
πΎ Obstacle/Enemy
βObstacle/Enemy
βMonster Manual
βSpaceship Boss
βParticle effects
βOther Related Code
βUML & Sequence diagram of enemies/obstacles
Scoring System Implementation Explanation
Buff and Debuff Implementation
Infinite generating terrains Implementation Explanation
Game Over Screen and functions explaination
Buffer timer before game start
Rocks and woods layout optimization
Magma and nails code implementation
Guide: Adding Background music for a particular screen
History Scoreboard - Score Details
Listening for important events in the Achievements ecosystem
Hunger and Thirst icon code guidelines
Hunger and Thirst User Testing
Buff and Debuff Manual User Testing
The New Button User Test in Setting Page
The Main Menu Buttons User Testing
Infinite loop game and Terrain Testing
https://github.com/UQdeco2800/2021-ext-studio-2.wiki.git
πΎ Obstacle/Enemy
βObstacle testing
ββ- Alien Plants & Variation Thorns
ββ- Falling Meteorites
βEnemy testing
ββ- Alien Monkeys & Facehugger
ββ- Spaceship Boss
βMonster Manual
βParticle-effect
βPlayer attack testing
ββ- Player Attack
Sprint 1
Sprint 2
Sprint 3
Sprint 4
Changeable background & Buffer time testing
Game over screen test sprint 4
New terrain textures on bonus map test sprint 4
Achievements System, Game Records and Unlockable Chapters
Musics Implementation Testing plan