beu/TrackManiaControl
1
0
Fork 0
Code Issues 7 Pull Requests Releases Wiki Activity

doc update

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

9
core/Callbacks/Structures/ShootMania/Models/Landmark.php
View File

@@ -9,6 +9,7 @@ use ManiaControl\General\UsageInformationTrait;
/**
* Landmark Model
*
* @api
* @author ManiaControl Team <mail@maniacontrol.com>
* @copyright 2014-2017 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
@@ -22,6 +23,7 @@ class Landmark implements UsageInformationAble {
private $position = null;
/**
* @api
* @return string
*/
public function getTag() {
@@ -29,6 +31,7 @@ class Landmark implements UsageInformationAble {
}
/**
* @api
* @param string $tag
*/
public function setTag($tag) {
@@ -36,6 +39,7 @@ class Landmark implements UsageInformationAble {
}
/**
* @api
* @return mixed
*/
public function getOrder() {
@@ -43,6 +47,7 @@ class Landmark implements UsageInformationAble {
}
/**
* @api
* @param mixed $order
*/
public function setOrder($order) {
@@ -50,6 +55,7 @@ class Landmark implements UsageInformationAble {
}
/**
* @api
* @return mixed
*/
public function getId() {
@@ -57,6 +63,7 @@ class Landmark implements UsageInformationAble {
}
/**
* @api
* @param mixed $id
*/
public function setId($id) {
@@ -64,6 +71,7 @@ class Landmark implements UsageInformationAble {
}
/**
* @api
* @return \ManiaControl\Callbacks\Structures\ShootMania\Models\Position
*/
public function getPosition() {
@@ -71,6 +79,7 @@ class Landmark implements UsageInformationAble {
}
/**
* @api
* @param \ManiaControl\Callbacks\Structures\ShootMania\Models\Position $position
*/
public function setPosition(Position $position) {

1
core/Callbacks/Structures/ShootMania/Models/PlayerScore.php
View File

@@ -8,6 +8,7 @@ use ManiaControl\Callbacks\Structures\Common\Models\CommonPlayerScore;
/**
* PlayerScore Model
*
* @api
* @author ManiaControl Team <mail@maniacontrol.com>
* @copyright 2014-2017 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3

7
core/Callbacks/Structures/ShootMania/Models/Position.php
View File

@@ -9,6 +9,7 @@ use ManiaControl\General\UsageInformationTrait;
/**
* Position Model
*
* @api
* @author ManiaControl Team <mail@maniacontrol.com>
* @copyright 2014-2017 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
@@ -21,6 +22,7 @@ class Position implements UsageInformationAble {
private $z = 0;
/**
* @api
* @return int
*/
public function getX() {
@@ -28,6 +30,7 @@ class Position implements UsageInformationAble {
}
/**
* @api
* @param int $x
*/
public function setX($x) {
@@ -35,6 +38,7 @@ class Position implements UsageInformationAble {
}
/**
* @api
* @return int
*/
public function getZ() {
@@ -42,6 +46,7 @@ class Position implements UsageInformationAble {
}
/**
* @api
* @param int $z
*/
public function setZ($z) {
@@ -49,6 +54,7 @@ class Position implements UsageInformationAble {
}
/**
* @api
* @return int
*/
public function getY() {
@@ -56,6 +62,7 @@ class Position implements UsageInformationAble {
}
/**
* @api
* @param int $y
*/
public function setY($y) {

1
core/Callbacks/Structures/ShootMania/Models/TeamScore.php
View File

@@ -7,6 +7,7 @@ use ManiaControl\Callbacks\Structures\Common\Models\CommonTeamScore;
/**
* Shootmania TeamScore Model
*
* @api
* @author ManiaControl Team <mail@maniacontrol.com>
* @copyright 2014-2017 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3

1
core/Callbacks/Structures/ShootMania/Models/Weapons.php
View File

@@ -5,6 +5,7 @@ namespace ManiaControl\Callbacks\Structures\ShootMania\Models;
/**
* Weapons Interface
*
* @api
* @author ManiaControl Team <mail@maniacontrol.com>
* @copyright 2014-2017 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3

13
core/Callbacks/Structures/ShootMania/OnActionCustomEventStructure.php
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
@@ -21,6 +22,12 @@ class OnActionCustomEventStructure extends BaseStructure {
private $param1;
private $param2 = array();
/**
* OnActionCustomEventStructure constructor.
*
* @param \ManiaControl\ManiaControl $maniaControl
* @param $data
*/
public function __construct(ManiaControl $maniaControl, $data) {
parent::__construct($maniaControl, $data);
@@ -37,6 +44,7 @@ class OnActionCustomEventStructure extends BaseStructure {
/**
* Returns Server time when the event occured
*
* @api
* @return int
*/
public function getTime() {
@@ -46,6 +54,7 @@ class OnActionCustomEventStructure extends BaseStructure {
/**
* < Id of the action that triggered the event
*
* @api
* @return string
*/
public function getActionId() {
@@ -55,6 +64,7 @@ class OnActionCustomEventStructure extends BaseStructure {
/**
* < Login of the player who shot if any
*
* @api
* @return \ManiaControl\Players\Player
*/
public function getShooter() {
@@ -64,6 +74,7 @@ class OnActionCustomEventStructure extends BaseStructure {
/**
* < player who got hit if any
*
* @api
* @return \ManiaControl\Players\Player
*/
public function getVictim() {
@@ -73,6 +84,7 @@ class OnActionCustomEventStructure extends BaseStructure {
/**
* < First custom param of the event
*
* @api
* @return string
*/
public function getParam1() {
@@ -82,6 +94,7 @@ class OnActionCustomEventStructure extends BaseStructure {
/**
* < Second custom param of the event
*
* @api
* @return array
*/
public function getParam2() {

12
core/Callbacks/Structures/ShootMania/OnActionEvent.php
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;
}
}

1
core/Callbacks/Structures/ShootMania/OnArmorEmptyStructure.php
View File

@@ -5,6 +5,7 @@ namespace ManiaControl\Callbacks\Structures\ShootMania;
/**
* Structure Class for the OnArmorEmpty 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

10
core/Callbacks/Structures/ShootMania/OnCaptureStructure.php
View File

@@ -12,6 +12,7 @@ use ManiaControl\Players\Player;
/**
* Structure Class for the OnCapture 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
@@ -23,6 +24,12 @@ class OnCaptureStructure extends BaseStructure {
private $playerArray = array();
/**
* OnCaptureStructure constructor.
*
* @param \ManiaControl\ManiaControl $maniaControl
* @param $data
*/
public function __construct(ManiaControl $maniaControl, $data) {
parent::__construct($maniaControl, $data);
@@ -47,6 +54,7 @@ class OnCaptureStructure extends BaseStructure {
/**
* Get the logins as Array
*
* @api
* @return string[]
*/
public function getLoginArray() {
@@ -56,6 +64,7 @@ class OnCaptureStructure extends BaseStructure {
/**
* Get the Players as Player Array
*
* @api
* @return Player[]
*/
public function getPlayerArray() {
@@ -72,6 +81,7 @@ class OnCaptureStructure extends BaseStructure {
/**
* Returns Information about the Captured Landmark
*
* @api
* @return \ManiaControl\Callbacks\Structures\ShootMania\Models\LandMark
*/
public function getLandMark() {

4
core/Callbacks/Structures/ShootMania/OnCommandStructure.php
View File

@@ -9,6 +9,7 @@ use ManiaControl\ManiaControl;
/**
* Structure Class for the OnCommand 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
@@ -29,6 +30,7 @@ class OnCommandStructure extends BaseStructure {
/**
* < Server time when the event occured
*
* @api
* @return int
*/
public function getTime() {
@@ -38,6 +40,7 @@ class OnCommandStructure extends BaseStructure {
/**
* < Name of the command
*
* @api
* @return string
*/
public function getName() {
@@ -51,6 +54,7 @@ class OnCommandStructure extends BaseStructure {
* "real": 123.456,
* "text": "an example value"
*
* @api
* @return mixed
*/
public function getValue() {

9
core/Callbacks/Structures/ShootMania/OnDefaultEventStructure.php
View File

@@ -9,6 +9,7 @@ use ManiaControl\ManiaControl;
/**
* Structure Class for the Default Event 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
@@ -17,6 +18,12 @@ class OnDefaultEventStructure extends BaseStructure {
private $time;
private $type;
/**
* OnDefaultEventStructure constructor.
*
* @param \ManiaControl\ManiaControl $maniaControl
* @param $data
*/
public function __construct(ManiaControl $maniaControl, $data) {
parent::__construct($maniaControl, $data);
@@ -27,6 +34,7 @@ class OnDefaultEventStructure extends BaseStructure {
/**
* Returns Server time when the event occured
*
* @api
* @return int
*/
public function getTime() {
@@ -36,6 +44,7 @@ class OnDefaultEventStructure extends BaseStructure {
/**
* Returns the type of event
*
* @api
* @return string
*/
public function getType() {

1
core/Callbacks/Structures/ShootMania/OnEliteEndTurnStructure.php
View File

@@ -9,6 +9,7 @@ use ManiaControl\ManiaControl;
/**
* Structure Class for the OnEliteEndTurn 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

4
core/Callbacks/Structures/ShootMania/OnEliteStartTurnStructure.php
View File

@@ -9,6 +9,7 @@ use ManiaControl\ManiaControl;
/**
* Structure Class for the OnEliteStartTurn 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
@@ -32,6 +33,7 @@ class OnEliteStartTurnStructure extends BaseStructure {
}
/**
* @api
* @return \ManiaControl\Players\Player
*/
public function getAttacker() {
@@ -41,6 +43,7 @@ class OnEliteStartTurnStructure extends BaseStructure {
/**
* Returns a Login Array of the defenders
*
* @api
* @return array
*/
public function getDefenderLogins() {
@@ -50,6 +53,7 @@ class OnEliteStartTurnStructure extends BaseStructure {
/**
* Gets an Array of the Players
*
* @api
* @return \ManiaControl\Players\Player[]
*/
public function getDefenders() {

9
core/Callbacks/Structures/ShootMania/OnFallDamageStructure.php
View File

@@ -10,6 +10,7 @@ use ManiaControl\Players\Player;
/**
* Structure Class for the OnFallDamage 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
@@ -21,6 +22,12 @@ class OnFallDamageStructure extends BaseStructure {
*/
private $victim;
/**
* OnFallDamageStructure constructor.
*
* @param \ManiaControl\ManiaControl $maniaControl
* @param $data
*/
public function __construct(ManiaControl $maniaControl, $data) {
parent::__construct($maniaControl, $data);
@@ -31,6 +38,7 @@ class OnFallDamageStructure extends BaseStructure {
/**
* < Server time when the event occured
*
* @api
* @return int
*/
public function getTime() {
@@ -40,6 +48,7 @@ class OnFallDamageStructure extends BaseStructure {
/**
* < Player who fell
*
* @api
* @return Player
*/
public function getVictim() {

10
core/Callbacks/Structures/ShootMania/OnHitNearMissArmorEmptyBaseStructure.php
View File

@@ -12,6 +12,7 @@ use ManiaControl\Players\Player;
/**
* Structure Base Class for the OnHit/OnNearMiss/OnArmorEmpty 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
@@ -59,6 +60,7 @@ class OnHitNearMissArmorEmptyBaseStructure extends BaseStructure {
/**
* < Server time when the event occured
*
* @api
* @return int
*/
public function getTime() {
@@ -68,6 +70,7 @@ class OnHitNearMissArmorEmptyBaseStructure extends BaseStructure {
/**
* < Id of the weapon [1-Laser, 2-Rocket, 3-Nucleus, 5-Arrow]
*
* @api
* @see \ManiaControl\Callbacks\Structures\ShootMania\Models\Weapons
* @return int
*/
@@ -78,6 +81,7 @@ class OnHitNearMissArmorEmptyBaseStructure extends BaseStructure {
/**
* < Position of the Shooter at the time
*
* @api
* @return Position
*/
public function getShooterPosition() {
@@ -87,6 +91,7 @@ class OnHitNearMissArmorEmptyBaseStructure extends BaseStructure {
/**
* < Position of the Victim at the time
*
* @api
* @return \ManiaControl\Callbacks\Structures\ShootMania\Models\Position
*/
public function getVictimPosition() {
@@ -96,6 +101,7 @@ class OnHitNearMissArmorEmptyBaseStructure extends BaseStructure {
/**
* < Shooter Player
*
* @api
* @return Player
*/
public function getShooter() {
@@ -105,12 +111,10 @@ class OnHitNearMissArmorEmptyBaseStructure extends BaseStructure {
/**
* < Victim Player
*
* @api
* @return Player
*/
public function getVictim() {
return $this->victim;
}
}

8
core/Callbacks/Structures/ShootMania/OnHitStructure.php
View File

@@ -8,6 +8,7 @@ use ManiaControl\ManiaControl;
/**
* Structure Class for the OnHit 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
@@ -16,6 +17,12 @@ class OnHitStructure extends OnHitNearMissArmorEmptyBaseStructure {
private $damage;
/**
* OnHitStructure constructor.
*
* @param \ManiaControl\ManiaControl $maniaControl
* @param array $data
*/
public function __construct(ManiaControl $maniaControl, array $data) {
parent::__construct($maniaControl, $data);
@@ -25,6 +32,7 @@ class OnHitStructure extends OnHitNearMissArmorEmptyBaseStructure {
/**
* < Amount of Damage done by the hit (only on onHit)
*
* @api
* @return int
*/
public function getDamage() {

1
core/Callbacks/Structures/ShootMania/OnJoustReloadStructure.php
View File

@@ -9,6 +9,7 @@ use ManiaControl\ManiaControl;
/**
* Structure Class for the OnJoustReload 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

3
core/Callbacks/Structures/ShootMania/OnJoustSelectedPlayersStructure.php
View File

@@ -9,6 +9,7 @@ use ManiaControl\ManiaControl;
/**
* Structure Class for the OnJoustSelectedPlayers 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
@@ -32,6 +33,7 @@ class OnJoustSelectedPlayersStructure extends BaseStructure {
/**
* Returns a Login Array of the Players
*
* @api
* @return array
*/
public function getPlayerLogins() {
@@ -41,6 +43,7 @@ class OnJoustSelectedPlayersStructure extends BaseStructure {
/**
* Gets an Array of the Players
*
* @api
* @return \ManiaControl\Players\Player[]
*/
public function getPlayers() {

3
core/Callbacks/Structures/ShootMania/OnNearMissStructure.php
View File

@@ -8,6 +8,7 @@ use ManiaControl\ManiaControl;
/**
* Structure Class for the OnNearMiss 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
@@ -24,6 +25,8 @@ class OnNearMissStructure extends OnHitNearMissArmorEmptyBaseStructure {
/**
* Returns the distance
*
*
* @api
* @return float
*/
public function getDistance() {

14
core/Callbacks/Structures/ShootMania/OnPlayerObjectStructure.php
View File

@@ -9,6 +9,7 @@ use ManiaControl\ManiaControl;
/**
* Structure Class for the OnPlayerTouchesObject 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
@@ -20,6 +21,12 @@ class OnPlayerObjectStructure extends BaseStructure {
private $modelId;
private $modelName;
/**
* OnPlayerObjectStructure constructor.
*
* @param \ManiaControl\ManiaControl $maniaControl
* @param $data
*/
public function __construct(ManiaControl $maniaControl, $data) {
parent::__construct($maniaControl, $data);
@@ -34,6 +41,7 @@ class OnPlayerObjectStructure extends BaseStructure {
/**
* Returns Server time when the event occured
*
* @api
* @return int
*/
public function getTime() {
@@ -43,6 +51,7 @@ class OnPlayerObjectStructure extends BaseStructure {
/**
* < Login of the player who touched the object
*
* @api
* @return \ManiaControl\Players\Player
*/
public function getPlayer() {
@@ -52,6 +61,7 @@ class OnPlayerObjectStructure extends BaseStructure {
/**
* < The id of the object
*
* @api
* @return string
*/
public function getObjectId() {
@@ -61,6 +71,7 @@ class OnPlayerObjectStructure extends BaseStructure {
/**
* < The id of the object model
*
* @api
* @return string
*/
public function getModelId() {
@@ -70,11 +81,10 @@ class OnPlayerObjectStructure extends BaseStructure {
/**
* < The name of the object model
*
* @api
* @return string
*/
public function getModelName() {
return $this->modelName;
}
}

12
core/Callbacks/Structures/ShootMania/OnPlayerRequestActionChange.php
View File

@@ -9,6 +9,7 @@ use ManiaControl\ManiaControl;
/**
* Structure Class for the OnPlayerRequestActionChange 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 OnPlayerRequestActionChange extends BaseStructure {
private $player;
private $actionChange;
/**
* OnPlayerRequestActionChange constructor.
*
* @param \ManiaControl\ManiaControl $maniaControl
* @param $data
*/
public function __construct(ManiaControl $maniaControl, $data) {
parent::__construct($maniaControl, $data);
@@ -30,6 +37,7 @@ class OnPlayerRequestActionChange extends BaseStructure {
/**
* Returns Server time when the event occured
*
* @api
* @return int
*/
public function getTime() {
@@ -39,6 +47,7 @@ class OnPlayerRequestActionChange extends BaseStructure {
/**
* < player who requested a new action
*
* @api
* @return \ManiaControl\Players\Player
*/
public function getPlayer() {
@@ -48,11 +57,10 @@ class OnPlayerRequestActionChange extends BaseStructure {
/**
* < Can be -1 (request previous action) or 1 (request next action)
*
* @api
* @return string
*/
public function getActionChange() {
return $this->actionChange;
}
}

9
core/Callbacks/Structures/ShootMania/OnPlayerRequestRespawnStructure.php
View File

@@ -10,6 +10,7 @@ use ManiaControl\Players\Player;
/**
* Structure Class for the OnPlayerRequestRespawnStructure 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
@@ -21,6 +22,12 @@ class OnPlayerRequestRespawnStructure extends BaseStructure {
*/
private $player;
/**
* OnPlayerRequestRespawnStructure constructor.
*
* @param \ManiaControl\ManiaControl $maniaControl
* @param $data
*/
public function __construct(ManiaControl $maniaControl, $data) {
parent::__construct($maniaControl, $data);
@@ -32,6 +39,7 @@ class OnPlayerRequestRespawnStructure extends BaseStructure {
/**
* Returns the Time the Event Happened
*
* @api
* @return int
*/
public function getTime() {
@@ -41,6 +49,7 @@ class OnPlayerRequestRespawnStructure extends BaseStructure {
/**
* Gets the Player
*
* @api
* @return \ManiaControl\Players\Player
*/
public function getPlayer() {

11
core/Callbacks/Structures/ShootMania/OnPlayerTriggersSectorStructure.php
View File

@@ -9,6 +9,7 @@ use ManiaControl\ManiaControl;
/**
* Structure Class for the OnPlayerTriggersSector 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,7 +19,12 @@ class OnPlayerTriggersSectorStructure extends BaseStructure {
private $player;
private $sectorId;
/**
* OnPlayerTriggersSectorStructure constructor.
*
* @param \ManiaControl\ManiaControl $maniaControl
* @param $data
*/
public function __construct(ManiaControl $maniaControl, $data) {
parent::__construct($maniaControl, $data);
@@ -31,6 +37,7 @@ class OnPlayerTriggersSectorStructure extends BaseStructure {
/**
* Returns Server time when the event occured
*
* @api
* @return int
*/
public function getTime() {
@@ -40,6 +47,7 @@ class OnPlayerTriggersSectorStructure extends BaseStructure {
/**
* < player who touched the object
*
* @api
* @return \ManiaControl\Players\Player
*/
public function getPlayer() {
@@ -49,6 +57,7 @@ class OnPlayerTriggersSectorStructure extends BaseStructure {
/**
* < Id of the triggered sector
*
* @api
* @return string
*/
public function getSectorId() {

2
core/Callbacks/Structures/ShootMania/OnRoyalPointsStructure.php
View File

@@ -9,6 +9,7 @@ use ManiaControl\ManiaControl;
/**
* Structure Class for the OnRoyalPoints 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
@@ -56,6 +57,7 @@ class OnRoyalPointsStructure extends BaseStructure {
/**
* Gets the number of points scored
*
* @api
* @return int
*/
public function getPoints() {

8
core/Callbacks/Structures/ShootMania/OnScoresStructure.php
View File

@@ -11,13 +11,19 @@ use ManiaControl\ManiaControl;
/**
* Structure Class for the Shootmania OnScores 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
*/
class OnScoresStructure extends CommonScoresStructure {
/**
* OnScoresStructure constructor.
*
* @param \ManiaControl\ManiaControl $maniaControl
* @param $data
*/
public function __construct(ManiaControl $maniaControl, $data) {
parent::__construct($maniaControl, $data);

1
core/Callbacks/Structures/ShootMania/OnShootStructure.php
View File

@@ -10,6 +10,7 @@ use ManiaControl\Players\Player;
/**
* Structure Class for the OnShoot 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

11
core/Callbacks/Structures/ShootMania/OnShotDenyStructure.php
View File

@@ -10,6 +10,7 @@ use ManiaControl\ManiaControl;
/**
* Structure Class for the OnShotDeny 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
@@ -43,6 +44,7 @@ class OnShotDenyStructure extends BaseStructure {
/**
* ServerTime The Event Happened //TODO add Trait for the Time Property
*
* @api
* @return int
*/
public function getTime() {
@@ -53,6 +55,7 @@ class OnShotDenyStructure extends BaseStructure {
/**
* Gets the Shooter Player
*
* @api
* @return \ManiaControl\Players\Player
*/
public function getShooter() {
@@ -62,6 +65,7 @@ class OnShotDenyStructure extends BaseStructure {
/**
* Gets the Victim Player
*
* @api
* @return \ManiaControl\Players\Player
*/
public function getVictim() {
@@ -69,7 +73,11 @@ class OnShotDenyStructure extends BaseStructure {
}
/**
* @return mixed
* Gets the Shooter Weapon
*
* @api
* @see \ManiaControl\Callbacks\Structures\ShootMania\Models\Weapons
* @return int Weapon
*/
public function getShooterWeapon() {
return $this->shooterWeapon;
@@ -78,6 +86,7 @@ class OnShotDenyStructure extends BaseStructure {
/**
* Get the Victim Weapon
*
* @api
* @see \ManiaControl\Callbacks\Structures\ShootMania\Models\Weapons
* @return int
*/