ManiaScript
Script language used in ManiaPlanet
 All Classes Namespaces Files Functions Variables Enumerations Enumerator
Public Types | Public Member Functions | Public Attributes | List of all members
CUIConfig Struct Reference

#include <big.h>

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  EObserverMode { Default, Forced, Forbidden, Manual }
 

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)
 

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

Enumerator
Default 
Sad 
Happy 
Enumerator
None 
Never 
Always 
WhenInFrustum 
WhenVisible 
WhenInMiddleOfScreen 
Enumerator
Default 
PlayerInfo 
PlayerWarning 
MapInfo 
MapWarning 
MatchInfo 
MatchWarning 
Enumerator
Default 
Forced 
Forbidden 
Manual 
Enumerator
None 
Playing 
Intro 
Outro 
Podium 
CustomMTClip 
EndRound 
PlayersPresentation 
UIInteraction 
RollingBackgroundIntro 
CustomMTClip_WithUIInteraction 
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 
Enumerator
None 
Normal 
Warning 
Error 
Official 
Enumerator
None 
Normal 
Manual 
ForcedHidden 
ForcedVisible 

Member Function Documentation

Void CUIConfig::ClearLayerManialinkAction ( CUILayer  Layer)
Text CUIConfig::GetLayerManialinkAction ( CUILayer  Layer)
Void CUIConfig::SendChat ( Text  Text)
Void CUIConfig::SendNotice ( Text  Text,
ENoticeLevel  Level,
CUser  Avatar,
EAvatarVariant  AvatarVariant,
EUISound  Sound,
Integer  SoundVariant 
)

Member Data Documentation

Integer CUIConfig::AlliesLabelsMaxCount

Values in range (0 - 250)

EVisibility CUIConfig::AlliesLabelsShowGauges
EVisibility CUIConfig::AlliesLabelsShowNames
ELabelsVisibility CUIConfig::AlliesLabelsVisibility
Boolean CUIConfig::AltMenuNoCustomScores
Boolean CUIConfig::AltMenuNoDefaultScores
Text CUIConfig::BigMessage
Text CUIConfig::BigMessageAvatarLogin
EAvatarVariant CUIConfig::BigMessageAvatarVariant
EUISound CUIConfig::BigMessageSound
Integer CUIConfig::BigMessageSoundVariant
Vec2 CUIConfig::CountdownCoord
Integer CUIConfig::CountdownEndTime
Boolean CUIConfig::ForceSpectator
Integer CUIConfig::GaugeClan
Text CUIConfig::GaugeMessage
Real CUIConfig::GaugeRatio
Text CUIConfig::ManialinkPage
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.
Boolean CUIConfig::NoticesFilter_HideMapInfo
Boolean CUIConfig::NoticesFilter_HideMapWarning
Boolean CUIConfig::NoticesFilter_HideMatchInfo
Boolean CUIConfig::NoticesFilter_HideMatchWarning
Boolean CUIConfig::NoticesFilter_HidePlayerInfo
Boolean CUIConfig::NoticesFilter_HidePlayerInfoIfNotMe
Boolean CUIConfig::NoticesFilter_HidePlayerWarning
Boolean CUIConfig::NoticesFilter_HidePlayerWarningIfNotMe
ENoticeLevel CUIConfig::NoticesFilter_LevelToShowAsBigMessage
EVisibility CUIConfig::OpposingTeamLabelsShowGauges
EVisibility CUIConfig::OpposingTeamLabelsShowNames
ELabelsVisibility CUIConfig::OpposingTeamLabelsVisibility
Boolean CUIConfig::OverlayChatHideAvatar
Integer CUIConfig::OverlayChatLineCount

Values in range (0 - 40)

Vec2 CUIConfig::OverlayChatOffset
Boolean CUIConfig::OverlayHide321Go
Boolean CUIConfig::OverlayHideBackground
Boolean CUIConfig::OverlayHideChat
Boolean CUIConfig::OverlayHideCheckPointList
Boolean CUIConfig::OverlayHideCheckPointTime
Boolean CUIConfig::OverlayHideChrono
Boolean CUIConfig::OverlayHideConsumables
Boolean CUIConfig::OverlayHideCountdown
Boolean CUIConfig::OverlayHideCrosshair
Boolean CUIConfig::OverlayHideEndMapLadderRecap
Boolean CUIConfig::OverlayHideGauges
Boolean CUIConfig::OverlayHideMapInfo
Boolean CUIConfig::OverlayHideMultilapInfos
Boolean CUIConfig::OverlayHideNotices
Boolean CUIConfig::OverlayHideOpponentsInfo
Boolean CUIConfig::OverlayHidePersonnalBestAndRank
Boolean CUIConfig::OverlayHidePosition
Boolean CUIConfig::OverlayHideRoundScores
Boolean CUIConfig::OverlayHideSpeedAndDist
Boolean CUIConfig::OverlayScoreSummary
Real CUIConfig::ScoreSummary_Gauge1
Real CUIConfig::ScoreSummary_Gauge2
Integer CUIConfig::ScoreSummary_MatchPoints1
Integer CUIConfig::ScoreSummary_MatchPoints2
Ident CUIConfig::ScoreSummary_Player1
Ident CUIConfig::ScoreSummary_Player2
Integer CUIConfig::ScoreSummary_Points1
Integer CUIConfig::ScoreSummary_Points2
Integer CUIConfig::ScoreSummary_RoundPoints1
Integer CUIConfig::ScoreSummary_RoundPoints2
Text CUIConfig::ScoreTable
Boolean CUIConfig::ScoreTableOnlyManialink
EVisibility CUIConfig::ScoreTableVisibility
Boolean CUIConfig::ScreenIn3dHideScoreSummary
Boolean CUIConfig::ScreenIn3dHideVersus
Text CUIConfig::SmallScoreTable
EVisibility CUIConfig::SmallScoreTableVisibility
Ident CUIConfig::SpectatorAutoTarget
Real CUIConfig::SpectatorCamAutoLatitude
Real CUIConfig::SpectatorCamAutoLongitude
Real CUIConfig::SpectatorCamAutoRadius
Integer CUIConfig::SpectatorForceCameraType
Integer CUIConfig::SpectatorForcedClan
Ident CUIConfig::SpectatorForcedTarget
EObserverMode CUIConfig::SpectatorObserverMode
Text CUIConfig::StatusMessage
EVisibility CUIConfig::TeamLabelsShowGauges
EVisibility CUIConfig::TeamLabelsShowNames
ELabelsVisibility CUIConfig::TeamLabelsVisibility
const CUILayer [] CUIConfig::UILayers
EUISequence CUIConfig::UISequence
Boolean CUIConfig::UISequence_CanSkipIntroMT
Text CUIConfig::UISequence_CustomMTClip
Integer CUIConfig::UISequence_CustomMTRefTime
Text CUIConfig::UISequence_PodiumPlayersLose
Text CUIConfig::UISequence_PodiumPlayersWin
const Boolean CUIConfig::UISequenceIsCompleted
EUIStatus CUIConfig::UIStatus

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