TrackManiaControl/application/core/Callbacks/Callbacks.php

58 lines
2.5 KiB
PHP
Raw Normal View History

2014-04-24 17:41:05 +02:00
<?php
namespace ManiaControl\Callbacks;
2014-05-02 17:50:30 +02:00
2014-04-24 23:11:09 +02:00
//TODO method class for all the libxmlrpc get Methods, to fetch the callback asnyc
2014-04-24 17:41:05 +02:00
/**
* Callbacks Interface
*
2014-05-02 17:50:30 +02:00
* @author ManiaControl Team <mail@maniacontrol.com>
* @copyright 2014 ManiaControl Team
2014-04-24 17:41:05 +02:00
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
interface Callbacks {
2014-04-24 23:11:09 +02:00
//Common Callbacks
2014-04-24 21:55:47 +02:00
const SCRIPTCALLBACK = 'Callbacks.ScriptCallback';
/** BeginMatch Callback, param1 MatchNumber */
const BEGINMATCH = "Callbacks.BeginMatch";
/** LoadingMap Callback, Number of Map */
const LOADINGMAP = "Callbacks.LoadingMap";
/** BeginMap Callback, triggered by MapManager, param1 Map Object */
const BEGINMAP = "Callbacks.BeginMap";
/** BeginSubMatch Callback, param1 Number of Submatch */
const BEGINSUBMATCH = "Callbacks.BeginSubmatch";
/** BeginRound Callback, param1 Number of Round */
const BEGINROUND = "Callbacks.BeginRound";
/** BeginTurn Callback, param1 Number of Turn */
const BEGINTURN = "Callbacks.BeginTurn";
/** EndTurn Callback, param1 Number of Turn */
const ENDTURN = "Callbacks.EndTurn";
/** EndRound Callback, param1 Number of Round */
const ENDROUND = "Callbacks.EndRound";
/** EndSubMatch Callback, param1 Number of Submatch */
const ENDSUBMATCH = "Callbacks.EndSubmatch";
/** BeginMap Callback, triggered by MapManager, param1 Map Object */
const ENDMAP = "Callbacks.EndMap";
/** EndMatch Callback, param1 MatchNumber */
const ENDMATCH = "Callbacks.EndMatch";
/** BeginWarmup Callback, no parameters */
const BEGINWARMUP = "Callbacks.BeginWarmUp";
/** EndWarmup Callback, no parameters */
const ENDWARMUP = "Callbacks.EndWarmUp";
2014-04-24 23:11:09 +02:00
/** PlayerRanking callback, returned after LibXmlRpc_PlayerRanking
* try to avoid to use this, just use the Get function of the RankingsManager instead
* param1 Player $player
* param2 int $rank
* param3 int $currentPoints
* param4 int AFKStatus */
const PLAYERRANKING = 'Callbacks.PlayerRanking';
//ShootMania Callbacks
2014-04-24 23:11:09 +02:00
/** RankingsUpdated Callback, param1 Sorted Rankings */
const RANKINGSUPDATED = 'Callbacks.RankingsUpdated';
/** RankingsUpdated Callback, returned after LibXmlRpc_PlayerRanking param1 Scores */
const SCORES = 'Callbacks.Scores';
/** Returns the AFKStatus of an Player, returned after param1 Scores */ //returned after TODO
const AFKSTATUS = 'Callbacks.AfkStatus';
/** Returns if the GameMode has Warmup activated, returned after param1 Scores */ //returned after TODO
2014-04-24 23:11:09 +02:00
const WARMUPSTATUS = 'Callbacks.WarmupStatus';
2014-04-24 17:41:05 +02:00
}