CMlScriptIngame Struct Reference

#include <doc.h>

Inheritance diagram for CMlScriptIngame:

Public Types
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	EInGameMenuResult {   Resume , Quit , NormalMenu , AdvancedMenu ,   ServerSettings }
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 (EInGameMenuResult Result)
Void	CloseScoresTable ()
Void	PlayUiSound (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, LinkType LinkType)
Void	TriggerPageAction (Text ActionString)
Void	SendCustomEvent (Text Type, Text[] Data)
Void	PreloadImage (Text ImageUrl)
Void	PreloadAll ()
Text	Dbg_DumpDeclareForVariables (CNod Nod, Boolean StatsOnly)

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

Detailed Description

Supported declare modes : Local Persistent API for GameModes Manialinks

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 CMlScriptIngame::ClientUI

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

IsSpectator

const Boolean CMlScriptIngame::IsSpectator

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

IsSpectatorClient

const Boolean CMlScriptIngame::IsSpectatorClient

Client actually desires to spectate instead of playing.

ParentApp

const CManiaAppPlaygroundCommon CMlScriptIngame::ParentApp

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

UI

CUIConfig CMlScriptIngame::UI

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

---

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

• doc.h