Files
UNIT3D/config/achievements.php
2024-05-23 13:58:29 +00:00

44 lines
1.7 KiB
PHP

<?php
declare(strict_types=1);
/**
* NOTICE OF LICENSE.
*
* UNIT3D Community Edition is open-sourced software licensed under the GNU Affero General Public License v3.0
* The details is bundled with this project in the file LICENSE.txt.
*
* @project UNIT3D Community Edition
*
* @author HDVinnie <hdinnovations@protonmail.com>
* @license https://www.gnu.org/licenses/agpl-3.0.en.html/ GNU Affero General Public License v3.0
*/
return [
/*
|--------------------------------------------------------------------------
| Locked achievement sync
|--------------------------------------------------------------------------
|
| Controls the behavior of how locked achievements will be handled.
|
| Achievements are only stored on the achievement_progress table whenever
| they are made progress or unlocked. Therefore, by default there is no
| "locked achievement" storage.
|
| When set to FALSE, this will not change how the relationship works.
| achievements() on the Achiever trait WILL NOT RETURN LOCKED ACHIEVEMENTS,
| only returning records on the achievement_progress table. The locked()
| method will act as a simple query fetching all records that exist in
| achievement_details and do not have equivalent records on
| achievement_progress.
|
| When set to TRUE, any calls to the achievements() relationship will first
| fetch locked achievements and then add them to the achievement_progress
| table with progress 0. Therefore, the achievements() relationship WILL
| RETURN LOCKED ACHIEVEMENTS, and the locked() method will act as a derived
| query from achievements().
|
*/
'locked_sync' => true,
];