ManiaPlanet 3 ManiaScript Reference 2015.06.18.1510
A ManiaScript Reference of the ManiaPlanet 3 game (frozen installation). This is OUTDATED, and exists only for entertainment purposes.
Loading...
Searching...
No Matches
CMlScriptIngame Struct Reference

#include <doc.h>

Inheritance diagram for CMlScriptIngame:
[legend]

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 SetSpectateTarget (Text Player)
Void ShowProfile (Text Player)
Void ShowInGameMenu ()
Void PlayUiSound (EUISound Sound, Integer SoundVariant, Real Volume)
Void CloseInGameMenu (EInGameMenuResult Result)
Public Member Functions inherited from CMlScript
Boolean IsKeyPressed (Integer KeyCode)
Void EnableMenuNavigation (Boolean EnableInputs, Boolean WithAutoFocus, CMlControl AutoBackControl, Integer InputPriority)
Void OpenLink (Text Url, LinkType LinkType)
Void TriggerPageAction (Text ActionString)
Void SendCustomEvent (Text Type, Text[] Data)
Void PreloadImage (Text ImageUrl)

Public Attributes

const Integer GameTime
CUIConfig UI
CUIConfig ClientUI
Boolean IsSpectatorMode
const Boolean UseClans
const Boolean UseForcedClans
const CMap Map
const CTeam[] Teams
const Text CurrentServerLogin
const Text CurrentServerName
const Text CurrentServerJoinLink
const Text CurrentServerModeName
Public Attributes inherited from CMlScript
const CMlPage Page
const Boolean PageIsVisible
const Integer Now
const Integer Period
const Integer CurrentTime
const Text CurrentTimeText
const Text CurrentLocalDateText
const CUser LocalUser
const CTitle LoadedTitle
const CMlEvent[] PendingEvents
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 CXmlManager Xml
const CHttpManager Http
const CAudioManager Audio
Public Attributes inherited from CNod
const Ident Id

Detailed Description

Supported declare modes : Local Persistent API for GameModes Manialinks

Member Function Documentation

◆ SetSpectateTarget()

Void CMlScriptIngame::SetSpectateTarget ( Text Player)

Set the spectated player, but do not switch to spectator mode automatically. Equivalent to pavnum1/2/3/4

Member Data Documentation

◆ ClientUI

CUIConfig CMlScriptIngame::ClientUI

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

◆ IsSpectatorMode

Boolean CMlScriptIngame::IsSpectatorMode

Switch the player to spectator or back into playing

◆ 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: