Methods summary
public
|
#
onPlayerConnect( string $login, boolean $isSpectator )
Method called when a Player join the server
Method called when a Player join the server
Parameters
- $login
string $login
- $isSpectator
boolean $isSpectator
Implementation of
|
public
|
#
onPlayerDisconnect( string $login )
Method called when a Player quit the server
Method called when a Player quit the server
Parameters
Implementation of
|
public
|
#
onPlayerChat( integer $playerUid, string $login, string $text, boolean $isRegistredCmd )
Method called when a Player chat on the server
Method called when a Player chat on the server
Parameters
- $playerUid
integer $playerUid
- $login
string $login
- $text
string $text
- $isRegistredCmd
boolean $isRegistredCmd
Implementation of
|
public
|
#
onPlayerManialinkPageAnswer( integer $playerUid, string $login, integer $answer, array $entries )
Method called when a Answer to a Manialink Page difference with previous TM:
this is not called if the player doesn't answer, and thus '0' is also a valid
answer.
Method called when a Answer to a Manialink Page difference with previous TM:
this is not called if the player doesn't answer, and thus '0' is also a valid
answer.
Parameters
- $playerUid
integer $playerUid
- $login
string $login
- $answer
integer $answer
- $entries
Implementation of
|
public
|
#
onEcho( string $internal, string $public )
Method called when the dedicated Method Echo is called
Method called when the dedicated Method Echo is called
Parameters
- $internal
string $internal
- $public
string $public
Implementation of
|
public
|
#
onServerStart( )
Method called when the server starts
Method called when the server starts
Implementation of
|
public
|
#
onServerStop( )
Method called when the server stops
Method called when the server stops
Implementation of
|
public
|
#
onBeginMatch( )
Method called when the Race Begin
Method called when the Race Begin
Implementation of
|
public
|
#
onEndMatch( SPlayerRanking[] $rankings, integer|SMapInfo $winnerTeamOrMap )
Method called when the Race Ended struct of SPlayerRanking is a part of the
structure of DedicatedApi\Structures\Player object struct SPlayerRanking {
string Login; string NickName; int PlayerId; int Rank; [for legacy TrackMania
modes also: int BestTime; int[] BestCheckpoints; int Score; int NbrLapsFinished;
double LadderScore; ] }
Method called when the Race Ended struct of SPlayerRanking is a part of the
structure of DedicatedApi\Structures\Player object struct SPlayerRanking {
string Login; string NickName; int PlayerId; int Rank; [for legacy TrackMania
modes also: int BestTime; int[] BestCheckpoints; int Score; int NbrLapsFinished;
double LadderScore; ] }
Parameters
- $rankings
SPlayerRanking[] $rankings
- $winnerTeamOrMap
integer|SMapInfo $winnerTeamOrMap Winner team if API version >= 2012-06-19, else the map
Implementation of
|
public
|
#
onBeginMap( SMapInfo $map, boolean $warmUp, boolean $matchContinuation )
Method called when a map begin
Method called when a map begin
Parameters
- $map
SMapInfo $map
- $warmUp
boolean $warmUp
- $matchContinuation
boolean $matchContinuation
Implementation of
|
public
|
#
onEndMap( SPlayerRanking[] $rankings, SMapInfo $map, boolean $wasWarmUp, boolean $matchContinuesOnNextMap, boolean $restartMap )
Method called when a map end
Method called when a map end
Parameters
- $rankings
SPlayerRanking[] $rankings
- $map
SMapInfo $map
- $wasWarmUp
boolean $wasWarmUp
- $matchContinuesOnNextMap
boolean $matchContinuesOnNextMap
- $restartMap
boolean $restartMap
Implementation of
|
public
|
#
onBeginRound( )
Method called on Round beginning
Method called on Round beginning
Implementation of
|
public
|
#
onEndRound( )
Method called on Round ending
Method called on Round ending
Implementation of
|
public
|
#
onStatusChanged( integer $statusCode, string $statusName )
Method called when the server status change
Method called when the server status change
Parameters
- $statusCode
integer StatusCode
- $statusName
string StatsName
Implementation of
|
public
|
#
onPlayerCheckpoint( integer $playerUid, string $login, integer $timeOrScore, integer $curLap, integer $checkpointIndex )
Method called when a player cross a checkPoint
Method called when a player cross a checkPoint
Parameters
- $playerUid
integer $playerUid
- $login
string $login
- $timeOrScore
integer $timeOrScore
- $curLap
integer $curLap
- $checkpointIndex
integer $checkpointIndex
Implementation of
|
public
|
#
onPlayerFinish( integer $playerUid, string $login, integer $timeOrScore )
Method called when a player finish a round
Method called when a player finish a round
Parameters
- $playerUid
integer $playerUid
- $login
string $login
- $timeOrScore
integer $timeOrScore
Implementation of
|
public
|
#
onPlayerIncoherence( integer $playerUid, string $login )
Method called when there is an incoherence with a player data
Method called when there is an incoherence with a player data
Parameters
- $playerUid
integer $playerUid
- $login
string $login
Implementation of
|
public
|
#
onBillUpdated( integer $billId, integer $state, string $stateName, integer $transactionId )
Method called when a bill is updated
Method called when a bill is updated
Parameters
- $billId
integer $billId
- $state
integer $state
- $stateName
string $stateName
- $transactionId
integer $transactionId
Implementation of
|
public
|
#
onTunnelDataReceived( integer $playerUid, string $login, base64 $data )
Method called server receive data
Method called server receive data
Parameters
- $playerUid
integer $playerUid
- $login
string $login
- $data
base64 $data
Implementation of
|
public
|
#
onMapListModified( integer $curMapIndex, integer $nextMapIndex, boolean $isListModified )
Method called when the map list is modified
Method called when the map list is modified
Parameters
- $curMapIndex
integer $curMapIndex
- $nextMapIndex
integer $nextMapIndex
- $isListModified
boolean $isListModified
Implementation of
|
public
|
#
onPlayerInfoChanged( SPlayerInfo $playerInfo )
Method called when player info changed
Method called when player info changed
Parameters
- $playerInfo
SPlayerInfo $playerInfo
Implementation of
|
public
|
#
onManualFlowControlTransition( string $transition )
Method called when the Flow Control is manual
Method called when the Flow Control is manual
Parameters
- $transition
string $transition
Implementation of
|
public
|
#
onVoteUpdated( string $stateName, string $login, string $cmdName, string $cmdParam )
Method called when a vote change of State
Method called when a vote change of State
Parameters
- $stateName
string $stateName can be NewVote, VoteCancelled, votePassed, voteFailed
- $login
string $login the login of the player who start the vote if empty the server start the
vote
- $cmdName
string $cmdName the command used for the vote
- $cmdParam
string $cmdParam the parameters of the vote
Implementation of
|
public
|
#
onModeScriptCallback( string $param1, string $param2 )
Parameters
- $param1
string
- $param2
string
Implementation of
|