ManiaScript  2019-10-10
The script language used in ManiaPlanet gaming system
Public Types | Public Member Functions | Public Attributes | List of all members
CMlScript Struct Reference

#include <big.h>

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

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, 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 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 This is the base Manialink page interface.

Member Enumeration Documentation

◆ LinkType

Enumerator
ExternalBrowser 
ManialinkBrowser 
Goto 
ExternalFromId 
ManialinkFromId 
GotoFromId 

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,
CMlControl  AutoBackControl,
Integer  InputPriority 
)

◆ EnableMenuNavigation() [2/2]

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

◆ IsKeyPressed()

Boolean CMlScript::IsKeyPressed ( Integer  KeyCode)

◆ OpenLink()

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

◆ PreloadAll()

Void CMlScript::PreloadAll ( )

◆ PreloadImage()

Void CMlScript::PreloadImage ( Text  ImageUrl)

◆ SendCustomEvent()

Void CMlScript::SendCustomEvent ( Text  Type,
Text []  Data 
)

Send a custom event to the owner of the layer.

◆ TriggerPageAction()

Void CMlScript::TriggerPageAction ( Text  ActionString)

Member Data Documentation

◆ AnimMgr

const CAnimManager CMlScript::AnimMgr

◆ Audio

const CAudioManager CMlScript::Audio

◆ CurrentTime

const Integer CMlScript::CurrentTime

◆ DataFileMgr

const CDataFileMgr CMlScript::DataFileMgr

◆ Dbg_WarnOnDroppedEvents

Boolean CMlScript::Dbg_WarnOnDroppedEvents

◆ EnableMenuNavigationInputs

Boolean CMlScript::EnableMenuNavigationInputs

◆ Http

const CHttpManager CMlScript::Http

◆ Input

const CInputManager CMlScript::Input

◆ IsMenuNavigationForeground

const Boolean CMlScript::IsMenuNavigationForeground

◆ KeyDelete

const Boolean CMlScript::KeyDelete

◆ KeyDown

const Boolean CMlScript::KeyDown

◆ KeyLeft

const Boolean CMlScript::KeyLeft

◆ KeyReturn

const Boolean CMlScript::KeyReturn

◆ KeyRight

const Boolean CMlScript::KeyRight

◆ KeySpace

const Boolean CMlScript::KeySpace

◆ KeyUp

const Boolean CMlScript::KeyUp

◆ LoadedTitle

const CTitle CMlScript::LoadedTitle

◆ LocalUser

const CUser CMlScript::LocalUser

Local user structure.

◆ MouseLeftButton

const Boolean CMlScript::MouseLeftButton

◆ MouseMiddleButton

const Boolean CMlScript::MouseMiddleButton

◆ MouseRightButton

const Boolean CMlScript::MouseRightButton

◆ MouseX

const Real CMlScript::MouseX

◆ MouseY

const Real CMlScript::MouseY

◆ Now

const Integer CMlScript::Now

◆ Page

const CMlPage CMlScript::Page

◆ PageAlwaysUpdateScript

Boolean CMlScript::PageAlwaysUpdateScript

◆ PageIsVisible

const Boolean CMlScript::PageIsVisible

◆ PendingEvents

const CMlScriptEvent [] CMlScript::PendingEvents

◆ Period

const Integer CMlScript::Period

◆ ScoreMgr

const CScoreMgr CMlScript::ScoreMgr

◆ System

const CSystemPlatform CMlScript::System

◆ Video

const CVideoManager CMlScript::Video

◆ Xml

const CParsingManager CMlScript::Xml

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