ManiaScript Trackmania 2020  30/10/2024
CMlScript Class Reference

This is the base Manialink page interface. More...

#include <2024_10_30.h>

Inheritance diagram for CMlScript:
CNod CAnyEditorPluginLayer CGameScriptHandlerMediaTrack CManiaAppTitleLayer CMapEditorPluginLayer CMlBrowser CMlScriptIngame CMlStation CModuleMenuLayer CSmMlScriptIngame

Public Types

enum  LinkType {
  ExternalBrowser, ManialinkBrowser, Goto, ExternalFromId,
  ManialinkFromId, GotoFromId
}
 

Public Member Functions

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

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

This is the base Manialink page interface.

Supported declare modes :

  • Local
  • Persistent

Definition at line 74 of file 2024_10_30.h.

Member Enumeration Documentation

◆ LinkType

Enumerator
ExternalBrowser 
ManialinkBrowser 
Goto 
ExternalFromId 
ManialinkFromId 
GotoFromId 

Definition at line 79 of file 2024_10_30.h.

79  {
82  Goto,
85  GotoFromId,
86  };

Member Function Documentation

◆ Dbg_DumpDeclareForVariables()

Text CMlScript::Dbg_DumpDeclareForVariables ( CNod  Nod,
Boolean  StatsOnly 
)

◆ Dbg_SetProcessed()

Void CMlScript::Dbg_SetProcessed ( CMlScriptEvent  Event)

◆ EnableMenuNavigation() [1/2]

Void CMlScript::EnableMenuNavigation ( Boolean  EnableInputs,
Boolean  WithAutoFocus,
Boolean  WithManualScroll,
CMlControl  AutoBackControl,
Integer  InputPriority 
)

◆ EnableMenuNavigation() [2/2]

Void CMlScript::EnableMenuNavigation ( Boolean  EnableInputs,
Boolean  WithAutoFocus,
CMlControl  AutoBackControl,
Integer  InputPriority 
)

◆ FilterProfanities()

Text CMlScript::FilterProfanities ( Text  TextToFilter)

◆ IsKeyPressed()

Boolean CMlScript::IsKeyPressed ( Integer  KeyCode)

◆ OpenLink()

Void CMlScript::OpenLink ( Text  Url,
CMlScript::LinkType  LinkType 
)

◆ PreloadAll()

Void CMlScript::PreloadAll ( )

◆ PreloadImage()

Void CMlScript::PreloadImage ( Text  ImageUrl)

◆ SendCustomEvent()

Void CMlScript::SendCustomEvent ( Text  Type,
Array< Text Data 
)

Send a custom event to the owner of the layer.

◆ TriggerPageAction()

Void CMlScript::TriggerPageAction ( Text  ActionString)

Member Data Documentation

◆ AnimMgr

CAnimManager* const CMlScript::AnimMgr

Definition at line 246 of file 2024_10_30.h.

◆ Audio

CAudioManager* const CMlScript::Audio

Definition at line 222 of file 2024_10_30.h.

◆ CurrentTime

Integer const CMlScript::CurrentTime

Definition at line 110 of file 2024_10_30.h.

◆ DataFileMgr

CDataFileMgr* const CMlScript::DataFileMgr

Definition at line 230 of file 2024_10_30.h.

◆ Dbg_WarnOnDroppedEvents

Boolean CMlScript::Dbg_WarnOnDroppedEvents

Definition at line 130 of file 2024_10_30.h.

◆ EnableMenuNavigationInputs

Boolean CMlScript::EnableMenuNavigationInputs

Definition at line 186 of file 2024_10_30.h.

◆ Http

CHttpManager* const CMlScript::Http

Definition at line 214 of file 2024_10_30.h.

◆ Input

CInputManager* const CMlScript::Input

Definition at line 226 of file 2024_10_30.h.

◆ IsMenuNavigationForeground

Boolean const CMlScript::IsMenuNavigationForeground

Definition at line 198 of file 2024_10_30.h.

◆ KeyDelete

Boolean const CMlScript::KeyDelete

Definition at line 178 of file 2024_10_30.h.

◆ KeyDown

Boolean const CMlScript::KeyDown

Definition at line 158 of file 2024_10_30.h.

◆ KeyLeft

Boolean const CMlScript::KeyLeft

Definition at line 162 of file 2024_10_30.h.

◆ KeyReturn

Boolean const CMlScript::KeyReturn

Definition at line 170 of file 2024_10_30.h.

◆ KeyRight

Boolean const CMlScript::KeyRight

Definition at line 166 of file 2024_10_30.h.

◆ KeySpace

Boolean const CMlScript::KeySpace

Definition at line 174 of file 2024_10_30.h.

◆ KeyUp

Boolean const CMlScript::KeyUp

Definition at line 154 of file 2024_10_30.h.

◆ LoadedTitle

CTitle* const CMlScript::LoadedTitle

Definition at line 118 of file 2024_10_30.h.

◆ LocalUser

CUser* const CMlScript::LocalUser

Local user structure.

Definition at line 114 of file 2024_10_30.h.

◆ MenuSceneMgr

CMenuSceneManager* const CMlScript::MenuSceneMgr

Definition at line 250 of file 2024_10_30.h.

◆ MouseLeftButton

Boolean const CMlScript::MouseLeftButton

Definition at line 142 of file 2024_10_30.h.

◆ MouseMiddleButton

Boolean const CMlScript::MouseMiddleButton

Definition at line 150 of file 2024_10_30.h.

◆ MouseRightButton

Boolean const CMlScript::MouseRightButton

Definition at line 146 of file 2024_10_30.h.

◆ MouseX

Real const CMlScript::MouseX

Definition at line 134 of file 2024_10_30.h.

◆ MouseY

Real const CMlScript::MouseY

Definition at line 138 of file 2024_10_30.h.

◆ Now

Integer const CMlScript::Now

Definition at line 102 of file 2024_10_30.h.

◆ Page

CMlPage* const CMlScript::Page

Definition at line 90 of file 2024_10_30.h.

◆ PageAlwaysUpdateScript

Boolean CMlScript::PageAlwaysUpdateScript

Definition at line 98 of file 2024_10_30.h.

◆ PageIsVisible

Boolean const CMlScript::PageIsVisible

Definition at line 94 of file 2024_10_30.h.

◆ PendingEvents

Array<CMlScriptEvent* const > CMlScript::PendingEvents

Definition at line 122 of file 2024_10_30.h.

◆ Period

Integer const CMlScript::Period

Definition at line 106 of file 2024_10_30.h.

◆ ScoreMgr

CScoreMgr* const CMlScript::ScoreMgr

Definition at line 234 of file 2024_10_30.h.

◆ System

CSystemPlatform* const CMlScript::System

Definition at line 254 of file 2024_10_30.h.

◆ UserMgr

CUserV2Manager* const CMlScript::UserMgr

Definition at line 242 of file 2024_10_30.h.

◆ Video

CVideoManager* const CMlScript::Video

Definition at line 218 of file 2024_10_30.h.

◆ WSNotificationMgr

CWSNotificationManager* const CMlScript::WSNotificationMgr

Definition at line 258 of file 2024_10_30.h.

◆ Xml

CParsingManager* const CMlScript::Xml

Definition at line 210 of file 2024_10_30.h.

◆ ZoneMgr

CRankingsZoneMgr* const CMlScript::ZoneMgr

Definition at line 238 of file 2024_10_30.h.


The documentation for this class was generated from the following file:
CMlScript::ManialinkBrowser
@ ManialinkBrowser
Definition: 2024_10_30.h:81
CMlScript::ExternalBrowser
@ ExternalBrowser
Definition: 2024_10_30.h:80
CMlScript::Goto
@ Goto
Definition: 2024_10_30.h:82
CMlScript::ExternalFromId
@ ExternalFromId
Definition: 2024_10_30.h:83
CMlScript::ManialinkFromId
@ ManialinkFromId
Definition: 2024_10_30.h:84
CMlScript::GotoFromId
@ GotoFromId
Definition: 2024_10_30.h:85