UNPKG

@maniascript/api

Version:

Maniascript API generator

1,507 lines (1,506 loc) 1.6 MB
export const api = { "classNames": [ "CMlScript", "CMlEntry", "CMlFileEntry", "CMlTextEdit", "CMlLabel", "CMlMediaPlayer", "CMlQuad", "CMlGauge", "CMlGraph", "CMlMinimap", "CMlCamera", "CMlBrowser", "CManiaApp", "CManiaAppTitleLayer", "CManiaAppEvent", "CManiaAppTitle", "CManiaAppPlayground", "CManiaAppStation", "CModulePlayground", "CModulePlaygroundInventory", "CModulePlaygroundStore", "CModulePlaygroundScoresTable", "CModulePlaygroundChrono", "CModulePlaygroundSpeedMeter", "CModulePlaygroundPlayerState", "CModulePlaygroundTeamState", "CModuleMenu", "CModuleMenuComponent", "CModuleMenuLayer", "CModuleMenuFileBrowser", "CStation", "CMlStation", "CEditorMainPlugin", "CAnyEditorPlugin", "CMapEditorPlugin", "CMapEditorPluginLayer", "CBadgeEditor", "CServerPlugin", "CSmMode", "CSmMlScriptIngame", "CSmAction", "CSmMapType", "CTmMlScriptIngame", "CTmMode", "CTmMapType", "CTrackManiaAppPlayground", "CNod", "CMlPage", "CUser", "CTitle", "CMlScriptEvent", "CParsingManager", "CHttpManager", "CVideoManager", "CAudioManager", "CInputManager", "CDataFileMgr", "CScoreMgr", "CAnimManager", "CSystemPlatform", "CMlControl", "CImage", "CMlGraphCurve", "CManiaAppBrowser", "CMap", "CUILayer", "CUserV2Manager", "CTitleControl", "CBaseConstEvent", "CTitleEdition", "CNotificationsConsumer", "CAchievementsManager", "CBadgeManager", "CMatchSettingsManager", "CManiaAppPlaygroundCommon", "CManiaAppBase", "CPackCreatorTitleInfo", "CEditorPluginHandle", "CEditorModule", "CEditorMesh", "CEditorEditor", "CMapEditorPluginEvent", "CMapEditorInventory", "CBlock", "CMacroblockModel", "CBlockModel", "CBlockClipList", "CMacroblockInstance", "CMapEditorCamera", "CMapEditorCursor", "CItemAnchor", "CMapEditorConnectResults", "CAnchorData", "CBadge", "CMapInfo", "CClient", "CScore", "CTeam", "CServerPluginEvent", "CUIConfigMgr", "CServerAdmin", "CXmlRpc", "CMode", "CSmPlayer", "CSmModeEvent", "CSmMapBase", "CSmMapLandmark", "CSmScore", "CSmObject", "CMlScriptIngame", "CModeVehicle", "CAction", "CSmActionEvent", "CMapType", "CTmMlPlayer", "CTmRaceClientEvent", "CTmScore", "CTmPlayer", "CTmModeEvent", "CMlFrame", "CParsingDocument", "CHttpRequest", "CHttpEvent", "CVideo", "CAudioSource", "CAudioSourceMusic", "CInputEvent", "CInputPad", "CTaskResult", "CCampaign", "CTaskResult_MapList", "CGhost", "CTaskResult_Ghost", "CTaskResult_ReplayList", "CTaskResult_GhostList", "CTaskResult_FileList", "CTaskResult_GameModeList", "CTaskResult_NaturalLeaderBoardInfoList", "CTaskResult_MapRecordList", "CTaskResult_BuddiesChallengeRecord", "CTaskResult_BuddiesChallengeRecordsComparison", "CTaskResult_BuddyChallengeRecordsComparison", "CTaskResult_RealLeaderBoardInfoList", "CPlug", "CUserV2Profile", "CTaskResult_StringIntList", "CServerInfo", "CPackCreator", "CNotificationsConsumerEvent", "CNotificationsConsumerNotification", "CAchievementsEvent", "CAchievementsAchievement", "CAchievementsStat", "CAchievementsAchievementDesc", "CAchievementsStatDesc", "CMatchSettings", "CManiaAppPlaygroundEvent", "CPlaygroundClient", "CUIConfig", "CEditorBase", "CModuleMenuModel", "CModuleMenuPageModel", "CModulePlaygroundHudModel", "CEditorPluginModuleEvent", "CEditorAsset", "CEditorEvent", "CMapEditorInventoryDirectory", "CMapEditorInventoryNode", "CMapEditorInventoryArticle", "CBlockUnit", "CCollector", "CBlockModelVariantGround", "CBlockModelVariantAir", "CBlockClip", "CUIConfigEvent", "CXmlRpcEvent", "CModulePlaygroundHud", "CModeTurretManager", "CModeVehicleManager", "CActionManager", "CPlayer", "CSmPlayerDriver", "CBaseEvent", "CEntity", "CSmBlockPole", "CMapLandmark", "CSmMapGate", "CSmMapGauge", "CTrackManiaScore", "CTmResult", "CParsingNode", "CMapGroup", "CReplayInfo", "CTaskResult_ModeInfo", "CTaskResult_NaturalLeaderBoardInfoList", "CNaturalLeaderBoardInfo", "CTaskResult_PlayerMapRecords", "CTaskResult_MapRecord", "CHighScoreComparison", "CHighScoreComparisonSummary", "CTaskResult_RealLeaderBoardInfoList", "CRealLeaderBoardInfo", "CVehicleSettings", "CPackCreatorPack", "CMatchSettingsPlaylistItem", "SHudModule", "CBlockUnitModel", "CBlockModelVariant", "CModeTurret", "CActionInterface", "CSmBlock", "CSmSector", "CSmGauge", "CMapSector", "CMapWaypoint", "CMapSpawn", "CMapBotPath", "CMapBotSpawn", "CMapObjectAnchor", "CPackCreatorRecipient", "CBlockModelClip", "CSmLandmark", "CSmBase" ], "namespaceNames": [ "MathLib", "TextLib", "MapUnits", "AnimLib", "TimeLib", "ColorLib" ], "classes": { "CMlScript": { "enums": { "LinkType": { "values": [ "ExternalBrowser", "ManialinkBrowser", "Goto", "ExternalFromId", "ManialinkFromId", "GotoFromId" ] } }, "functions": { "Dbg_SetProcessed": [ { "type": { "category": "literal", "name": "Void" }, "parameters": [ { "type": { "category": "class", "name": "CMlScriptEvent" }, "name": "Event" } ] } ], "IsKeyPressed": [ { "type": { "category": "literal", "name": "Boolean" }, "parameters": [ { "type": { "category": "literal", "name": "Integer" }, "name": "KeyCode" } ] } ], "EnableMenuNavigation": [ { "type": { "category": "literal", "name": "Void" }, "parameters": [ { "type": { "category": "literal", "name": "Boolean" }, "name": "EnableInputs" }, { "type": { "category": "literal", "name": "Boolean" }, "name": "WithAutoFocus" }, { "type": { "category": "class", "name": "CMlControl" }, "name": "AutoBackControl" }, { "type": { "category": "literal", "name": "Integer" }, "name": "InputPriority" } ] }, { "type": { "category": "literal", "name": "Void" }, "parameters": [ { "type": { "category": "literal", "name": "Boolean" }, "name": "EnableInputs" }, { "type": { "category": "literal", "name": "Boolean" }, "name": "WithAutoFocus" }, { "type": { "category": "literal", "name": "Boolean" }, "name": "WithManualScroll" }, { "type": { "category": "class", "name": "CMlControl" }, "name": "AutoBackControl" }, { "type": { "category": "literal", "name": "Integer" }, "name": "InputPriority" } ] } ], "OpenLink": [ { "type": { "category": "literal", "name": "Void" }, "parameters": [ { "type": { "category": "literal", "name": "Text" }, "name": "Url" }, { "type": { "category": "class", "name": "LinkType" }, "name": "LinkType" } ] } ], "TriggerPageAction": [ { "type": { "category": "literal", "name": "Void" }, "parameters": [ { "type": { "category": "literal", "name": "Text" }, "name": "ActionString" } ] } ], "SendCustomEvent": [ { "rawDocumentation": "/*!\nSend a custom event to the owner of the layer.\n*/", "documentation": { "description": "Send a custom event to the owner of the layer." }, "type": { "category": "literal", "name": "Void" }, "parameters": [ { "type": { "category": "literal", "name": "Text" }, "name": "Type" }, { "type": { "category": "array", "type": { "category": "literal", "name": "Text" } }, "name": "Data" } ] } ], "PreloadImage": [ { "type": { "category": "literal", "name": "Void" }, "parameters": [ { "type": { "category": "literal", "name": "Text" }, "name": "ImageUrl" } ] } ], "PreloadAll": [ { "type": { "category": "literal", "name": "Void" }, "parameters": [] } ], "Dbg_DumpDeclareForVariables": [ { "type": { "category": "literal", "name": "Text" }, "parameters": [ { "type": { "category": "class", "name": "CNod" }, "name": "Nod" }, { "type": { "category": "literal", "name": "Boolean" }, "name": "StatsOnly" } ] } ] }, "variables": { "Page": { "type": { "category": "class", "name": "CMlPage" }, "isConst": true }, "PageIsVisible": { "type": { "category": "literal", "name": "Boolean" }, "isConst": true }, "PageAlwaysUpdateScript": { "type": { "category": "literal", "name": "Boolean" } }, "Now": { "type": { "category": "literal", "name": "Integer" }, "isConst": true }, "Period": { "type": { "category": "literal", "name": "Integer" }, "isConst": true }, "CurrentTime": { "type": { "category": "literal", "name": "Integer" }, "isConst": true }, "LocalUser": { "rawDocumentation": "/*!\nLocal user structure.\n*/", "documentation": { "description": "Local user structure." }, "type": { "category": "class", "name": "CUser" }, "isConst": true }, "LoadedTitle": { "type": { "category": "class", "name": "CTitle" }, "isConst": true }, "PendingEvents": { "type": { "category": "array", "type": { "category": "class", "name": "CMlScriptEvent" } }, "isConst": true }, "Dbg_WarnOnDroppedEvents": { "type": { "category": "literal", "name": "Boolean" } }, "MouseX": { "type": { "category": "literal", "name": "Real" }, "isConst": true }, "MouseY": { "type": { "category": "literal", "name": "Real" }, "isConst": true }, "MouseLeftButton": { "type": { "category": "literal", "name": "Boolean" }, "isConst": true }, "MouseRightButton": { "type": { "category": "literal", "name": "Boolean" }, "isConst": true }, "MouseMiddleButton": { "type": { "category": "literal", "name": "Boolean" }, "isConst": true }, "KeyUp": { "type": { "category": "literal", "name": "Boolean" }, "isConst": true }, "KeyDown": { "type": { "category": "literal", "name": "Boolean" }, "isConst": true }, "KeyLeft": { "type": { "category": "literal", "name": "Boolean" }, "isConst": true }, "KeyRight": { "type": { "category": "literal", "name": "Boolean" }, "isConst": true }, "KeyReturn": { "type": { "category": "literal", "name": "Boolean" }, "isConst": true }, "KeySpace": { "type": { "category": "literal", "name": "Boolean" }, "isConst": true }, "KeyDelete": { "type": { "category": "literal", "name": "Boolean" }, "isConst": true }, "EnableMenuNavigationInputs": { "type": { "category": "literal", "name": "Boolean" } }, "IsMenuNavigationForeground": { "type": { "category": "literal", "name": "Boolean" }, "isConst": true }, "Xml": { "type": { "category": "class", "name": "CParsingManager" }, "isConst": true }, "Http": { "type": { "category": "class", "name": "CHttpManager" }, "isConst": true }, "Video": { "type": { "category": "class", "name": "CVideoManager" }, "isConst": true }, "Audio": { "type": { "category": "class", "name": "CAudioManager" }, "isConst": true }, "Input": { "type": { "category": "class", "name": "CInputManager" }, "isConst": true }, "DataFileMgr": { "type": { "category": "class", "name": "CDataFileMgr" }, "isConst": true }, "ScoreMgr": { "type": { "category": "class", "name": "CScoreMgr" }, "isConst": true }, "AnimMgr": { "type": { "category": "class", "name": "CAnimManager" }, "isConst": true }, "System": { "type": { "category": "class", "name": "CSystemPlatform" }, "isConst": true } }, "parent": "CNod", "rawDocumentation": "/*!\nSupported declare modes : Local Persistent \nThis is the base Manialink page interface.\n*/", "documentation": { "description": "Supported declare modes : Local Persistent This is the base Manialink page interface." } }, "CMlEntry": { "enums": { "ETextFormat": { "values": [ "Basic", "Script", "Password", "Newpassword" ] } }, "functions": { "StartEdition": [ { "type": { "category": "literal", "name": "Void" }, "parameters": [] } ], "SetText": [ { "type": { "category": "literal", "name": "Void" }, "parameters": [ { "type": { "category": "literal", "name": "Text" }, "name": "NewText" }, { "type": { "category": "literal", "name": "Boolean" }, "name": "SendSubmitEvent" } ] } ] }, "variables": { "Value": { "type": { "category": "literal", "name": "Text" } }, "TextFormat": { "type": { "category": "class", "name": "ETextFormat" } }, "Opacity": { "type": { "category": "literal", "name": "Real" } }, "TextColor": { "type": { "category": "literal", "name": "Vec3" } }, "TextSizeReal": { "type": { "category": "literal", "name": "Real" } }, "MaxLine": { "type": { "category": "literal", "name": "Integer" } }, "AutoNewLine": { "type": { "category": "literal", "name": "Boolean" } } }, "parent": "CMlControl", "rawDocumentation": "/*!\nSupported declare modes : Local \nManialink entry.\n*/", "documentation": { "description": "Supported declare modes : Local Manialink entry." } }, "CMlFileEntry": { "functions": { "ClearFileNames": [ { "type": { "category": "literal", "name": "Void" }, "parameters": [] } ] }, "variables": { "OnlyUserFiles": { "type": { "category": "literal", "name": "Boolean" } }, "FullFileName": { "type": { "category": "literal", "name": "Text" }, "isConst": true }, "RelativeNameToRoot": { "type": { "category": "literal", "name": "Text" }, "isConst": true }, "RelativeNameToTypeFolder": { "type": { "category": "literal", "name": "Text" }, "isConst": true } }, "parent": "CMlEntry", "rawDocumentation": "/*!\nSupported declare modes : Local \nManialink filename entry.\n*/", "documentation": { "description": "Supported declare modes : Local Manialink filename entry." } }, "CMlTextEdit": { "enums": { "EControlScriptEditorTextFormat": { "values": [ "Basic", "Script", "Password", "Newpassword" ] } }, "functions": { "StartEdition": [ { "type": { "category": "literal", "name": "Void" }, "parameters": [] } ] }, "variables": { "Value": { "type": { "category": "literal", "name": "Text" } }, "MaxLine": { "type": { "category": "literal", "name": "Integer" } }, "AutoNewLine": { "type": { "category": "literal", "name": "Boolean" } }, "ShowLineNumbers": { "type": { "category": "literal", "name": "Boolean" } }, "LineSpacing": { "type": { "category": "literal", "name": "Real" } }, "ValueLineCount": { "type": { "category": "literal", "name": "Integer" }, "isConst": true }, "Opacity": { "type": { "category": "literal", "name": "Real" } }, "TextColor": { "type": { "category": "literal", "name": "Vec3" } }, "TextSizeReal": { "type": { "category": "literal", "name": "Real" } }, "TextFormat": { "type": { "category": "class", "name": "EControlScriptEditorTextFormat" } } }, "parent": "CMlControl", "rawDocumentation": "/*!\nSupported declare modes : Local \nManialink entry.\n*/", "documentation": { "description": "Supported declare modes : Local Manialink entry." } }, "CMlLabel": { "enums": { "EBlendMode": { "values": [ "Default", "Add" ] } }, "functions": { "SetText": [ { "type": { "category": "literal", "name": "Void" }, "parameters": [ { "type": { "category": "literal", "name": "Text" }, "name": "NewText" } ] } ], "ComputeWidth": [ { "type": { "category": "literal", "name": "Real" }, "parameters": [ { "type": { "category": "literal", "name": "Text" }, "name": "Text" } ] }, { "type": { "category": "literal", "name": "Real" }, "parameters": [ { "type": { "category": "literal", "name": "Text" }, "name": "Text" }, { "type": { "category": "literal", "name": "Boolean" }, "name": "Translated" } ] } ], "ComputeHeight": [ { "type": { "category": "literal", "name": "Real" }, "parameters": [ { "type": { "category": "literal", "name": "Text" }, "name": "Text" } ] } ] }, "variables": { "Style": { "type": { "category": "literal", "name": "Text" } }, "Substyle": { "type": { "category": "literal", "name": "Text" } }, "TextFont": { "type": { "category": "literal", "name": "Text" } }, "Value": { "type": { "category": "literal", "name": "Text" } }, "ValueLineCount": { "type": { "category": "literal", "name": "Integer" }, "isConst": true }, "MaxLine": { "type": { "category": "literal", "name": "Integer" } }, "LineSpacing": { "type": { "category": "literal", "name": "Real" } }, "AppendEllipsis": { "type": { "category": "literal", "name": "Boolean" } }, "AutoNewLine": { "type": { "category": "literal", "name": "Boolean" } }, "Opacity": { "type": { "category": "literal", "name": "Real" } }, "TextColor": { "type": { "category": "literal", "name": "Vec3" } }, "TextSizeReal": { "type": { "category": "literal", "name": "Real" } }, "Blend": { "type": { "category": "class", "name": "EBlendMode" } } }, "parent": "CMlControl", "rawDocumentation": "/*!\nSupported declare modes : Local \nManialink entry.\n*/", "documentation": { "description": "Supported declare modes : Local Manialink entry." } }, "CMlMediaPlayer": { "functions": { "Play": [ { "type": { "category": "literal", "name": "Void" }, "parameters": [] } ], "Stop": [ { "type": { "category": "literal", "name": "Void" }, "parameters": [] } ], "StopAndRewind": [ { "type": { "category": "literal", "name": "Void" }, "parameters": [] } ] }, "variables": { "IsInitPlay": { "type": { "category": "literal", "name": "Boolean" } }, "Music": { "type": { "category": "literal", "name": "Boolean" } }, "IsLooping": { "type": { "category": "literal", "name": "Boolean" } }, "Volume": { "type": { "category": "literal", "name": "Real" } }, "Url": { "type": { "category": "literal", "name": "Text" } } }, "parent": "CMlControl", "rawDocumentation": "/*!\nSupported declare modes : Local \nManialink control.\n*/", "documentation": { "description": "Supported declare modes : Local Manialink control." } }, "CMlQuad": { "enums": { "EKeepRatioMode": { "values": [ "Inactive", "Clip", "Fit" ] }, "EBlendMode": { "values": [ "Default", "Add" ] } }, "functions": { "ChangeImageUrl": [ { "type": { "category": "literal", "name": "Void" }, "parameters": [ { "type": { "category": "literal", "name": "Text" }, "name": "fieldName" } ] } ], "RefreshImages": [ { "type": { "category": "literal", "name": "Void" }, "parameters": [] } ] }, "variables": { "Image": { "type": { "category": "class", "name": "CImage" } }, "ImageUrl": { "type": { "category": "literal", "name": "Text" } }, "ImageUrlFocus": { "type": { "category": "literal", "name": "Text" } }, "Style": { "type": { "category": "literal", "name": "Text" } }, "Substyle": { "type": { "category": "literal", "name": "Text" } }, "StyleSelected": { "type": { "category": "literal", "name": "Boolean" } }, "DownloadInProgress": { "type": { "category": "literal", "name": "Boolean" }, "isConst": true }, "Colorize": { "type": { "category": "literal", "name": "Vec3" } }, "ModulateColor": { "type": { "category": "literal", "name": "Vec3" } }, "BgColor": { "type": { "category": "literal", "name": "Vec3" } }, "BgColorFocus": { "type": { "category": "literal", "name": "Vec3" } }, "Opacity": { "type": { "category": "literal", "name": "Real" } }, "KeepRatio": { "type": { "category": "class", "name": "EKeepRatioMode" } }, "Blend": { "type": { "category": "class", "name": "EBlendMode" } } }, "parent": "CMlControl", "rawDocumentation": "/*!\nSupported declare modes : Local \n\n*/", "documentation": { "description": "Supported declare modes : Local" } }, "CMlGauge": { "functions": { "SetRatio": [ { "type": { "category": "literal", "name": "Void" }, "parameters": [ { "type": { "category": "literal", "name": "Real" }, "name": "NewRatio" } ] } ], "SetClan": [ { "type": { "category": "literal", "name": "Void" }, "parameters": [ { "type": { "category": "literal", "name": "Integer" }, "name": "NewClan" } ] } ] }, "variables": { "Style": { "type": { "category": "literal", "name": "Text" } }, "Ratio": { "rawDocumentation": "/*!\nValues in range (0.000000-1.000000)\n*/", "documentation": { "description": "Values in range (0.000000-1.000000)" }, "type": { "category": "literal", "name": "Real" } }, "GradingRatio": { "rawDocumentation": "/*!\nValues in range (0.000000-1.000000)\n*/", "documentation": { "description": "Values in range (0.000000-1.000000)" }, "type": { "category": "literal", "name": "Real" } }, "Clan": { "type": { "category": "literal", "name": "Integer" } }, "Color": { "type": { "category": "literal", "name": "Vec3" } }, "DrawBackground": { "type": { "category": "literal", "name": "Boolean" } }, "DrawBlockBackground": { "type": { "category": "literal", "name": "Boolean" } }, "CenteredBar": { "type": { "category": "literal", "name": "Boolean" } } }, "parent": "CMlControl", "rawDocumentation": "/*!\nSupported declare modes : Local \nManialink control.\n*/", "documentation": { "description": "Supported declare modes : Local Manialink control." } }, "CMlGraph": { "functions": { "AddCurve": [ { "type": { "category": "class", "name": "CMlGraphCurve" }, "parameters": [] } ], "RemoveCurve": [ { "type": { "category": "literal", "name": "Void" }, "parameters": [ { "type": { "category": "class", "name": "CMlGraphCurve" }, "name": "Curve" } ] } ] }, "variables": { "CoordsMin": { "type": { "category": "literal", "name": "Vec2" } }, "CoordsMax": { "type": { "category": "literal", "name": "Vec2" } }, "Curves": { "type": { "category": "array", "type": { "category": "class", "name": "CMlGraphCurve" } } } }, "parent": "CMlControl", "rawDocumentation": "/*!\nSupported declare modes : Local \nManialink control.\n*/", "documentation": { "description": "Supported declare modes : Local Manialink control." } }, "CMlMinimap": { "functions": { "Fog_SetAll": [ { "type": { "category": "literal", "name": "Void"