ManiaScript Reference  2019-05
CUIConfig Struct Reference
Inheritance diagram for CUIConfig:
CNod

Public Types

enum  EUISequence {
  None, Playing, Intro, Outro,
  Podium, CustomMTClip, EndRound, PlayersPresentation,
  UIInteraction, RollingBackgroundIntro, CustomMTClip_WithUIInteraction
}
 
enum  EUIStatus {
  None, Normal, Warning, Error,
  Official
}
 
enum  EVisibility {
  None, Normal, Manual, ForcedHidden,
  ForcedVisible
}
 
enum  ELabelsVisibility {
  None, Never, Always, WhenInFrustum,
  WhenVisible, WhenInMiddleOfScreen
}
 
enum  EAvatarVariant { Default, Sad, Happy }
 
enum  EUISound {
  Default, Silence, StartMatch, EndMatch,
  StartRound, EndRound, PhaseChange, TieBreakPoint,
  TiePoint, VictoryPoint, Capture, TimeOut,
  Notice, Warning, PlayerEliminated, PlayerHit,
  Checkpoint, Finish, Record, ScoreProgress,
  RankChange, Bonus, FirstHit, Combo,
  PlayersRemaining, Custom1, Custom2, Custom3,
  Custom4
}
 
enum  ENoticeLevel {
  Default, PlayerInfo, PlayerWarning, MapInfo,
  MapWarning, MatchInfo, MatchWarning
}
 
enum  EMessageDisplay { Chat, Small, Status, Big }
 
enum  EObserverMode { Default, Forced, Forbidden, Manual }
 
enum  EHudVisibility { Nothing, Everything, MarkersOnly, Default }
 

Public Member Functions

Void SendChat (Text Text)
 
Void SendNotice (Text Text, ENoticeLevel Level, CUser Avatar, EAvatarVariant AvatarVariant, EUISound Sound, Integer SoundVariant)
 
Text GetLayerManialinkAction (CUILayer Layer)
 
Void ClearLayerManialinkAction (CUILayer Layer)
 
Void QueueMessage (Integer Duration, Integer Priority, EMessageDisplay Level, Text Message, CUser Avatar, EAvatarVariant AvatarVariant, EUISound Sound, Integer SoundVariant)
 
Void QueueMessage (Integer Duration, Integer Priority, EMessageDisplay Level, Text Message, EUISound Sound, Integer SoundVariant)
 
Void QueueMessage (Integer Duration, Integer Priority, EMessageDisplay Level, Text Message)
 
Void ClearMessages ()
 

Public Attributes

EUISequence UISequence
 
const Boolean UISequenceIsCompleted
 
Text UISequence_CustomMTClip
 
Integer UISequence_CustomMTRefTime
 
Boolean UISequence_CanSkipIntroMT
 
Text UISequence_PodiumPlayersWin
 
Text UISequence_PodiumPlayersLose
 
Text ManialinkPage
 
Text BigMessage
 
Text BigMessageAvatarLogin
 
EAvatarVariant BigMessageAvatarVariant
 
EUISound BigMessageSound
 
Integer BigMessageSoundVariant
 
Text StatusMessage
 
Text GaugeMessage
 
Real GaugeRatio
 
Integer GaugeClan
 
Text MarkersXML
 
const CUILayer [] UILayers
 
Boolean OverlayHideNotices
 
Boolean OverlayHideMapInfo
 
Boolean OverlayHideOpponentsInfo
 
Boolean OverlayHideChat
 
Boolean OverlayHideCheckPointList
 
Boolean OverlayHideRoundScores
 
Boolean OverlayHideCountdown
 
Boolean OverlayHideCrosshair
 
Boolean OverlayHideGauges
 
Boolean OverlayHideConsumables
 
Boolean OverlayHide321Go
 
Boolean OverlayHideBackground
 
Boolean OverlayHideChrono
 
Boolean OverlayHideSpeedAndDist
 
Boolean OverlayHidePersonnalBestAndRank
 
Boolean OverlayHidePosition
 
Boolean OverlayHideCheckPointTime
 
Boolean OverlayHideEndMapLadderRecap
 
Boolean OverlayHideMultilapInfos
 
Boolean OverlayHideSpectatorControllers
 
Boolean OverlayHideSpectatorInfos
 
Boolean OverlayChatHideAvatar
 
Integer OverlayChatLineCount
 
Vec2 OverlayChatOffset
 
Vec2 CountdownCoord
 
Boolean NoticesFilter_HidePlayerInfo
 
Boolean NoticesFilter_HidePlayerWarning
 
Boolean NoticesFilter_HidePlayerInfoIfNotMe
 
Boolean NoticesFilter_HidePlayerWarningIfNotMe
 
Boolean NoticesFilter_HideMapInfo
 
Boolean NoticesFilter_HideMapWarning
 
Boolean NoticesFilter_HideMatchInfo
 
Boolean NoticesFilter_HideMatchWarning
 
ENoticeLevel NoticesFilter_LevelToShowAsBigMessage
 
Text ScoreTable
 
EVisibility ScoreTableVisibility
 
Text SmallScoreTable
 
EVisibility SmallScoreTableVisibility
 
Boolean ScoreTableOnlyManialink
 
Boolean AltMenuNoDefaultScores
 
Boolean AltMenuNoCustomScores
 
Boolean OverlayScoreSummary
 
Ident ScoreSummary_Player1
 
Integer ScoreSummary_Points1
 
Integer ScoreSummary_RoundPoints1
 
Integer ScoreSummary_MatchPoints1
 
Real ScoreSummary_Gauge1
 
Ident ScoreSummary_Player2
 
Integer ScoreSummary_Points2
 
Integer ScoreSummary_RoundPoints2
 
Integer ScoreSummary_MatchPoints2
 
Real ScoreSummary_Gauge2
 
Boolean ScreenIn3dHideScoreSummary
 
Boolean ScreenIn3dHideVersus
 
Integer CountdownEndTime
 
EUIStatus UIStatus
 
EHudVisibility LabelsVisibility
 
ELabelsVisibility AlliesLabelsVisibility
 
EVisibility AlliesLabelsShowGauges
 
EVisibility AlliesLabelsShowNames
 
Integer AlliesLabelsMaxCount
 
ELabelsVisibility TeamLabelsVisibility
 
EVisibility TeamLabelsShowGauges
 
EVisibility TeamLabelsShowNames
 
ELabelsVisibility OpposingTeamLabelsVisibility
 
EVisibility OpposingTeamLabelsShowGauges
 
EVisibility OpposingTeamLabelsShowNames
 
Boolean ForceSpectator
 
Integer SpectatorForceCameraType
 
Ident SpectatorAutoTarget
 
Ident SpectatorForcedTarget
 
Integer SpectatorForcedClan
 
Real SpectatorCamAutoLatitude
 
Real SpectatorCamAutoLongitude
 
Real SpectatorCamAutoRadius
 
EObserverMode SpectatorObserverMode
 
- Public Attributes inherited from CNod
const Ident Id
 

Detailed Description

Supported declare modes : Local NetworkRead NetworkWrite This object handles the interface.

Member Enumeration Documentation

◆ EAvatarVariant

Enumerator
Default 
Sad 
Happy 

◆ EHudVisibility

Enumerator
Nothing 
Everything 
MarkersOnly 
Default 

◆ ELabelsVisibility

Enumerator
None 
Never 
Always 
WhenInFrustum 
WhenVisible 
WhenInMiddleOfScreen 

◆ EMessageDisplay

Enumerator
Chat 
Small 
Status 
Big 

◆ ENoticeLevel

Enumerator
Default 
PlayerInfo 
PlayerWarning 
MapInfo 
MapWarning 
MatchInfo 
MatchWarning 

◆ EObserverMode

Enumerator
Default 
Forced 
Forbidden 
Manual 

◆ EUISequence

Enumerator
None 
Playing 
Intro 
Outro 
Podium 
CustomMTClip 
EndRound 
PlayersPresentation 
UIInteraction 
RollingBackgroundIntro 
CustomMTClip_WithUIInteraction 

◆ EUISound

Enumerator
Default 
Silence 
StartMatch 
EndMatch 
StartRound 
EndRound 
PhaseChange 
TieBreakPoint 
TiePoint 
VictoryPoint 
Capture 
TimeOut 
Notice 
Warning 
PlayerEliminated 
PlayerHit 
Checkpoint 
Finish 
Record 
ScoreProgress 
RankChange 
Bonus 
FirstHit 
Combo 
PlayersRemaining 
Custom1 
Custom2 
Custom3 
Custom4 

◆ EUIStatus

Enumerator
None 
Normal 
Warning 
Error 
Official 

◆ EVisibility

Enumerator
None 
Normal 
Manual 
ForcedHidden 
ForcedVisible 

Member Function Documentation

◆ ClearLayerManialinkAction()

Void CUIConfig::ClearLayerManialinkAction ( CUILayer  Layer)

◆ ClearMessages()

Void CUIConfig::ClearMessages ( )

◆ GetLayerManialinkAction()

Text CUIConfig::GetLayerManialinkAction ( CUILayer  Layer)

◆ QueueMessage() [1/3]

Void CUIConfig::QueueMessage ( Integer  Duration,
Integer  Priority,
EMessageDisplay  Level,
Text  Message,
CUser  Avatar,
EAvatarVariant  AvatarVariant,
EUISound  Sound,
Integer  SoundVariant 
)

◆ QueueMessage() [2/3]

Void CUIConfig::QueueMessage ( Integer  Duration,
Integer  Priority,
EMessageDisplay  Level,
Text  Message,
EUISound  Sound,
Integer  SoundVariant 
)

◆ QueueMessage() [3/3]

Void CUIConfig::QueueMessage ( Integer  Duration,
Integer  Priority,
EMessageDisplay  Level,
Text  Message 
)

◆ SendChat()

Void CUIConfig::SendChat ( Text  Text)

◆ SendNotice()

Void CUIConfig::SendNotice ( Text  Text,
ENoticeLevel  Level,
CUser  Avatar,
EAvatarVariant  AvatarVariant,
EUISound  Sound,
Integer  SoundVariant 
)

Member Data Documentation

◆ AlliesLabelsMaxCount

Integer CUIConfig::AlliesLabelsMaxCount

Values in range (0 - 250)

◆ AlliesLabelsShowGauges

EVisibility CUIConfig::AlliesLabelsShowGauges

◆ AlliesLabelsShowNames

EVisibility CUIConfig::AlliesLabelsShowNames

◆ AlliesLabelsVisibility

ELabelsVisibility CUIConfig::AlliesLabelsVisibility

◆ AltMenuNoCustomScores

Boolean CUIConfig::AltMenuNoCustomScores

◆ AltMenuNoDefaultScores

Boolean CUIConfig::AltMenuNoDefaultScores

◆ BigMessage

Text CUIConfig::BigMessage

◆ BigMessageAvatarLogin

Text CUIConfig::BigMessageAvatarLogin

◆ BigMessageAvatarVariant

EAvatarVariant CUIConfig::BigMessageAvatarVariant

◆ BigMessageSound

EUISound CUIConfig::BigMessageSound

◆ BigMessageSoundVariant

Integer CUIConfig::BigMessageSoundVariant

◆ CountdownCoord

Vec2 CUIConfig::CountdownCoord

◆ CountdownEndTime

Integer CUIConfig::CountdownEndTime

◆ ForceSpectator

Boolean CUIConfig::ForceSpectator

◆ GaugeClan

Integer CUIConfig::GaugeClan

◆ GaugeMessage

Text CUIConfig::GaugeMessage

◆ GaugeRatio

Real CUIConfig::GaugeRatio

◆ LabelsVisibility

EHudVisibility CUIConfig::LabelsVisibility

◆ ManialinkPage

Text CUIConfig::ManialinkPage

◆ MarkersXML

Text CUIConfig::MarkersXML

An XML text describing the map tooltips appearing in the HUD.
It's a set of <marker/> elements which can have the following attributes :

  1. label : a text to display
  2. pos : a vector of 3 world coordinates desribing the position of the marker
  3. playerlogin : alternatively, instead of using pos, you can use a player login. The marker will smoothly follow the player
  4. playerid : similar to playerlogin. Fill it with Player.Id. The marker will smoothly follow the player
  5. box : a vector of 3 dimensions describing the size of the marked object (allows a better placement of the marker on the screen)
  6. gauge : a Real. If between 0. and 1. a gauge will be shown undeneath the text
  7. imageurl : a string. URL of an image to use
  8. distmax : a real. The marker will disappear if the dist to it is greater than distmax
  9. isturning : a bool. Only for markers attached to players. If the marker appear on a minimap, it will turn around to reflect the player orientation.

◆ NoticesFilter_HideMapInfo

Boolean CUIConfig::NoticesFilter_HideMapInfo

◆ NoticesFilter_HideMapWarning

Boolean CUIConfig::NoticesFilter_HideMapWarning

◆ NoticesFilter_HideMatchInfo

Boolean CUIConfig::NoticesFilter_HideMatchInfo

◆ NoticesFilter_HideMatchWarning

Boolean CUIConfig::NoticesFilter_HideMatchWarning

◆ NoticesFilter_HidePlayerInfo

Boolean CUIConfig::NoticesFilter_HidePlayerInfo

◆ NoticesFilter_HidePlayerInfoIfNotMe

Boolean CUIConfig::NoticesFilter_HidePlayerInfoIfNotMe

◆ NoticesFilter_HidePlayerWarning

Boolean CUIConfig::NoticesFilter_HidePlayerWarning

◆ NoticesFilter_HidePlayerWarningIfNotMe

Boolean CUIConfig::NoticesFilter_HidePlayerWarningIfNotMe

◆ NoticesFilter_LevelToShowAsBigMessage

ENoticeLevel CUIConfig::NoticesFilter_LevelToShowAsBigMessage

◆ OpposingTeamLabelsShowGauges

EVisibility CUIConfig::OpposingTeamLabelsShowGauges

◆ OpposingTeamLabelsShowNames

EVisibility CUIConfig::OpposingTeamLabelsShowNames

◆ OpposingTeamLabelsVisibility

ELabelsVisibility CUIConfig::OpposingTeamLabelsVisibility

◆ OverlayChatHideAvatar

Boolean CUIConfig::OverlayChatHideAvatar

◆ OverlayChatLineCount

Integer CUIConfig::OverlayChatLineCount

Values in range (0 - 40)

◆ OverlayChatOffset

Vec2 CUIConfig::OverlayChatOffset

◆ OverlayHide321Go

Boolean CUIConfig::OverlayHide321Go

◆ OverlayHideBackground

Boolean CUIConfig::OverlayHideBackground

◆ OverlayHideChat

Boolean CUIConfig::OverlayHideChat

◆ OverlayHideCheckPointList

Boolean CUIConfig::OverlayHideCheckPointList

◆ OverlayHideCheckPointTime

Boolean CUIConfig::OverlayHideCheckPointTime

◆ OverlayHideChrono

Boolean CUIConfig::OverlayHideChrono

◆ OverlayHideConsumables

Boolean CUIConfig::OverlayHideConsumables

◆ OverlayHideCountdown

Boolean CUIConfig::OverlayHideCountdown

◆ OverlayHideCrosshair

Boolean CUIConfig::OverlayHideCrosshair

◆ OverlayHideEndMapLadderRecap

Boolean CUIConfig::OverlayHideEndMapLadderRecap

◆ OverlayHideGauges

Boolean CUIConfig::OverlayHideGauges

◆ OverlayHideMapInfo

Boolean CUIConfig::OverlayHideMapInfo

◆ OverlayHideMultilapInfos

Boolean CUIConfig::OverlayHideMultilapInfos

◆ OverlayHideNotices

Boolean CUIConfig::OverlayHideNotices

◆ OverlayHideOpponentsInfo

Boolean CUIConfig::OverlayHideOpponentsInfo

◆ OverlayHidePersonnalBestAndRank

Boolean CUIConfig::OverlayHidePersonnalBestAndRank

◆ OverlayHidePosition

Boolean CUIConfig::OverlayHidePosition

◆ OverlayHideRoundScores

Boolean CUIConfig::OverlayHideRoundScores

◆ OverlayHideSpectatorControllers

Boolean CUIConfig::OverlayHideSpectatorControllers

◆ OverlayHideSpectatorInfos

Boolean CUIConfig::OverlayHideSpectatorInfos

◆ OverlayHideSpeedAndDist

Boolean CUIConfig::OverlayHideSpeedAndDist

◆ OverlayScoreSummary

Boolean CUIConfig::OverlayScoreSummary

◆ ScoreSummary_Gauge1

Real CUIConfig::ScoreSummary_Gauge1

◆ ScoreSummary_Gauge2

Real CUIConfig::ScoreSummary_Gauge2

◆ ScoreSummary_MatchPoints1

Integer CUIConfig::ScoreSummary_MatchPoints1

◆ ScoreSummary_MatchPoints2

Integer CUIConfig::ScoreSummary_MatchPoints2

◆ ScoreSummary_Player1

Ident CUIConfig::ScoreSummary_Player1

◆ ScoreSummary_Player2

Ident CUIConfig::ScoreSummary_Player2

◆ ScoreSummary_Points1

Integer CUIConfig::ScoreSummary_Points1

◆ ScoreSummary_Points2

Integer CUIConfig::ScoreSummary_Points2

◆ ScoreSummary_RoundPoints1

Integer CUIConfig::ScoreSummary_RoundPoints1

◆ ScoreSummary_RoundPoints2

Integer CUIConfig::ScoreSummary_RoundPoints2

◆ ScoreTable

Text CUIConfig::ScoreTable

◆ ScoreTableOnlyManialink

Boolean CUIConfig::ScoreTableOnlyManialink

◆ ScoreTableVisibility

EVisibility CUIConfig::ScoreTableVisibility

◆ ScreenIn3dHideScoreSummary

Boolean CUIConfig::ScreenIn3dHideScoreSummary

◆ ScreenIn3dHideVersus

Boolean CUIConfig::ScreenIn3dHideVersus

◆ SmallScoreTable

Text CUIConfig::SmallScoreTable

◆ SmallScoreTableVisibility

EVisibility CUIConfig::SmallScoreTableVisibility

◆ SpectatorAutoTarget

Ident CUIConfig::SpectatorAutoTarget

◆ SpectatorCamAutoLatitude

Real CUIConfig::SpectatorCamAutoLatitude

◆ SpectatorCamAutoLongitude

Real CUIConfig::SpectatorCamAutoLongitude

◆ SpectatorCamAutoRadius

Real CUIConfig::SpectatorCamAutoRadius

◆ SpectatorForceCameraType

Integer CUIConfig::SpectatorForceCameraType

◆ SpectatorForcedClan

Integer CUIConfig::SpectatorForcedClan

◆ SpectatorForcedTarget

Ident CUIConfig::SpectatorForcedTarget

◆ SpectatorObserverMode

EObserverMode CUIConfig::SpectatorObserverMode

When not in spectator mode, allow/forbid to change the camera to observe other players. (in Trackmania there's no 'Manual' mode.)

◆ StatusMessage

Text CUIConfig::StatusMessage

◆ TeamLabelsShowGauges

EVisibility CUIConfig::TeamLabelsShowGauges

◆ TeamLabelsShowNames

EVisibility CUIConfig::TeamLabelsShowNames

◆ TeamLabelsVisibility

ELabelsVisibility CUIConfig::TeamLabelsVisibility

◆ UILayers

const CUILayer [] CUIConfig::UILayers

◆ UISequence

EUISequence CUIConfig::UISequence

◆ UISequence_CanSkipIntroMT

Boolean CUIConfig::UISequence_CanSkipIntroMT

◆ UISequence_CustomMTClip

Text CUIConfig::UISequence_CustomMTClip

◆ UISequence_CustomMTRefTime

Integer CUIConfig::UISequence_CustomMTRefTime

◆ UISequence_PodiumPlayersLose

Text CUIConfig::UISequence_PodiumPlayersLose

◆ UISequence_PodiumPlayersWin

Text CUIConfig::UISequence_PodiumPlayersWin

◆ UISequenceIsCompleted

const Boolean CUIConfig::UISequenceIsCompleted

◆ UIStatus

EUIStatus CUIConfig::UIStatus