src/player/GameMode.php

<?php
 
/*
 *
 *  ____            _        _   __  __ _                  __  __ ____
 * |  _ \ ___   ___| | _____| |_|  \/  (_)_ __   ___      |  \/  |  _ \
 * | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
 * |  __/ (_) | (__|   <  __/ |_| |  | | | | | |  __/_____| |  | |  __/
 * |_|   \___/ \___|_|\_\___|\__|_|  |_|_|_| |_|\___|     |_|  |_|_|
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * @author PocketMine Team
 * @link http://www.pocketmine.net/
 *
 *
 */
 
declare(strict_types=1);
 
namespace pocketmine\player;
 
use pocketmine\lang\KnownTranslationFactory;
use pocketmine\lang\Translatable;
use pocketmine\utils\LegacyEnumShimTrait;
use function mb_strtolower;
use function spl_object_id;
 
enum GameMode{
    use LegacyEnumShimTrait;
 
    case SURVIVAL;
    case CREATIVE;
    case ADVENTURE;
    case SPECTATOR;
 
    public static function fromString(string $str) : ?self{
        static $aliasMap = null;
 
        if($aliasMap === null){
            $aliasMap = [];
            foreach(self::cases() as $case){
                foreach($case->getAliases() as $alias){
                    $aliasMap[$alias] = $case;
                }
            }
        }
 
        return $aliasMap[mb_strtolower($str)] ?? null;
    }
 
    private function getMetadata() : array{
        static $cache = [];
 
        return $cache[spl_object_id($this)] ??= match($this){
            self::SURVIVAL => ["Survival", KnownTranslationFactory::gameMode_survival(), ["survival", "s", "0"]],
            self::CREATIVE => ["Creative", KnownTranslationFactory::gameMode_creative(), ["creative", "c", "1"]],
            self::ADVENTURE => ["Adventure", KnownTranslationFactory::gameMode_adventure(), ["adventure", "a", "2"]],
            self::SPECTATOR => ["Spectator", KnownTranslationFactory::gameMode_spectator(), ["spectator", "v", "view", "3"]]
        };
    }
 
    public function getEnglishName() : string{
        return $this->getMetadata()[0];
    }
 
    public function getTranslatableName() : Translatable{
        return $this->getMetadata()[1];
    }
 
    public function getAliases() : array{
        return $this->getMetadata()[2];
    }
 
    //TODO: ability sets per gamemode
}