doc update

This commit is contained in:
kremsy
2017-04-07 23:26:35 +02:00
parent 782d8b50e8
commit fa4c16e659
47 changed files with 360 additions and 183 deletions

View File

@ -9,6 +9,7 @@ use ManiaControl\ManiaControl;
/**
* Structure Class for the OnCustomEvent Structure Callback
*
* @api
* @author ManiaControl Team <mail@maniacontrol.com>
* @copyright 2014-2017 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
@ -18,6 +19,12 @@ class OnActionEvent extends BaseStructure {
private $player;
private $actionInput;
/**
* OnActionEvent constructor.
*
* @param \ManiaControl\ManiaControl $maniaControl
* @param $data
*/
public function __construct(ManiaControl $maniaControl, $data) {
parent::__construct($maniaControl, $data);
@ -30,6 +37,7 @@ class OnActionEvent extends BaseStructure {
/**
* Returns Server time when the event occured
*
* @api
* @return int
*/
public function getTime() {
@ -39,6 +47,7 @@ class OnActionEvent extends BaseStructure {
/**
* < player who triggered the action
*
* @api
* @return \ManiaControl\Players\Player
*/
public function getPlayer() {
@ -48,11 +57,10 @@ class OnActionEvent extends BaseStructure {
/**
* < The input pressed to trigger the action
*
* @api
* @return string
*/
public function getActionInput() {
return $this->actionInput;
}
}