TrackManiaControl/core/Callbacks/Structures/TrackMania/OnCommandStructure.php

59 lines
1.3 KiB
PHP
Raw Normal View History

2017-03-25 20:19:45 +01:00
<?php
namespace ManiaControl\Callbacks\Structures\TrackMania;
use ManiaControl\Callbacks\Structures\Common\BaseStructure;
2017-04-13 19:14:23 +02:00
use ManiaControl\Callbacks\Structures\Common\BaseTimeStructure;
2017-03-25 20:19:45 +01:00
use ManiaControl\ManiaControl;
2017-04-07 23:26:35 +02:00
//TODO make a common structure between shootmania and this and extend it
2017-03-25 20:19:45 +01:00
/**
* Structure Class for the OnCommand Structure Callback
*
2017-04-07 23:26:35 +02:00
* @api
2017-03-25 20:19:45 +01:00
* @author ManiaControl Team <mail@maniacontrol.com>
* @copyright 2014-2017 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
2017-04-13 19:14:23 +02:00
class OnCommandStructure extends BaseTimeStructure {
private $name;
private $value;
2017-03-25 20:19:45 +01:00
2017-04-07 23:26:35 +02:00
/**
* OnCommandStructure constructor.
*
* @param \ManiaControl\ManiaControl $maniaControl
* @param $data
*/
2017-03-25 20:19:45 +01:00
public function __construct(ManiaControl $maniaControl, $data) {
parent::__construct($maniaControl, $data);
$this->name = $this->getPlainJsonObject()->name;
$this->value = $this->getPlainJsonObject()->value;
}
/**
* < Name of the command
*
2017-04-07 23:26:35 +02:00
* @api
* @return string
2017-03-25 20:19:45 +01:00
*/
public function getName() {
return $this->name;
}
/**
* < The value passed by the command
* "boolean": true,
* "integer": 123,
* "real": 123.456,
* "text": "an example value"
*
2017-04-07 23:26:35 +02:00
* @api
* @return mixed
2017-03-25 20:19:45 +01:00
*/
public function getValue() {
return $this->value;
}
}