CMlScriptIngame Class Reference

API for GameModes Manialinks. More...

#include <2024_10_30.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

Definition at line 10373 of file 2024_10_30.h.

Member Enumeration Documentation

EInGameMenuResult

enum CMlScriptIngame::EInGameMenuResult

Enumerator
Resume
Quit
NormalMenu
AdvancedMenu
ServerSettings

Definition at line 10378 of file 2024_10_30.h.

                           {
        Resume,
        Quit,
        NormalMenu,
        AdvancedMenu,
        ServerSettings,
    };

EUISound

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

Definition at line 10388 of file 2024_10_30.h.

                  {
        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,
    };

Member Function Documentation

CloseInGameMenu()

Void CMlScriptIngame::CloseInGameMenu

(

CMlScriptIngame::EInGameMenuResult

Result

)

CloseScoresTable()

Void CMlScriptIngame::CloseScoresTable

(

)

CopyServerLinkToClipBoard()

Void CMlScriptIngame::CopyServerLinkToClipBoard

(

)

JoinTeam1()

Void CMlScriptIngame::JoinTeam1

(

)

JoinTeam2()

Void CMlScriptIngame::JoinTeam2

(

)

PlayUiSound()

Void CMlScriptIngame::PlayUiSound	(	CMlScriptIngame::EUISound	Sound,
		Integer	SoundVariant,
		Real	Volume
	)

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

ShowCurChallengeCard()

Void CMlScriptIngame::ShowCurChallengeCard

(

)

ShowInGameMenu()

Void CMlScriptIngame::ShowInGameMenu

(

)

ShowModeHelp()

Void CMlScriptIngame::ShowModeHelp

(

)

ShowProfile()

Void CMlScriptIngame::ShowProfile

(

Text

Player

)

Member Data Documentation

ClientUI

CUIConfig* const CMlScriptIngame::ClientUI

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

Definition at line 10434 of file 2024_10_30.h.

CurrentServerDesc

Text CMlScriptIngame::CurrentServerDesc

Definition at line 10522 of file 2024_10_30.h.

CurrentServerJoinLink

Text CMlScriptIngame::CurrentServerJoinLink

Definition at line 10526 of file 2024_10_30.h.

CurrentServerLogin

Text CMlScriptIngame::CurrentServerLogin

Definition at line 10514 of file 2024_10_30.h.

CurrentServerModeName

Text CMlScriptIngame::CurrentServerModeName

Definition at line 10530 of file 2024_10_30.h.

CurrentServerName

Text CMlScriptIngame::CurrentServerName

Definition at line 10518 of file 2024_10_30.h.

GameTime

Integer CMlScriptIngame::GameTime

Definition at line 10422 of file 2024_10_30.h.

IsInGameMenuDisplayed

Boolean CMlScriptIngame::IsInGameMenuDisplayed

Definition at line 10510 of file 2024_10_30.h.

IsSpectator

Boolean CMlScriptIngame::IsSpectator

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

Definition at line 10438 of file 2024_10_30.h.

IsSpectatorClient

Boolean CMlScriptIngame::IsSpectatorClient

Client actually desires to spectate instead of playing.

Definition at line 10442 of file 2024_10_30.h.

Map

CMap* const CMlScriptIngame::Map

Definition at line 10458 of file 2024_10_30.h.

ParentApp

CManiaAppPlaygroundCommon* const CMlScriptIngame::ParentApp

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

Definition at line 10454 of file 2024_10_30.h.

Playground

CPlaygroundClient* const CMlScriptIngame::Playground

Definition at line 10426 of file 2024_10_30.h.

SplitScreenCount

Integer CMlScriptIngame::SplitScreenCount

Definition at line 10538 of file 2024_10_30.h.

SplitScreenIsHorizontal

Boolean CMlScriptIngame::SplitScreenIsHorizontal

Definition at line 10542 of file 2024_10_30.h.

SplitScreenNum

Integer CMlScriptIngame::SplitScreenNum

Definition at line 10534 of file 2024_10_30.h.

Teams

Array<CTeam const * const > CMlScriptIngame::Teams

Definition at line 10482 of file 2024_10_30.h.

UI

CUIConfig const* const CMlScriptIngame::UI

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

Definition at line 10430 of file 2024_10_30.h.

UseClans

Boolean CMlScriptIngame::UseClans

Definition at line 10446 of file 2024_10_30.h.

UseForcedClans

Boolean CMlScriptIngame::UseForcedClans

Definition at line 10450 of file 2024_10_30.h.

---

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

• Sources/2024_10_30.h