CMlScriptIngame Class Reference

API for GameModes Manialinks. More...

#include <doc.h>

Inheritance diagram for CMlScriptIngame:

Public Types
enum	EInGameMenuResult {   Resume , Quit , NormalMenu , AdvancedMenu ,   ServerSettings }
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 }
Public Types inherited from CMlScript
enum	LinkType {   ExternalBrowser , ManialinkBrowser , Goto , ExternalFromId ,   ManialinkFromId , GotoFromId }

Public Member Functions
Void	ShowCurChallengeCard ()
Void	ShowModeHelp ()
Void	CopyServerLinkToClipBoard ()
Void	JoinTeam1 ()
Void	JoinTeam2 ()
Void	RequestSpectatorClient (Boolean Spectator)
Void	SetSpectateTarget (Text Player)
Void	ShowProfile (Text Player)
Void	ShowInGameMenu ()
Void	CloseInGameMenu (CMlScriptIngame::EInGameMenuResult Result)
Void	CloseScoresTable ()
Void	PlayUiSound (CMlScriptIngame::EUISound Sound, Integer SoundVariant, Real Volume)
Public Member Functions inherited from CMlScript
Void	Dbg_SetProcessed (CMlScriptEvent Event)
Boolean	IsKeyPressed (Integer KeyCode)
Void	EnableMenuNavigation (Boolean EnableInputs, Boolean WithAutoFocus, CMlControl AutoBackControl, Integer InputPriority)
Void	EnableMenuNavigation (Boolean EnableInputs, Boolean WithAutoFocus, Boolean WithManualScroll, CMlControl AutoBackControl, Integer InputPriority)
Void	OpenLink (Text Url, CMlScript::LinkType LinkType)
Void	TriggerPageAction (Text ActionString)
Void	SendCustomEvent (Text Type, Array< Text > Data)
Void	PreloadImage (Text ImageUrl)
Void	PreloadAll ()
Text	Dbg_DumpDeclareForVariables (CNod Nod, Boolean StatsOnly)
Text	FilterProfanities (Text TextToFilter)

Public Attributes
Integer	GameTime
CPlaygroundClient *const	Playground
CUIConfig const *const	UI
CUIConfig *const	ClientUI
Boolean	IsSpectator
Boolean	IsSpectatorClient
Boolean	UseClans
Boolean	UseForcedClans
CManiaAppPlaygroundCommon *const	ParentApp
CMap *const	Map
Array< CTeam const *const >	Teams
Boolean	IsInGameMenuDisplayed
Text	CurrentServerLogin
Text	CurrentServerName
Text	CurrentServerDesc
Text	CurrentServerJoinLink
Text	CurrentServerModeName
Integer	SplitScreenNum
Integer	SplitScreenCount
Boolean	SplitScreenIsHorizontal
Public Attributes inherited from CMlScript
CMlPage *const	Page
Boolean const	PageIsVisible
Boolean	PageAlwaysUpdateScript
Integer const	Now
Integer const	Period
Integer const	CurrentTime
CUser *const	LocalUser
CTitle *const	LoadedTitle
Array< CMlScriptEvent *const >	PendingEvents
Boolean	Dbg_WarnOnDroppedEvents
Real const	MouseX
Real const	MouseY
Boolean const	MouseLeftButton
Boolean const	MouseRightButton
Boolean const	MouseMiddleButton
Boolean const	KeyUp
Boolean const	KeyDown
Boolean const	KeyLeft
Boolean const	KeyRight
Boolean const	KeyReturn
Boolean const	KeySpace
Boolean const	KeyDelete
Boolean	EnableMenuNavigationInputs
Boolean const	IsMenuNavigationForeground
CParsingManager *const	Xml
CHttpManager *const	Http
CVideoManager *const	Video
CAudioManager *const	Audio
CInputManager *const	Input
CDataFileMgr *const	DataFileMgr
CScoreMgr *const	ScoreMgr
CRankingsZoneMgr *const	ZoneMgr
CUserV2Manager *const	UserMgr
CAnimManager *const	AnimMgr
CMenuSceneManager *const	MenuSceneMgr
CSystemPlatform *const	System
CWSNotificationManager *const	WSNotificationMgr
Public Attributes inherited from CNod
Ident const	Id

Detailed Description

API for GameModes Manialinks.

Supported declare modes :

• Local
• Persistent

Member Function Documentation

RequestSpectatorClient()

Void CMlScriptIngame::RequestSpectatorClient

(

Boolean

Spectator

)

Request change of IsSpectatorClient (not immediate, and it may be refused).

SetSpectateTarget()

Void CMlScriptIngame::SetSpectateTarget

(

Text

Player

)

Set the spectated player, but do not switch to spectator mode automatically. Equivalent to numpad1/2/3/4

Member Data Documentation

ClientUI

CUIConfig* const CMlScriptIngame::ClientUI

Locally accessible by the client script to locally override settings from the server.

IsSpectator

Boolean CMlScriptIngame::IsSpectator

Is in spectator mode - may be only for a short time between rounds.

IsSpectatorClient

Boolean CMlScriptIngame::IsSpectatorClient

Client actually desires to spectate instead of playing.

ParentApp

CManiaAppPlaygroundCommon* const CMlScriptIngame::ParentApp

Will be Null if the script is not runing in a layer of an app.

UI

CUIConfig const* const CMlScriptIngame::UI

(read-only) UI actually displayed, as defined by the server.

---

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

• doc.h