Skip to content

Types List

Jump to bottom
lythx edited this page Apr 6, 2023 · 32 revisions

Controller Types

Map

Controller map object

  • string id: Map UID
  • string name: Map name
  • string fileName: Map file location (Relative to GameData/Tracks directory)
  • string author: Map author login
  • Environment environment: Map environment ('Stadium', 'Island', etc.)
  • Mood mood: Map mood ('Sunrise', 'Night', etc.)
  • number bronzeTime: Bronze medal time
  • number silverTime: Silver medal time
  • number goldTime: Gold medal time
  • number authorTime: Author medal time
  • number copperPrice: Coppers "price" of the map
  • boolean isLapRace: Whether the map is multilap
  • Date addDate: Date on which the map got added to the controller database
  • boolean isNadeo: Whether the map is made by Nadeo
  • boolean isClassic: Whether the map is an TMX classic
  • number voteCount: Amount of karma votes for the map
  • number voteRatio: Map karma vote ratio (0 to 100)
  • number defaultLapsAmount Default amount of laps (different amounts can be set using server call) (undefined if the map was never played)
  • number checkpointsPerLap Amount of checkpoints per lap (undefined if the map was never played)
  • number leaderboardRating: Map TMX leaderboard rating (undefined if the map was never fetched from TMX)
  • number awards: Map TMX awards (undefined if the map was never fetched from TMX)

Player

Controller online player object

  • number id: Player server ID (assigned by the dedicated server when the player connects). Ranges from 0 to 250, inclusive (0 is the server account).
  • string login: Player login
  • string nickname: Player nickname
  • string country: Player country ('France', 'Poland', etc.)
  • string countryCode: 3 letter country code ('POL', 'FRA', etc.)
  • string region: Player region eg. Russia|Moscow, Serbia|Beograd
  • number timePlayed: Player total playtime (doesn't include current session)
  • number joinTimestamp: Player server join timestamp
  • Checkpoint[] currentCheckpoints: Current player checkpoint times
  • number visits: Player server visit count
  • string ip: Player ip address
  • boolean isUnited: Whether player account is United
  • number ladderPoints: Player ladder points
  • number ladderRank: Player ladder rank
  • Date lastOnline: Player last leave date (undefined if the player never visited the server before)
  • string title: Player title ('Player', 'Admin', etc.)
  • number wins: Player wins count
  • number privilege: Player privilege level
  • boolean isSpectator: Whether the player is in the spectator mode
  • boolean isTemporarySpectator: Whether the player is in spectator mode temporarily (eg. result screen, inbetween rounds)
  • boolean isPureSpectator: True if the player is in non-temporary spectator mode and has a player slot
  • boolean hasPlayerSlot: Whether the player has a player slot (player slot is needed to switch to player mode, it's automatically assigned if the server is not full)
  • number rank: Player server rank (undefined if the player doesn't have any record)
  • number average: Player average server map rank
  • enum['red', 'blue'] team: Player team (Teams mode only)
  • number roundsPoints: Player rounds points sum (Cup and Rounds mode only)
  • number[] roundTimes: Player round finish times (Cup, Rounds and Teams mode only) (-1 if the player didn't finish the round)
  • number cupPosition: Player cup winner position (Cup mode only)
  • boolean isCupFinalist: Whether the player is a cup finalist (Cup mode only) (Winners are not finalists)

OfflinePlayer

Controller offline player object

  • string login: Player login
  • string nickname: Player nickname
  • string country: Player country ('France', 'Poland', etc.)
  • string countryCode: 3 letter country code ('POL', 'FRA', etc.)
  • string region: Player region eg. Russia|Moscow, Serbia|Beograd
  • number timePlayed: Player total playtime (doesn't include current session)
  • number visits: Player server visit count
  • boolean isUnited: Whether player account is United
  • number wins: Player wins count
  • number privilege: Player privilege level
  • Date lastOnline: Player last leave date (undefined if the player never visited the server before)
  • number rank: Player server rank (undefined if the player doesn't have any record)
  • number average: Player average server map rank

CallParams

Trackmania dedicated server call parameters

Call

Trackmania dedicated server call object

  • string method: Dedicated server method name
  • CallParams[] params?: Call parameters

Command

Controller command object

  • string[] aliases: Aliases that can be used to call the command in the chat
  • string help: Short command description
  • params: Command parameters
    • string name: Parameter name
    • CommandParameterType type: Parameter type
    • (string | number)[] validValues: If set only the given values will be considered valid
    • boolean optional: Whether the parameter is optional
  • Function callback: Callback function to execute on command call
  • number privilege: Player privilege required to call the command

BanlistEntry

Controller ban object

  • string ip: Banned player ip
  • string login: Banned player login
  • string | undefined nickname: Banned player nickname (undefined if the player is not in the database)
  • Date date: Date of the ban
  • string callerLogin: Login of the admin who banned the player
  • string callerNickname: Nickname of the admin who banned the player
  • string | undefined reason: Ban reason (undefined if wasn't specified)
  • Date | undefined expireDate: Ban expire date (undefined if wasn't specified)

BlacklistEntry

Controller blacklist object

  • string login: Blacklisted player login
  • string | undefined nickname: Blacklisted player nickname (undefined if the player is not in the database)
  • Date date: Date on which the player got blacklisted
  • string callerLogin: Login of the admin who blacklisted the player
  • string callerNickname: Nickname of the admin who blacklisted the player
  • string | undefined reason: Blacklist reason (undefined if wasn't specified)
  • Date | undefined expireDate: Blacklist expire date (undefined if wasn't specified)

MutelistEntry

Controller mute object

  • string login: Muted player login
  • string | undefined nickname: Muted player nickname (undefined if the player is not in the database)
  • Date date: Date of the mute
  • string callerLogin: Login of the admin who muted the player
  • string callerNickname: Nickname of the admin who muted the player
  • string | undefined reason: Mute reason (undefined if wasn't specified)
  • Date | undefined expireDate: Mute expire date (undefined if wasn't specified)

GuestlistEntry

Controller guest object

  • string login: Guest login
  • string | undefined nickname: Guest nickname (undefined if the player is not in the database)
  • Date date: Date on which the guest got added
  • string callerLogin: Login of the admin who added the guest
  • string callerNickname: Nickname of the admin who added the guest

Checkpoint

Controller checkpoint object

  • number index: Checkpoint index
  • number time: Checkpoint time
  • number lap: Checkpoint lap
  • number lapCheckpointTime: Checkpoint time in the current lap (Multilap maps only)
  • number lapCheckpointIndex: Checkpoint index in the current lap (Multilap maps only)
  • boolean isLapFinish: Whether the checkpoint is a finish (Multilap maps only) (Actual race finish is not counted as a checkpoint)

Message

Controller chat message object

  • string login: Player login
  • string nickname: Player login
  • string text: Message text
  • Date date: Message date

Record

Controller player record object

  • string map: Map UID
  • string login: Player login
  • number time: Finish time
  • Date date: Record date
  • number[] checkpoints: Checkpoint times
  • string nickname: Player nickname

Vote

Controller karma map vote object

  • string mapId: Map UID
  • string login: Player login
  • enum[-3, -2, -1, 1, 2, 3] vote: Vote value
  • Date date: Vote date

TMXMap

TMX map object

  • string id: Map UID
  • number TMXId: Map TMX ID
  • string name: Map name
  • number authorId: Map author TMX ID
  • string author: Map author login
  • Date uploadDate: Date on which the map was uploaded to TMX
  • Date lastUpdateDate: Date on which the current version of the map was uploaded to TMX
  • string type: TMX map type ('Race', 'Stunts', etc.)
  • Environment environment: Map environment ('Stadium', 'Island', etc.)
  • Mood mood: Map mood ('Sunrise, 'Night', etc.)
  • string style: Map TMX style (eg. Full Speed, LOL)
  • string routes: Map TMX routes (Single, Multi, Symmetrical)
  • string length: Map TMX length, determined by the map author time eg. 1m30s etc.
  • TMXDifficulty difficulty: Map TMX difficulty ('Beginner', 'Expert', etc.)
  • number leaderboardRating: Map TMX leaderboard rating
  • string game: Map TMX game, the version of the game the map was built in, eg. TMUF, TMNF etc.
  • string comment: Map TMX comment
  • number commentsAmount: Number of TMX player comments for the map
  • number awards: Map TMX awards count
  • string pageUrl: Map TMX page url
  • string screenshotUrl: Map TMX screenshot url
  • string thumbnailUrl: Map TMX thumbnail url
  • string downloadUrl: Map file download url
  • boolean isClassic: Whether the map is an TMX classic
  • boolean isNadeo: Whether the map is made by Nadeo
  • TMXReplay[] replays: Map TMX replays (includes replays from previous versions of the map)
  • TMXReplay[] validReplays: Map TMX valid replays (only ones driven on current version of the map)

TMXReplay

TMX replay object

  • number id: TMX replay ID
  • number userId: Player TMX ID
  • string name: Player TMX name
  • number time: Finish time
  • Date recordDate: Record date
  • Date mapDate: Date on which the map version the replay was driven on was uploaded to TMX
  • any approved: Somehow related to puzzle replays
  • number leaderboardScore: Replay TMX leaderobard score
  • any expires: Somehow related to puzzle replays
  • any lockspan: Replay lock period after upload (puzzle maps only)
  • string url: Replay file download url

TMXSearchResult

TMX map search result object

  • string id: Map UID
  • number TMXId: Map TMX ID
  • string name: Map name
  • number authorId: Map author TMX ID
  • string author: Map author login
  • Date uploadDate: Date on which the map was uploaded to TMX
  • Date lastUpdateDate: Date on which the current version of the map was uploaded to TMX
  • string type: TMX map type ('Race', 'Stunts', etc.)
  • Environment environment: Map environment ('Stadium', 'Island', etc.)
  • Mood mood: Map mood ('Sunrise, 'Night', etc.)
  • string style: Map TMX style (eg. Full Speed, LOL)
  • string routes: Map TMX routes (Single, Multi, Symmetrical)
  • string length: Map TMX length, determined by the map author time eg. 1m30s etc.
  • TMXDifficulty difficulty: Map TMX difficulty ('Beginner', 'Expert', etc.)
  • string game: Map TMX game, the version of the game the map was built in, eg. TMUF, TMNF etc.
  • string comment: Map TMX comment
  • number commentsAmount: Number of TMX player comments for the map
  • number awards: Map TMX awards count
  • string pageUrl: Map TMX page url
  • string screenshotUrl: Map TMX screenshot url
  • string thumbnailUrl: Map TMX thumbnail url
  • string downloadUrl: Map file download url
  • number bronzeTime: Bronze medal time
  • number silverTime: Silver medal time
  • number goldTime: Gold medal time
  • number authorTime: Author medal time
  • string car: Map vehicle

ServerInfo

Server information object

  • string name: The server name
  • string comment: The server comment
  • string password: The server player password
  • string passwordForSpectator: The server spectator password
  • number currentMaxPlayers: Current round max players amount
  • number nextMaxPlayers: Next round max players amount
  • number currentMaxSpectators: Current round max spectators amount
  • number nextMaxSpectators: Next round max spectators amount
  • boolean isP2PUpload: Whether peer-to-peer upload is enabled
  • boolean isP2PDownload: Whether peer-to-peer download is enabled
  • number currentLadderMode: Current round ladder mode (1 = Enabled, 0 = Disabled)
  • number nextLadderMode: Next round ladder mode (1 = Enabled, 0 = Disabled)
  • number currentVehicleNetQuality: Current round vehicle quality (1 = Good, 0 = Bad)
  • number nextVehicleNetQuality: Next round vehicle quality (1 = Good, 0 = Bad)
  • number currentCallVoteTimeOut: Current round callvote timeout time
  • number nextCallVoteTimeOut: Next round callvote timeout time
  • number callVoteRatio: Current callvote ratio
  • boolean allowMapDownload: Whether map downloads are enabled
  • boolean autoSaveReplays: Whether replay autosaving is enabled
  • string login: The server account login
  • number id: The server account ID, always 0
  • string zone: The server account zone (region)
  • string ipAddress: The server public IP address
  • boolean isUnited: Whether the server account is paid (has the key specified in config)
  • string game: Dedicated server game version (for TMF, this is always TmForever)
  • string version: Dedicated server executable version (for TMF, the latest version is v2011-02-21)
  • string build: Dedicated server executable build (for TMF, the latest build is 2.11.26)

BillUpdatedInfo

Object containing Trackmania coppers bill state information. Created and emitted on the BillUpdated event

  • number id: Bill ID
  • number state: Bill state ID
  • string stateName: Bill state name
  • number transactionId: Transaction ID

InfoChangedInfo

Object containing player state information. Created and emitted on the PlayerInfoChanged event

  • string login: Player login
  • string nickname: Player nickname
  • number id: Player server ID (assigned by the dedicated server when the
  • number teamId: Possibly leftover from earlier versions? Usually undefined or 0.
  • number ladderRanking: Player ladder rank
  • number forceSpectator: Player forcespec mode (0 - not forced, 1 - forcespec, 2 - forceplay)
  • boolean isReferee: Whether the player
  • boolean isPodiumReady: Might be cup mode related
  • boolean isUsingStereoscopy: Whether the player is using 3D mode
  • boolean isManagedByOtherServer: Related to relay servers, unsupported
  • boolean isServer: Whether the player is ... the server ..?
  • boolean hasPlayerSlot: Whether the player has a reserved player slot
  • boolean isSpectator: Whether the player is a spectator
  • boolean isTemporarySpectator: Whether the player is in spectator mode temporarily (eg. result screen, inbetween rounds)
  • boolean isPureSpectator: True if the player is in non-temporary spectator mode and has a player slot
  • boolean autoTarget: Whether the player has autotarget enabled in spec-mode
  • number currentTargetId: Identifier of the player currently being watched by the spectator

PrivilegeChangedInfo

Object containing player controller privilege information. Created and emitted on the PrivilegeChange event

  • OfflinePlayer player: Player object (undefined if the player is not in the database)
  • string login: Player login
  • number newPrivilege: New player privilege level
  • number previousPrivilege: Previous player privilege level
  • caller: Object containing information about player who changed the privilege (undefined if not specified)
    • string, login: Caller player login
    • string nickname: Caller player nickname

KarmaVoteInfo

Object containing map karma vote information. Created and emitted on the KarmaVote event

  • string mapId: Map UID
  • string login: Player login
  • enum[-3, -2, -1, 1, 2, 3] vote: Vote value
  • Date date: Vote date

Listener

Controller event listener object

  • (keyof Events) | (keyof Events)[] event: Event name or an array of event names
  • Function callback: Callback function to execute on the event

GameInfo

Game information object

  • number gameMode: Current server gamemode (Rounds (0), TimeAttack (1), Team (2), Laps (3), Stunts (4), Cup (5))
  • number resultTime: Amount of time (in msec) to be spent at scoretable
  • number mapIndex: Index of the currently played map
  • enum['new', 'old'] roundsPointSystemType: Points system type used in Rounds mode. The controller always uses a custom point system, with "old" limit
  • number roundsPointLimitOld: Amount of points to end the map in rounds mode when using the "old" point system type. The controller always uses a custom point system, with "old" limit
  • number roundsPointLimitNew: Amount of points to end the map in rounds mode when using the "new" point system type. The controller always uses a custom point system, with "old" limit
  • number roundsModeLapsAmount: Amount of forced laps in Rounds mode
  • number timeAttackLimit: Amount of time (in msec) to be spent in race
  • number countdownAdditionalTime: Amount of time (in msec) to be added to the start countdown
  • enum['new', 'old'] teamPointSystemType: Points system type used in Rounds mode. The controller always uses a custom point system, with "new" limit
  • number teamPointLimitOld: Amount of points to end the map in teams mode when using the "old" point system type. The controller always uses the "new" point system
  • number teamPointLimitNew: Amount of points to end the map in teams mode when using the "new" point system type. The controller always uses the "new" point system
  • number teamMaxPoints: Maximum amount of points that a team can get in one round when using the "old" point system. The controller always uses the "new" point system
  • number lapsModeLapsAmount: Amount of laps in Laps mode
  • number lapsModeTimeLimit: Laps mode time limit (no time limit if set to 0)
  • number finishTimeout: Amount of time left for players to finish the track after the leader in rounds-based gamemodes
  • number warmUpDuration: Duration of the warm-up in Rounds mode
  • boolean disableRespawn: Whether disabled respawning on checkpoints is active
  • boolean forceShowOpponents: Whether force display of all opponents is enabled
  • number cupPointsLimit: Amount of points to become a finalist in Cup mode
  • number cupRoundsPerMap: Amount of times the map will be replayed until skip in Cup mode
  • number cupWinnersAmount: Amount of winners in Cup mode
  • number cupWarmUpDuration: Warm-up rounds count in Cup mode

PlayerDataUpdatedInfo

Object containing player information. Created and emitted on the PlayerDataUpdated event

  • string, login: Player login
  • string, nickname: Player nickname (undefined if wasn't changed)
  • string, title: Player controller title ('Player', 'Admin', etc.) (undefined if wasn't changed)
  • country: Object containing player country information (undefined if wasn't changed)
    • string name: Player country ('France', 'Poland', etc.)
    • string code: 3 letter country code ('POL', 'FRA', etc.)
    • string region: Player region eg. Russia|Moscow, Serbia|Beograd

TrackmaniaMapInfo

Map object received from certain dedicated server callbacks and methods

  • string Uid: Map UID
  • string Name: Map name
  • string FileName: Map file location (Relative to GameData/Tracks directory)
  • string Author: Map author login
  • string Environnement: Map environment ('Stadium', 'Island', etc.)
  • string Mood: Map mood ('Sunrise, 'Night', etc.)
  • number BronzeTime: Bronze medal time
  • number SilverTime: Silver medal time
  • number GoldTime: Gold medal time
  • number AuthorTime: Author medal time
  • number CopperPrice: Coppers "price" of the map
  • boolean LapRace: Whether the map is multilap
  • number NbLaps: Amount of laps (certain methods (eg. GetChallengeInfo, GetNextChallengeInfo) return -1 here for some reason)
  • number NbCheckpoints: Amount of checkpoints (certain methods (eg. GetChallengeInfo, GetNextChallengeInfo) return -1 here for some reason)

TrackmaniaRankingInfo

Ranking object received from EndChallenge and EndRace dedicated server callbacks

  • string Login: Player login
  • string NickName: Player nickname
  • number PlayerId:
  • number Rank: Rank on the last race
  • number BestTime: Player best finish time
  • number[] BestCheckpoints: Player checkpoints in the best run
  • number Score: Probably stunts mode related
  • number NbrLapsFinished: Amount of finished laps
  • number LadderScore: Player ladderpoints amount

TrackmaniaPlayerInfo

Player object received from certain dedicated server callbacks and methods

  • string Login: Player login
  • string NickName: Player nickname
  • number PlayerId:
  • number TeamId: Possibly leftover from earlier versions? Usually undefined or 0.
  • number SpectatorStatus: Integer representing the player spectator status .
  • number LadderRanking: Player ladder ranking
  • number Flags: Integer representing player status (forceSpectator + isReferee * 10 + isPodiumReady * 100 + isUsingStereoscopy * 1000 + isManagedByAnOtherServer * 10000 + isServer * 100000 + hasPlayerSlot * 1000000).
  • readonly [string, string, string, string] "TrackMania.VoteUpdated": Object containing event names and types that get passed as parameters

Events

Object containing event names and types that get passed as parameters

  • enum['result', 'race'] Startup
  • ServerState ServerStateChanged
  • MessageInfo PlayerChat
  • JoinInfo PlayerJoin
  • LeaveInfo PlayerLeave
  • RecordInfo LocalRecord
  • FinishInfo PlayerFinish
  • FinishInfo LiveRecord
  • InfoChangedInfo PlayerInfoChanged
  • ManialinkClickInfo ManialinkClick
  • CheckpointInfo PlayerCheckpoint
  • BeginMapInfo BeginMap
  • EndMapInfo EndMap
  • KarmaVoteInfo[] KarmaVote
  • Record[] RecordsPrefetch
  • Vote[] Votes Prefetch
  • MapAddedInfo MapAdded
  • MapRemovedInfo MapRemoved
  • BillUpdatedInfo BillUpdated
  • Map[] MatchSettingsUpdated
  • PrivilegeChangedInfo PrivilegeChanged
  • Record[] LocalRecordsRemoved
  • Map[] JukeboxChanged
  • { login: string, average: number }[] RanksAndAveragesUpdated
  • BanlistEntry Ban
  • BanlistEntry Unban
  • BlacklistEntry Blacklist
  • BlacklistEntry Unblacklist
  • MutelistEntry Mute
  • MutelistEntry Unmute
  • GuestlistEntry AddGuest
  • GuestlistEntry RemoveGuest
  • PlayerDataUpdatedInfo[] PlayerDataUpdated
  • enum['enabled', 'disabled'] DynamicTimerStateChanged
  • FinishInfo[] BeginRound
  • FinishInfo[] EndRound
  • Game GameConfigChanged
  • ServerInfo ServerConfigChanged
  • LapFinishInfo PlayerLap
  • LapRecordInfo LapRecord
  • [string, boolean] TrackMania.PlayerConnect
  • string TrackMania.PlayerDisconnect
  • [number, string, string, boolean] TrackMania.PlayerChat
  • [number, string, number, number, number] TrackMania.PlayerCheckpoint
  • [number, string, number] Trackmania.PlayerFinish
  • TrackmaniaMapInfo TrackMania.BeginRace
  • [TrackmaniaRankingInfo[], TrackmaniaMapInfo] TrackMania.EndRace
  • void TrackMania.BeginRound
  • void TrackMania.EndRound
  • [TrackmaniaMapInfo, bolean, boolean] TrackMania.BeginChallenge
  • [TrackmaniaRankingInfo[], TrackmaniaMapInfo, boolean, boolean, boolean] TrackMania.EndChallenge
  • [number, string] TrackMania.StatusChanged
  • [number, string, number] TrackMania.PlayerManialinkPageAnswer
  • [number, number, string, number] TrackMania.BillUpdated
  • [number, number, boolean] TrackMania.ChallengeListModified
  • TrackmaniaPlayerInfo TrackMania.PlayerInfoChanged
  • [number, string] TrackMania.PlayerIncoherence
  • [string, string] TrackMania.Echo
  • [string, string, string, string TrackMania.VoteUpdated

JoinInfo

Object containing player information. Created and emitted on the PlayerJoin event
Omit<Player, 'currentCheckpoints'>

EndMapInfo

Object containing map information. Created and emitted on the EndMap event
CurrentMap &

  • LocalRecord[] localRecords: Map local records
  • FinishInfo[] liveRecords: Map live records
  • boolean wasWarmUp: Whether the last round played was a warm-up
  • boolean continuesOnNextMap: Whether the point amounts from the last map will be preserved (Cup mode only)
  • string winnerLogin: Login of the winner
  • number winnerWins: Amount of wins of the winner
  • boolean isRestart: Whether the map was restarted using dedicated server call
  • TrackmaniaRankingInfo[] serverSideRankings: Server side ranking objects. (Can differ from controller rankings only if it was restarted during the map)
  • droppedMap: If keep queue after leave is set to false, this is the object that stores the dropped map
    • Map map - This is the exact copy of the JukeboxMap interface off of MapService
    • string callerLogin - Login of the player who juked the map

BeginMapInfo

Object containing map information. Created and emitted on the BeginMap event
CurrentMap &

  • boolean isRestart: Whether the map was restarted using dedicated server call

CurrentMap

Controller current map object
Map &

  • number defaultLapsAmount: Default amount of laps (may be incoherent with actual laps amount if it's modified using dedicated server call)
  • number lapsAmount: Current amount of laps depending on dedicated server config and map default laps
  • number checkpointsPerLap: Amount of checkpoints per lap (includes finish)
  • number checkpointsAmount: Total amount of checkpoints depending on map checkpoints per lap and laps amount (includes finish)
  • boolean isInLapsMode: Whether the map is in laps mode (always false in TimeAttack and Stunts, true in other gamemodes if map has multilap start)
  • boolean isLapsAmountModified: Whether the laps amount was modified by dedicated server calls (always false in TimeAttack, Stunts always true in Laps)

LocalRecord

Controller local record object
Record & OfflinePlayer

CheckpointInfo

Object containing player checkpoint information. Created and emitted on the PlayerCheckpoint event
Checkpoint &

  • Player player: Player object

FinishInfo

Object containing player finish information. Created and emitted on the PlayerFinish and LiveRecord events
Omit<Player & LocalRecord, 'currentCheckpoints' | 'isSpectator' | 'date' | 'isTemporarySpectator' | 'isPureSpectator'> &

  • number roundPoints: Amount of round points acquired by the player in the current round (Rounds/Cup/Teams mode only)

LeaveInfo

Object containing player information. Created and emitted on the PlayerLeave event
Omit<Player, 'lastOnline'> &

  • number sessionTime: Amount of time the player spent on the server in the current session
  • number wins: Player wins count
  • number privilege: Player privilege level
  • boolean isSpectator: Whether the player was in the spectator mode

ManialinkClickInfo

Object containing manialink click information. Created and emitted on the ManialinkClick event
Player &

  • number actionId: Clicked manialink action ID

MapAddedInfo

Object containing map information. Created and emitted on the MapAdded event
Map &

  • string callerLogin: Login of the player who added the map

MapRemovedInfo

Object containing map information. Created and emitted on the MapRemoved event Map &

  • string callerLogin: Login of the player who removed the map

RecordInfo

Object containing player record information. Created and emitted on the MapRemoved event
Omit<Player & LocalRecord, 'currentCheckpoints' | 'isSpectator' | 'isTemporarySpectator' | 'isPureSpectator'> &

  • number position: Player rank in the local records leaderboard
  • previous: Player previous local record info (undefined if the player didn't have a local record on the map)
    • number position: Previous player rank in the local records leaderboard
    • number time: Previous player local record time

LapFinishInfo

Object containing player lap finish information. Created and emitted on the PlayerLap event https://github.com/lythx/trakman/wiki/Controller-Events#events-list FinishInfo &

  • boolean isFinish: Whether the lap was the finish lap

LapRecordInfo

Object containing player lap record information. Created and emitted on the LapRecord event https://github.com/lythx/trakman/wiki/Controller-Events#events-list RecordInfo &

  • boolean isFinish: Whether the lap was the finish lap

MessageInfo

Object containing chat message information. Created and emitted on the PlayerChat event https://github.com/lythx/trakman/wiki/Controller-Events#events-list
Message & Player

ServerState

enum['result', 'race', 'transition']: Dedicated server state

GameMode

enum['TimeAttack', 'Rounds', 'Cup', 'Laps', 'Teams', 'Stunts']: Server game mode

Environment

enum['Stadium', 'Island', 'Desert', 'Rally', 'Bay', 'Coast', 'Snow']: Map environment

Mood

enum['Sunrise', 'Day', 'Sunset', 'Night']: Map mood ('Sunrise', 'Night', etc.)

CommandParameterType

enum['int', 'double', 'boolean', 'time', 'player', 'offlinePlayer', 'multiword']: Server command data type

TMXDifficulty

enum['Beginner', 'Intermediate', 'Expert', 'Lunatic']: TMX map difficulty

TMXSite

enum['TMNF', 'TMU', 'TMN', 'TMS', 'TMO']: TMX site

TMXRoutes

enum['Single', 'Multiple', 'Symmetrical']: TMX map routes

TMXMapType

enum['Race', 'Puzzle', 'Platform', 'Stunts', 'Shortcut', 'Laps']: TMX map type

TMXCar

enum['SnowCar', 'DesertCar', 'RallyCar', 'IslandCar', 'CoastCar', 'BayCar', 'StadiumCar']: TMX map car

TMXStyle

enum['Normal', 'Stunt', 'Maze', 'Offroad', 'Laps', 'Fullspeed', 'LOL', 'Tech', 'SpeedTech', 'RPG', 'PressForward', 'Trial', 'Grass']: TMX map style

Clone this wiki locally