CSmMlScriptIngame Class Reference

Ingame Manialink API for ShootMania. More...

#include <doc.h>

Inheritance diagram for CSmMlScriptIngame:

Public Attributes
Integer	ArenaNow
CSmPlayer *const	InputPlayer
CSmPlayer *const	GUIPlayer
Array< CSmPlayer const *const >	Players
Array< CModeVehicle const *const >	Vehicles
Array< CSmScore const *const >	Scores
Array< const Integer >	ClanScores
Boolean	HideResumePlayingButton
Array< CSmMapBase const *const >	MapBases
Array< CSmMapLandmark const *const >	MapLandmarks
Array< CSmMapLandmark const *const >	MapLandmarks_PlayerSpawn
Array< CSmMapLandmark const *const >	MapLandmarks_Gauge
Array< CSmMapLandmark const *const >	MapLandmarks_Sector
Array< CSmMapLandmark const *const >	MapLandmarks_BotPath
Array< CSmMapLandmark const *const >	MapLandmarks_ObjectAnchor
Array< CSmMapLandmark const *const >	MapLandmarks_Gate
Array< CSmMapLandmark const *const >	MapLandmarks_Foundation
Public Attributes inherited from CMlScriptIngame
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

Additional Inherited Members
Public Types inherited from CMlScriptIngame
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 inherited from CMlScriptIngame
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)

Detailed Description

Ingame Manialink API for ShootMania.

Supported declare modes :

• Local
• Persistent

Member Data Documentation

ArenaNow

Integer CSmMlScriptIngame::ArenaNow

ClanScores

Array< const Integer> CSmMlScriptIngame::ClanScores

GUIPlayer

CSmPlayer* const CSmMlScriptIngame::GUIPlayer

Player currently targetted by the camera. Same as InputPlayer when playing. Can be null in freecam when there's no specific target.

HideResumePlayingButton

Boolean CSmMlScriptIngame::HideResumePlayingButton

InputPlayer

CSmPlayer* const CSmMlScriptIngame::InputPlayer

Player receiving the inputs. Null if spectating other players.

MapBases

Array<CSmMapBase const * const > CSmMlScriptIngame::MapBases

MapLandmarks

Array<CSmMapLandmark const * const > CSmMlScriptIngame::MapLandmarks

MapLandmarks_BotPath

Array<CSmMapLandmark const * const > CSmMlScriptIngame::MapLandmarks_BotPath

MapLandmarks_Foundation

Array<CSmMapLandmark const * const > CSmMlScriptIngame::MapLandmarks_Foundation

MapLandmarks_Gate

Array<CSmMapLandmark const * const > CSmMlScriptIngame::MapLandmarks_Gate

MapLandmarks_Gauge

Array<CSmMapLandmark const * const > CSmMlScriptIngame::MapLandmarks_Gauge

MapLandmarks_ObjectAnchor

Array<CSmMapLandmark const * const > CSmMlScriptIngame::MapLandmarks_ObjectAnchor

MapLandmarks_PlayerSpawn

Array<CSmMapLandmark const * const > CSmMlScriptIngame::MapLandmarks_PlayerSpawn

MapLandmarks_Sector

Array<CSmMapLandmark const * const > CSmMlScriptIngame::MapLandmarks_Sector

Players

Array<CSmPlayer const * const > CSmMlScriptIngame::Players

Scores

Array<CSmScore const * const > CSmMlScriptIngame::Scores

Vehicles

Array<CModeVehicle const * const > CSmMlScriptIngame::Vehicles

---

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

• doc.h