08cad46cfc
improved phpdoc
42 lines
822 B
PHP
42 lines
822 B
PHP
<?php
|
|
|
|
namespace ManiaControl\Configurators;
|
|
|
|
use FML\Script\Script;
|
|
use ManiaControl\Players\Player;
|
|
|
|
/**
|
|
* Interface for Configurator Menus
|
|
*
|
|
* @author steeffeen & kremsy
|
|
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
|
|
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
|
|
*/
|
|
interface ConfiguratorMenu {
|
|
|
|
/**
|
|
* Get the Menu Title
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getTitle();
|
|
|
|
/**
|
|
* Get the Configurator Menu Frame
|
|
*
|
|
* @param float $width
|
|
* @param float $height
|
|
* @param Script $script
|
|
* @return \FML\Controls\Frame
|
|
*/
|
|
public function getMenu($width, $height, Script $script);
|
|
|
|
/**
|
|
* Save the Config Data
|
|
*
|
|
* @param array $configData
|
|
* @param Player $player
|
|
*/
|
|
public function saveConfigData(array $configData, Player $player);
|
|
}
|