ManiaScript  2019-10-10
The script language used in ManiaPlanet gaming system
Public Types | Public Member Functions | Public Attributes | List of all members
CTmMode Struct Reference

#include <big.h>

Inheritance diagram for CTmMode:
CMode CNod

Public Types

enum  ETmScoreSortOrder {
  TotalPoints, BestRace_Time, BestRace_Stunts, BestRace_NbRespawns,
  BestRace_CheckpointsProgress, PrevRace_Time, Name, LadderRankSortValue
}
 
enum  ETMRespawnBehaviour { Normal, DoNothing, GiveUpBeforeFirstCheckPoint, AlwaysGiveUp }
 
enum  ETmRaceChronoBehaviour { Auto, Hidden, CountDown, Normal }
 
enum  EPersonalGhost { Disabled, Latest, FastestRace }
 
- Public Types inherited from CMode
enum  EMedal {
  None, Finished, Bronze, Silver,
  Gold, Author
}
 

Public Member Functions

CTmPlayer GetPlayer (CUIConfig UI)
 
CTmPlayer GetPlayer (Text Login)
 
Boolean PassOn (CTmModeEvent Event)
 
Void Discard (CTmModeEvent Event)
 
Void SpawnPlayer (CTmPlayer Player, Integer ClanNum, Integer RaceStartTime)
 
Void UnspawnPlayer (CTmPlayer Player)
 
Void SetPlayerClan (CTmPlayer Player, Integer ClanNum)
 
Void Scores_Sort (ETmScoreSortOrder SortOrder)
 
Void Scores_Clear ()
 
Void Ladder_ComputeRank (ETmScoreSortOrder SortOrder)
 
Void Cheats_Reset ()
 
Ident RaceGhost_Add (CGhost Ghost, Boolean DisplayAsPlayerBest)
 
Ident RaceGhost_AddWithOffset (CGhost Ghost, Integer OffsetMs)
 
Ident RaceGhost_Add (CGhost Ghost, Boolean DisplayAsPlayerBest, Ident ModelId)
 
Void RaceGhost_Remove (Ident GhostInstId)
 
Void RaceGhost_RemoveAll ()
 
Integer RaceGhost_GetStartTime (Ident GhostInstId)
 
Integer RaceGhost_GetCurCheckpoint (Ident GhostInstId)
 
Integer RaceGhost_GetCheckpointTime (Ident GhostInstId, Integer Checkpoint)
 
Vec3 RaceGhost_GetPosition (Ident GhostInstId)
 
Boolean RaceGhost_IsVisible (Ident GhostInstId)
 
Boolean RaceGhost_IsReplayOver (Ident GhostInstId)
 
- Public Member Functions inherited from CMode
Void TweakTeamColorsToAvoidHueOverlap ()
 
Void RequestLoadMap ()
 
Void RequestUnloadMap ()
 
Void Hud_Load (Text ModuleName)
 
Void PassOn (CUIConfigEvent EventToPassOn)
 
Void Discard (CUIConfigEvent EventToDiscard)
 
Void Ladder_OpenMatch_Request ()
 
Void Ladder_AddPlayer (CScore PlayerScore)
 
Void Ladder_OpenMatch_BeginRequest ()
 
Void Ladder_OpenMatch_AddPlayer (CScore PlayerScore)
 
Void Ladder_OpenMatch_EndRequest ()
 
Void Ladder_CloseMatchRequest ()
 
Void Ladder_CancelMatchRequest ()
 
Void Ladder_SetResultsVersion (Integer Version)
 
Void Ladder_SetMatchMakingMatchId (Integer MatchId)
 
Void Ladder_EnableChallengeMode (Boolean Enable)
 
Void AutoTeamBalance ()
 
Void Solo_SetNewRecord (CScore PlayerScore, EMedal PlayerScore)
 
Integer Synchro_AddBarrier ()
 
Boolean Synchro_BarrierReached (Integer Barrier)
 
Boolean Users_AreAllies (CUser User1, CUser User2)
 
Void Users_RequestSwitchToSpectator (CUser User)
 
CUser Users_CreateFake (Text NickName, Integer RequestedTeam)
 
Void Users_DestroyFake (CUser User)
 
Void Users_SetNbFakeUsers (Integer NbTeam1, Integer NbTeam2)
 
Void Users_DestroyAllFakes ()
 
Void ItemList_Begin ()
 
Boolean ItemList_Begin ()
 
Ident ItemList_Add (Text ModelName)
 
Ident ItemList_AddWithSkin (Text ModelName, Text SkinNameOrUrl)
 
Void ItemList_End ()
 
Void DemoToken_StartUsingToken ()
 
Void DemoToken_StopUsingToken ()
 
Void DemoToken_GetAndUseToken (CUser User)
 
Void ActionList_Begin ()
 
Boolean ActionList_Begin ()
 
Ident ActionList_Add (Text ActionName)
 
Void ActionList_End ()
 
Void Replay_Start ()
 
Void Replay_Stop ()
 
Text Dbg_DumpDeclareForVariables (CNod Nod, Boolean StatsOnly)
 

Public Attributes

const CTmPlayer [] AllPlayers
 
const CTmPlayer [] Spectators
 
const CTmPlayer [] Players
 
const CTmPlayer [] PlayersRacing
 
const CTmPlayer [] PlayersWaiting
 
const CTmScore [] Scores
 
Integer Clan1Score
 
Integer Clan2Score
 
Integer [] ClanScores
 
const Integer ClansNbTotal
 
const Integer [] ClansNbPlayers
 
const CTmModeEvent [] PendingEvents
 
Integer CutOffTimeLimit
 
Integer NbLaps
 
Boolean IndependantLaps
 
Boolean UseClans
 
Boolean UseForcedClans
 
ETMRespawnBehaviour RespawnBehaviour
 
Boolean UiRounds
 
Boolean UiLaps
 
Boolean UiStuntsMode
 
Boolean UiDisplayStuntsNames
 
Boolean UiDisableHelpMessage
 
Integer UiScoresPointsLimit
 
ETmRaceChronoBehaviour UiRaceChrono
 
Boolean EnableCollisions
 
Boolean EnableScaleCar
 
Boolean EnableCheckpointBonus
 
Boolean EnableUniqueCamera
 
Boolean EnableBonusEvents
 
Boolean HideOpponents
 
Integer ForceMaxOpponents
 
Boolean EnableLegacyXmlRpcCallbacks
 
Boolean MedalGhost_ShowGold
 
Boolean MedalGhost_ShowSilver
 
Boolean MedalGhost_ShowBronze
 
EPersonalGhost PersonalGhost
 
Boolean ValidationGhost_Show
 
Boolean StuntModel_EnableCustomisation
 
Boolean StuntModel_MP3Combo
 
Boolean StuntModel_MP3Points
 
Boolean StuntModel_UseStricterAngle
 
Integer StuntModel_MinStuntDuration
 
Integer StuntModel_RespawnPenalty
 
Integer StuntModel_InterComboDelay
 
Integer StuntModel_InterComboDelayExtendPerPoint
 
Real StuntModel_FigureRepeatMalus
 
const Vec3 MapStartLinePos
 
const Vec3 [] MapCheckpointPos
 
const Vec3 [] MapFinishLinePos
 
const Boolean MapIsLapRace
 
const Integer MapNbLaps
 
- Public Attributes inherited from CMode
Text ModeStatusMessage
 
const CTitle LoadedTitle
 
const Text ServerLogin
 
const Text ServerName
 
const Text ServerModeName
 
const Text MapName
 
const CMap Map
 
const Text MapPlayerModelName
 
const CUser [] Users
 
const CTeam [] Teams
 
Text NeutralEmblemUrl
 
const Text ForcedClubLinkUrl1
 
const Text ForcedClubLinkUrl2
 
Text ClientManiaAppUrl
 
const Integer Now
 
const Integer Period
 
Boolean MatchEndRequested
 
const Boolean ServerShutdownRequested
 
const Boolean MapLoaded
 
const CMapInfo [] MapList
 
Integer NextMapIndex
 
const CUIConfigMgr UIManager
 
const CModulePlaygroundHud Hud
 
const Boolean Ladder_RequestInProgress
 
const CServerAdmin ServerAdmin
 
const Boolean Solo_NewRecordSequenceInProgress
 
const CXmlRpc XmlRpc
 
const CParsingManager Xml
 
const CHttpManager Http
 
const CInputManager Input
 
const CDataFileMgr DataFileMgr
 
const CScoreMgr ScoreMgr
 
const CSystemPlatform System
 
Boolean UseMinimap
 
Boolean Replay_AutoStart
 
const CAchievementsManager AchievementsManager
 
const CModeTurretManager TurretsManager
 
const CModeVehicleManager VehiclesManager
 
const CActionManager ActionsManager
 
- Public Attributes inherited from CNod
const Ident Id
 

Detailed Description

Supported declare modes : Local Persistent Rules API for TrackMania gamemodes.

Member Enumeration Documentation

◆ EPersonalGhost

Enumerator
Disabled 
Latest 
FastestRace 

◆ ETmRaceChronoBehaviour

Enumerator
Auto 
Hidden 
CountDown 
Normal 

◆ ETMRespawnBehaviour

Enumerator
Normal 
DoNothing 
GiveUpBeforeFirstCheckPoint 
AlwaysGiveUp 

◆ ETmScoreSortOrder

Enumerator
TotalPoints 
BestRace_Time 
BestRace_Stunts 
BestRace_NbRespawns 
BestRace_CheckpointsProgress 
PrevRace_Time 
Name 
LadderRankSortValue 

Member Function Documentation

◆ Cheats_Reset()

Void CTmMode::Cheats_Reset ( )

◆ Discard()

Void CTmMode::Discard ( CTmModeEvent  Event)

◆ GetPlayer() [1/2]

CTmPlayer CTmMode::GetPlayer ( CUIConfig  UI)

◆ GetPlayer() [2/2]

CTmPlayer CTmMode::GetPlayer ( Text  Login)

◆ Ladder_ComputeRank()

Void CTmMode::Ladder_ComputeRank ( ETmScoreSortOrder  SortOrder)

◆ PassOn()

Boolean CTmMode::PassOn ( CTmModeEvent  Event)

◆ RaceGhost_Add() [1/2]

Ident CTmMode::RaceGhost_Add ( CGhost  Ghost,
Boolean  DisplayAsPlayerBest 
)

◆ RaceGhost_Add() [2/2]

Ident CTmMode::RaceGhost_Add ( CGhost  Ghost,
Boolean  DisplayAsPlayerBest,
Ident  ModelId 
)

◆ RaceGhost_AddWithOffset()

Ident CTmMode::RaceGhost_AddWithOffset ( CGhost  Ghost,
Integer  OffsetMs 
)

◆ RaceGhost_GetCheckpointTime()

Integer CTmMode::RaceGhost_GetCheckpointTime ( Ident  GhostInstId,
Integer  Checkpoint 
)

◆ RaceGhost_GetCurCheckpoint()

Integer CTmMode::RaceGhost_GetCurCheckpoint ( Ident  GhostInstId)

◆ RaceGhost_GetPosition()

Vec3 CTmMode::RaceGhost_GetPosition ( Ident  GhostInstId)

◆ RaceGhost_GetStartTime()

Integer CTmMode::RaceGhost_GetStartTime ( Ident  GhostInstId)

◆ RaceGhost_IsReplayOver()

Boolean CTmMode::RaceGhost_IsReplayOver ( Ident  GhostInstId)

◆ RaceGhost_IsVisible()

Boolean CTmMode::RaceGhost_IsVisible ( Ident  GhostInstId)

◆ RaceGhost_Remove()

Void CTmMode::RaceGhost_Remove ( Ident  GhostInstId)

◆ RaceGhost_RemoveAll()

Void CTmMode::RaceGhost_RemoveAll ( )

◆ Scores_Clear()

Void CTmMode::Scores_Clear ( )

◆ Scores_Sort()

Void CTmMode::Scores_Sort ( ETmScoreSortOrder  SortOrder)

◆ SetPlayerClan()

Void CTmMode::SetPlayerClan ( CTmPlayer  Player,
Integer  ClanNum 
)

◆ SpawnPlayer()

Void CTmMode::SpawnPlayer ( CTmPlayer  Player,
Integer  ClanNum,
Integer  RaceStartTime 
)

◆ UnspawnPlayer()

Void CTmMode::UnspawnPlayer ( CTmPlayer  Player)

Member Data Documentation

◆ AllPlayers

const CTmPlayer [] CTmMode::AllPlayers

◆ Clan1Score

Integer CTmMode::Clan1Score

◆ Clan2Score

Integer CTmMode::Clan2Score

◆ ClanScores

Integer [] CTmMode::ClanScores

◆ ClansNbPlayers

const Integer [] CTmMode::ClansNbPlayers

◆ ClansNbTotal

const Integer CTmMode::ClansNbTotal

◆ CutOffTimeLimit

Integer CTmMode::CutOffTimeLimit

◆ EnableBonusEvents

Boolean CTmMode::EnableBonusEvents

◆ EnableCheckpointBonus

Boolean CTmMode::EnableCheckpointBonus

◆ EnableCollisions

Boolean CTmMode::EnableCollisions

◆ EnableLegacyXmlRpcCallbacks

Boolean CTmMode::EnableLegacyXmlRpcCallbacks

◆ EnableScaleCar

Boolean CTmMode::EnableScaleCar

◆ EnableUniqueCamera

Boolean CTmMode::EnableUniqueCamera

◆ ForceMaxOpponents

Integer CTmMode::ForceMaxOpponents

◆ HideOpponents

Boolean CTmMode::HideOpponents

◆ IndependantLaps

Boolean CTmMode::IndependantLaps

◆ MapCheckpointPos

const Vec3 [] CTmMode::MapCheckpointPos

You can use MapCheckpointPos.count to get the number of checkpoints.

◆ MapFinishLinePos

const Vec3 [] CTmMode::MapFinishLinePos

◆ MapIsLapRace

const Boolean CTmMode::MapIsLapRace

◆ MapNbLaps

const Integer CTmMode::MapNbLaps

◆ MapStartLinePos

const Vec3 CTmMode::MapStartLinePos

◆ MedalGhost_ShowBronze

Boolean CTmMode::MedalGhost_ShowBronze

◆ MedalGhost_ShowGold

Boolean CTmMode::MedalGhost_ShowGold

◆ MedalGhost_ShowSilver

Boolean CTmMode::MedalGhost_ShowSilver

◆ NbLaps

Integer CTmMode::NbLaps

◆ PendingEvents

const CTmModeEvent [] CTmMode::PendingEvents

◆ PersonalGhost

EPersonalGhost CTmMode::PersonalGhost

◆ Players

const CTmPlayer [] CTmMode::Players

◆ PlayersRacing

const CTmPlayer [] CTmMode::PlayersRacing

◆ PlayersWaiting

const CTmPlayer [] CTmMode::PlayersWaiting

◆ RespawnBehaviour

ETMRespawnBehaviour CTmMode::RespawnBehaviour

◆ Scores

const CTmScore [] CTmMode::Scores

◆ Spectators

const CTmPlayer [] CTmMode::Spectators

◆ StuntModel_EnableCustomisation

Boolean CTmMode::StuntModel_EnableCustomisation

◆ StuntModel_FigureRepeatMalus

Real CTmMode::StuntModel_FigureRepeatMalus

◆ StuntModel_InterComboDelay

Integer CTmMode::StuntModel_InterComboDelay

◆ StuntModel_InterComboDelayExtendPerPoint

Integer CTmMode::StuntModel_InterComboDelayExtendPerPoint

◆ StuntModel_MinStuntDuration

Integer CTmMode::StuntModel_MinStuntDuration

◆ StuntModel_MP3Combo

Boolean CTmMode::StuntModel_MP3Combo

◆ StuntModel_MP3Points

Boolean CTmMode::StuntModel_MP3Points

◆ StuntModel_RespawnPenalty

Integer CTmMode::StuntModel_RespawnPenalty

◆ StuntModel_UseStricterAngle

Boolean CTmMode::StuntModel_UseStricterAngle

◆ UiDisableHelpMessage

Boolean CTmMode::UiDisableHelpMessage

◆ UiDisplayStuntsNames

Boolean CTmMode::UiDisplayStuntsNames

◆ UiLaps

Boolean CTmMode::UiLaps

◆ UiRaceChrono

ETmRaceChronoBehaviour CTmMode::UiRaceChrono

◆ UiRounds

Boolean CTmMode::UiRounds

◆ UiScoresPointsLimit

Integer CTmMode::UiScoresPointsLimit

◆ UiStuntsMode

Boolean CTmMode::UiStuntsMode

◆ UseClans

Boolean CTmMode::UseClans

◆ UseForcedClans

Boolean CTmMode::UseForcedClans

◆ ValidationGhost_Show

Boolean CTmMode::ValidationGhost_Show

The documentation for this struct was generated from the following file: