This object handles the interface. More...

#include <doc.h>

Inheritance diagram for CUIConfig:

Public Types
enum	EUISequence { None , Playing , Intro , Outro , Podium , CustomMTClip , EndRound , PlayersPresentation , UIInteraction , RollingBackgroundIntro , CustomMTClip_WithUIInteraction , Finish }
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 }
enum	ECutSceneStyle { None , TM , SM }

Public Member Functions
Void	Spectator_SetAutoTarget_Clear ()
Void	Spectator_SetAutoTarget_All ()
Void	Spectator_SetAutoTarget_User (CUser User)
Void	Spectator_SetForcedTarget_Clear ()
Void	Spectator_SetForcedTarget_AllPlayers ()
Void	Spectator_SetForcedTarget_AllMap ()
Void	Spectator_SetForcedTarget_Entity (CEntity Entity)
Void	Spectator_SetForcedTarget_Landmark (CMapLandmark Landmark)
Void	Spectator_SetForcedTarget_Ghost (Ident GhostInstanceId)
Void	Spectator_SetForcedTarget_Clan (Integer ClanNumber)
Void	SendChat (Text Text)
Void	SendNotice (Text Text, CUIConfig::ENoticeLevel Level, CUser Avatar, CUIConfig::EAvatarVariant AvatarVariant, CUIConfig::EUISound Sound, Integer SoundVariant)
Text	GetLayerManialinkAction (CUILayer Layer)
Void	ClearLayerManialinkAction (CUILayer Layer)
CUIConfigMarker	AddMarker (Vec3 Position)
CUIConfigMarker	AddMarker (CEntity Entity)
CUIConfigMarker	AddMarker (CMapLandmark Landmark)
CUIConfigMarker	AddMarker (Ident GhostInstanceId)
Void	RemoveMarker (CUIConfigMarker Marker)
Void	ClearMarkers ()
Void	QueueMessage (Integer Duration, Integer Priority, CUIConfig::EMessageDisplay Level, Text Message, CUser Avatar, CUIConfig::EAvatarVariant AvatarVariant, CUIConfig::EUISound Sound, Integer SoundVariant)
Void	QueueMessage (Integer Duration, Integer Priority, CUIConfig::EMessageDisplay Level, Text Message, CUIConfig::EUISound Sound, Integer SoundVariant)
Void	QueueMessage (Integer Duration, Integer Priority, CUIConfig::EMessageDisplay Level, Text Message)
Void	ClearMessages ()

Public Attributes
CUIConfig::EUISequence	UISequence
Boolean const	UISequenceIsCompleted
Text	UISequence_CustomMTClip
Integer	UISequence_CustomMTRefTime
Boolean	UISequence_CanSkipIntroMT
Text	UISequence_PodiumPlayersWin
Text	UISequence_PodiumPlayersLose
CUIConfig::ECutSceneStyle	UISequence_CutSceneStyle
Boolean	DisableZoomTransitions
Text	ManialinkPage
Text	BigMessage
Text	BigMessageAvatarLogin
CUIConfig::EAvatarVariant	BigMessageAvatarVariant
CUIConfig::EUISound	BigMessageSound
Integer	BigMessageSoundVariant
Text	StatusMessage
Text	GaugeMessage
Real	GaugeRatio
Integer	GaugeClan
Text	MarkersXML
Boolean	OverrideMarkers
Array< CUIConfigMarker *const >	Markers
Array< CUILayer *const >	UILayers
Boolean	OverlayHideNotices
Boolean	OverlayHideMapInfo
Boolean	OverlayHideChat
Boolean	OverlayHideCountdown
Boolean	OverlayHideCrosshair
Boolean	OverlayHideGauges
Boolean	OverlayHideConsumables
Boolean	OverlayHide321Go
Boolean	OverlayMute321Go
Boolean	OverlayHideEndMapLadderRecap
Boolean	OverlayHideSpectatorInfos
Integer	OverlayChatLineCount
Vec2	OverlayChatOffset
Real	OverlayChatWidthCoef
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
CUIConfig::ENoticeLevel	NoticesFilter_LevelToShowAsBigMessage
Text	ScoreTable
CUIConfig::EVisibility	ScoreTableVisibility
Text	SmallScoreTable
CUIConfig::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
Boolean	DisplayControl_UseLiveCamera
Boolean	DisplayControl_UseEsportsProgrammation
Integer	CountdownEndTime
CUIConfig::EUIStatus	UIStatus
CUIConfig::EHudVisibility	LabelsVisibility
Boolean	LabelsVisibility_SkipMarkersOnly
CUIConfig::ELabelsVisibility	AlliesLabelsVisibility
CUIConfig::EVisibility	AlliesLabelsShowGauges
CUIConfig::EVisibility	AlliesLabelsShowNames
Integer	AlliesLabelsMaxCount
CUIConfig::ELabelsVisibility	TeamLabelsVisibility
CUIConfig::EVisibility	TeamLabelsShowGauges
CUIConfig::EVisibility	TeamLabelsShowNames
CUIConfig::ELabelsVisibility	OpposingTeamLabelsVisibility
CUIConfig::EVisibility	OpposingTeamLabelsShowGauges
CUIConfig::EVisibility	OpposingTeamLabelsShowNames
Boolean	PlayerDisableFreeCam
Boolean	ForceSpectator
Integer	SpectatorForceCameraType
Real	SpectatorCamAutoLatitude
Real	SpectatorCamAutoLongitude
Real	SpectatorCamAutoRadius
CUIConfig::EObserverMode	SpectatorObserverMode
Public Attributes inherited from CNod
Ident const	Id

Detailed Description

This object handles the interface.

Supported declare modes :

Local
NetworkRead
NetworkWrite

Member Enumeration Documentation

◆ EAvatarVariant

enum CUIConfig::EAvatarVariant

Enumerator
Default
Sad
Happy

◆ ECutSceneStyle

enum CUIConfig::ECutSceneStyle

Enumerator
None
TM
SM

◆ EHudVisibility

enum CUIConfig::EHudVisibility

Enumerator
Nothing
Everything
MarkersOnly
Default

◆ ELabelsVisibility

enum CUIConfig::ELabelsVisibility

Enumerator
None
Never
Always
WhenInFrustum
WhenVisible
WhenInMiddleOfScreen

◆ EMessageDisplay

enum CUIConfig::EMessageDisplay

Enumerator
Chat
Small
Status
Big

◆ ENoticeLevel

enum CUIConfig::ENoticeLevel

Enumerator
Default
PlayerInfo
PlayerWarning
MapInfo
MapWarning
MatchInfo
MatchWarning

◆ EObserverMode

enum CUIConfig::EObserverMode

Enumerator
Default
Forced
Forbidden
Manual

◆ EUISequence

enum CUIConfig::EUISequence

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

◆ EUISound

enum CUIConfig::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

enum CUIConfig::EUIStatus

Enumerator
None
Normal
Warning
Error
Official

◆ EVisibility

enum CUIConfig::EVisibility

Enumerator
None
Normal
Manual
ForcedHidden
ForcedVisible

Member Function Documentation

◆ AddMarker() [1/4]

CUIConfigMarker CUIConfig::AddMarker ( CEntity Entity )

◆ AddMarker() [2/4]

CUIConfigMarker CUIConfig::AddMarker ( CMapLandmark Landmark )

◆ AddMarker() [3/4]

CUIConfigMarker CUIConfig::AddMarker ( Ident GhostInstanceId )

◆ AddMarker() [4/4]

CUIConfigMarker CUIConfig::AddMarker ( Vec3 Position )

◆ ClearLayerManialinkAction()

Void CUIConfig::ClearLayerManialinkAction ( CUILayer Layer )

◆ ClearMarkers()

Void CUIConfig::ClearMarkers ( )

◆ ClearMessages()

Void CUIConfig::ClearMessages ( )

◆ GetLayerManialinkAction()

Text CUIConfig::GetLayerManialinkAction ( CUILayer Layer )

◆ QueueMessage() [1/3]

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

◆ QueueMessage() [2/3]

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

◆ QueueMessage() [3/3]

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

◆ RemoveMarker()

Void CUIConfig::RemoveMarker ( CUIConfigMarker Marker )

◆ SendChat()

Void CUIConfig::SendChat ( Text Text )

◆ SendNotice()

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

◆ Spectator_SetAutoTarget_All()

Void CUIConfig::Spectator_SetAutoTarget_All ( )

◆ Spectator_SetAutoTarget_Clear()

Void CUIConfig::Spectator_SetAutoTarget_Clear ( )

◆ Spectator_SetAutoTarget_User()

Void CUIConfig::Spectator_SetAutoTarget_User ( CUser User )

◆ Spectator_SetForcedTarget_AllMap()

Void CUIConfig::Spectator_SetForcedTarget_AllMap ( )

◆ Spectator_SetForcedTarget_AllPlayers()

Void CUIConfig::Spectator_SetForcedTarget_AllPlayers ( )

◆ Spectator_SetForcedTarget_Clan()

Void CUIConfig::Spectator_SetForcedTarget_Clan ( Integer ClanNumber )

◆ Spectator_SetForcedTarget_Clear()

Void CUIConfig::Spectator_SetForcedTarget_Clear ( )

◆ Spectator_SetForcedTarget_Entity()

Void CUIConfig::Spectator_SetForcedTarget_Entity ( CEntity Entity )

◆ Spectator_SetForcedTarget_Ghost()

Void CUIConfig::Spectator_SetForcedTarget_Ghost ( Ident GhostInstanceId )

Only in local scripts, since ghosts are only known on the client.

◆ Spectator_SetForcedTarget_Landmark()

Void CUIConfig::Spectator_SetForcedTarget_Landmark ( CMapLandmark Landmark )

Member Data Documentation

◆ AlliesLabelsMaxCount

Integer CUIConfig::AlliesLabelsMaxCount

Values in range (0 - 250)

◆ AlliesLabelsShowGauges

CUIConfig::EVisibility CUIConfig::AlliesLabelsShowGauges

◆ AlliesLabelsShowNames

CUIConfig::EVisibility CUIConfig::AlliesLabelsShowNames

◆ AlliesLabelsVisibility

CUIConfig::ELabelsVisibility CUIConfig::AlliesLabelsVisibility

◆ AltMenuNoCustomScores

Boolean CUIConfig::AltMenuNoCustomScores

◆ AltMenuNoDefaultScores

Boolean CUIConfig::AltMenuNoDefaultScores

◆ BigMessage

Text CUIConfig::BigMessage

◆ BigMessageAvatarLogin

Text CUIConfig::BigMessageAvatarLogin

◆ BigMessageAvatarVariant

CUIConfig::EAvatarVariant CUIConfig::BigMessageAvatarVariant

◆ BigMessageSound

CUIConfig::EUISound CUIConfig::BigMessageSound

◆ BigMessageSoundVariant

Integer CUIConfig::BigMessageSoundVariant

◆ CountdownCoord

Vec2 CUIConfig::CountdownCoord

◆ CountdownEndTime

Integer CUIConfig::CountdownEndTime

◆ DisableZoomTransitions

Boolean CUIConfig::DisableZoomTransitions

◆ DisplayControl_UseEsportsProgrammation

Boolean CUIConfig::DisplayControl_UseEsportsProgrammation

◆ DisplayControl_UseLiveCamera

Boolean CUIConfig::DisplayControl_UseLiveCamera

◆ ForceSpectator

Boolean CUIConfig::ForceSpectator

◆ GaugeClan

Integer CUIConfig::GaugeClan

◆ GaugeMessage

Text CUIConfig::GaugeMessage

◆ GaugeRatio

Real CUIConfig::GaugeRatio

◆ LabelsVisibility

CUIConfig::EHudVisibility CUIConfig::LabelsVisibility

◆ LabelsVisibility_SkipMarkersOnly

Boolean CUIConfig::LabelsVisibility_SkipMarkersOnly

◆ ManialinkPage

Text CUIConfig::ManialinkPage

◆ Markers

Array<CUIConfigMarker* const > CUIConfig::Markers

◆ 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 :

label : a text to display
pos : a vector of 3 world coordinates desribing the position of the marker
playerlogin : alternatively, instead of using pos, you can use a player login. The marker will smoothly follow the player
playerid : similar to playerlogin. Fill it with Player.MarkerId. The marker will smoothly follow the player
box : a vector of 3 dimensions describing the size of the marked object (allows a better placement of the marker on the screen)
gauge : a Real. If between 0. and 1. a gauge will be shown undeneath the text
imageurl : a string. URL of an image to use
distmax : a real. The marker will disappear if the dist to it is greater than distmax
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

CUIConfig::ENoticeLevel CUIConfig::NoticesFilter_LevelToShowAsBigMessage

◆ OpposingTeamLabelsShowGauges

CUIConfig::EVisibility CUIConfig::OpposingTeamLabelsShowGauges

◆ OpposingTeamLabelsShowNames

CUIConfig::EVisibility CUIConfig::OpposingTeamLabelsShowNames

◆ OpposingTeamLabelsVisibility

CUIConfig::ELabelsVisibility CUIConfig::OpposingTeamLabelsVisibility

◆ OverlayChatLineCount

Integer CUIConfig::OverlayChatLineCount

Values in range (0 - 40)

◆ OverlayChatOffset

Vec2 CUIConfig::OverlayChatOffset

◆ OverlayChatWidthCoef

Real CUIConfig::OverlayChatWidthCoef

Values in range (0.100000-10.000000)

◆ OverlayHide321Go

Boolean CUIConfig::OverlayHide321Go

◆ OverlayHideChat

Boolean CUIConfig::OverlayHideChat

◆ OverlayHideConsumables

Boolean CUIConfig::OverlayHideConsumables

◆ OverlayHideCountdown

Boolean CUIConfig::OverlayHideCountdown

◆ OverlayHideCrosshair

Boolean CUIConfig::OverlayHideCrosshair

◆ OverlayHideEndMapLadderRecap

Boolean CUIConfig::OverlayHideEndMapLadderRecap

◆ OverlayHideGauges

Boolean CUIConfig::OverlayHideGauges

◆ OverlayHideMapInfo

Boolean CUIConfig::OverlayHideMapInfo

◆ OverlayHideNotices

Boolean CUIConfig::OverlayHideNotices

◆ OverlayHideSpectatorInfos

Boolean CUIConfig::OverlayHideSpectatorInfos

◆ OverlayMute321Go

Boolean CUIConfig::OverlayMute321Go

◆ OverlayScoreSummary

Boolean CUIConfig::OverlayScoreSummary

◆ OverrideMarkers

Boolean CUIConfig::OverrideMarkers

If True, the markers of this UI config overrides the markers of more generic UI configs. If False they are merged.

◆ PlayerDisableFreeCam

Boolean CUIConfig::PlayerDisableFreeCam

◆ 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

CUIConfig::EVisibility CUIConfig::ScoreTableVisibility

◆ ScreenIn3dHideScoreSummary

Boolean CUIConfig::ScreenIn3dHideScoreSummary

◆ ScreenIn3dHideVersus

Boolean CUIConfig::ScreenIn3dHideVersus

◆ SmallScoreTable

Text CUIConfig::SmallScoreTable

◆ SmallScoreTableVisibility

CUIConfig::EVisibility CUIConfig::SmallScoreTableVisibility

◆ SpectatorCamAutoLatitude

Real CUIConfig::SpectatorCamAutoLatitude

◆ SpectatorCamAutoLongitude

Real CUIConfig::SpectatorCamAutoLongitude

◆ SpectatorCamAutoRadius

Real CUIConfig::SpectatorCamAutoRadius

◆ SpectatorForceCameraType

Integer CUIConfig::SpectatorForceCameraType

◆ SpectatorObserverMode

CUIConfig::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

CUIConfig::EVisibility CUIConfig::TeamLabelsShowGauges

◆ TeamLabelsShowNames

CUIConfig::EVisibility CUIConfig::TeamLabelsShowNames

◆ TeamLabelsVisibility

CUIConfig::ELabelsVisibility CUIConfig::TeamLabelsVisibility

◆ UILayers

Array<CUILayer* const > CUIConfig::UILayers

◆ UISequence

CUIConfig::EUISequence CUIConfig::UISequence

◆ UISequence_CanSkipIntroMT

Boolean CUIConfig::UISequence_CanSkipIntroMT

◆ UISequence_CustomMTClip

Text CUIConfig::UISequence_CustomMTClip

◆ UISequence_CustomMTRefTime

Integer CUIConfig::UISequence_CustomMTRefTime

◆ UISequence_CutSceneStyle

CUIConfig::ECutSceneStyle CUIConfig::UISequence_CutSceneStyle

◆ UISequence_PodiumPlayersLose

Text CUIConfig::UISequence_PodiumPlayersLose

◆ UISequence_PodiumPlayersWin

Text CUIConfig::UISequence_PodiumPlayersWin

◆ UISequenceIsCompleted

Boolean const CUIConfig::UISequenceIsCompleted

◆ UIStatus

CUIConfig::EUIStatus CUIConfig::UIStatus

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

doc.h

Public Types

Public Member Functions

Public Attributes