ManiaScript Reference  2019-05
Public Types | Public Member Functions | Public Attributes | List of all members
CMapType Struct Reference
Inheritance diagram for CMapType:
CMapEditorPlugin CManiaApp CNod CSmMapType CTmMapType

Public Types

enum  ValidationStatus { NotValidable, Validable, Validated }
 
- Public Types inherited from CMapEditorPlugin
enum  CardinalDirections { North, East, South, West }
 
enum  PlaceMode {
  Unknown, Terraform, Block, Macroblock,
  Skin, CopyPaste, Test, Plugin,
  CustomSelection, OffZone, BlockProperty, Path,
  GhostBlock, Item, Light
}
 
enum  EditMode {
  Unknown, Place, FreeLook, Erase,
  Pick, SelectionAdd, SelectionRemove
}
 
enum  ShadowsQuality {
  NotComputed, VeryFast, Fast, Default,
  High, Ultra
}
 
enum  ValidationStatus { NotValidable, Validable, Validated }
 
- Public Types inherited from CManiaApp
enum  ELinkType { ExternalBrowser, ManialinkBrowser }
 

Public Member Functions

Void ClearMapMetadata ()
 
Void RequestEnterPlayground ()
 
Void RequestLeavePlayground ()
 
- Public Member Functions inherited from CMapEditorPlugin
Void ComputeShadows ()
 
Void ComputeShadows (ShadowsQuality ShadowsQuality)
 
Void DisplayDefaultSetObjectivesDialog ()
 
Boolean Undo ()
 
Boolean Redo ()
 
Void Help ()
 
Void Validate ()
 
Void AutoSave ()
 
Void Quit ()
 
Void QuickQuit ()
 
Void QuitAndSetResult (Text Type, Text[] Data)
 
Void QuickQuitAndSetResult (Text Type, Text[] Data)
 
Void TestMapFromStart ()
 
Void TestMapFromCoord (Int3 Coord, CardinalDirections Dir)
 
Void TestMapWithMode (Text RulesModeName)
 
Void TestMapWithMode_SplitScreen (Text RulesModeName)
 
Void TestMapWithMode_SplitScreen (Text RulesModeName, Integer ScreenCount)
 
Void TestMapWithMode_SplitScreen (Text RulesModeName, Integer ScreenCount, Integer FakeCount)
 
Void SaveMap (Text FileName)
 
Void SaveMap (Text FileName, Text Path)
 
Boolean GetRaceCamera (Vec3 Position, Real Yaw, Real Pitch, Real Roll, Real FovY)
 
Void RemoveAllBlocks ()
 
Void RemoveAllTerrain ()
 
Void RemoveAllOffZone ()
 
Void RemoveAllObjects ()
 
Void RemoveAll ()
 
Void RemoveAllBlocksAndTerrain ()
 
Void ShowCustomSelection ()
 
Void HideCustomSelection ()
 
Void CopyPaste_Copy ()
 
Void CopyPaste_Cut ()
 
Void CopyPaste_Remove ()
 
Void CopyPaste_SelectAll ()
 
Void CopyPaste_ResetSelection ()
 
Void OpenToolsMenu ()
 
Void EditMediatrackIngame ()
 
Void PreloadAllBlocks ()
 
Void PreloadAllItems ()
 
Boolean CanPlaceBlock (CBlockModel BlockModel, Int3 Coord, CardinalDirections Dir, Boolean OnGround, Integer VariantIndex)
 
Boolean PlaceBlock (CBlockModel BlockModel, Int3 Coord, CardinalDirections Dir)
 
Boolean CanPlaceBlock_NoDestruction (CBlockModel BlockModel, Int3 Coord, CardinalDirections Dir, Boolean OnGround, Integer VariantIndex)
 
Boolean PlaceBlock_NoDestruction (CBlockModel BlockModel, Int3 Coord, CardinalDirections Dir)
 
Boolean CanPlaceRoadBlocks (CBlockModel BlockModel, Int3 StartCoord, Int3 EndCoord)
 
Boolean PlaceRoadBlocks (CBlockModel BlockModel, Int3 StartCoord, Int3 EndCoord)
 
Boolean CanPlaceTerrainBlocks (CBlockModel BlockModel, Int3 StartCoord, Int3 EndCoord)
 
Boolean PlaceTerrainBlocks (CBlockModel BlockModel, Int3 StartCoord, Int3 EndCoord)
 
Boolean PlaceTerrainBlocks_NoDestruction (CBlockModel BlockModel, Int3 StartCoord, Int3 EndCoord)
 
Boolean CanPlaceMacroblock (CMacroblockModel MacroblockModel, Int3 Coord, CardinalDirections Dir)
 
Boolean PlaceMacroblock (CMacroblockModel MacroblockModel, Int3 Coord, CardinalDirections Dir)
 
Boolean CanPlaceMacroblock_NoDestruction (CMacroblockModel MacroblockModel, Int3 Coord, CardinalDirections Dir)
 
Boolean PlaceMacroblock_NoDestruction (CMacroblockModel MacroblockModel, Int3 Coord, CardinalDirections Dir)
 
Boolean CanPlaceMacroblock_NoTerrain (CMacroblockModel MacroblockModel, Int3 Coord, CardinalDirections Dir)
 
Boolean PlaceMacroblock_NoTerrain (CMacroblockModel MacroblockModel, Int3 Coord, CardinalDirections Dir)
 
Boolean RemoveMacroblock (CMacroblockModel MacroblockModel, Int3 Coord, CardinalDirections Dir)
 
Boolean RemoveMacroblock_NoTerrain (CMacroblockModel MacroblockModel, Int3 Coord, CardinalDirections Dir)
 
CBlock GetBlock (Int3 Coord)
 
Boolean IsBlockModelSkinnable (CBlockModel BlockModel)
 
Integer GetNbBlockModelSkins (CBlockModel BlockModel)
 
Text GetBlockModelSkin (CBlockModel BlockModel, Integer SkinIndex)
 
Text GetSkinDisplayName (Text SkinFileName)
 
Text GetBlockSkin (CBlock Block)
 
Void SetBlockSkin (CBlock Block, Text SkinFileName)
 
Boolean OpenBlockSkinDialog (CBlock Block)
 
Boolean RemoveBlock (Int3 Coord)
 
Boolean RemoveTerrainBlocks (Int3 StartCoord, Int3 EndCoord)
 
Integer GetBlockGroundHeight (CBlockModel BlockModel, Integer CoordX, Integer CoordZ, CardinalDirections Dir)
 
Integer GetGroundHeight (Integer CoordX, Integer CoordZ)
 
Int3 GetMouseCoordOnGround ()
 
Int3 GetMouseCoordAtHeight (Integer CoordY)
 
CBlock GetStartLineBlock ()
 
Boolean RemoveItem (CAnchorData Item)
 
Void CopyPaste_AddOrSubSelection (Int3 StartCoord, Int3 EndCoord)
 
Boolean CopyPaste_Symmetrize ()
 
Void SaveMacroblock (CMacroblockModel MacroblockModel)
 
CMacroblockModel GetMacroblockModelFromFilePath (Text MacroblockModelFilePath)
 
CBlockModel GetTerrainBlockModelFromName (Text TerrainBlockModelName)
 
CBlockModel GetBlockModelFromName (Text BlockModelName)
 
CBlockClipList CreateFrameClipList ()
 
CBlockClipList CreateFixedClipList ()
 
Void UnvalidateMetadata ()
 
Void UnvalidateGameplayInfo ()
 
Void UnvalidatePlayfield ()
 
Boolean RemoveMacroblock_NoTerrain_NoUnvalidate (CMacroblockModel MacroblockModel, Int3 Coord, CardinalDirections Dir)
 
Boolean PlaceMacroblock_NoTerrain_NoUnvalidate (CMacroblockModel MacroblockModel, Int3 Coord, CardinalDirections Dir)
 
CMacroblockInstance CreateMacroblockInstance (CMacroblockModel MacroblockModel, Int3 Coord, CardinalDirections Dir)
 
CMacroblockInstance CreateMacroblockInstance (CMacroblockModel MacroblockModel, Int3 Coord, CardinalDirections Dir, Integer UserData)
 
CMacroblockInstance CreateMacroblockInstance (CMacroblockModel MacroblockModel, Int3 Coord, CardinalDirections Dir, CBlockClipList DefaultClipList)
 
CMacroblockInstance CreateMacroblockInstance (CMacroblockModel MacroblockModel, Int3 Coord, CardinalDirections Dir, CBlockClipList DefaultClipList, Integer UserData)
 
CMacroblockInstance GetMacroblockInstanceFromOrder (Integer Order)
 
CMacroblockInstance GetMacroblockInstanceFromUnitCoord (Int3 Coord)
 
CMacroblockInstance GetLatestMacroblockInstance ()
 
CMacroblockInstance GetLatestMacroblockInstance (Integer Offset)
 
CMacroblockInstance GetMacroblockInstanceConnectedToClip (CBlockClip Clip)
 
Boolean RemoveMacroblockInstance (CMacroblockInstance MacroblockInstance)
 
Boolean RemoveMacroblockInstanceFromOrder (Integer Order)
 
Boolean RemoveMacroblockInstanceFromUnitCoord (Integer Order)
 
Boolean RemoveMacroblockInstancesByUserData (Integer UserData)
 
Void ResetAllMacroblockInstances ()
 
Integer GetMaxOrder ()
 
Boolean SetMapType (Text MapType)
 
Void SetMapStyle (Text MapStyle)
 
Text GetMapStyle ()
 
Void SetMapIsCreatedWithPartyEditor (Boolean IsCreatedWithPartyEditor)
 
Text GetAvailableMapName ()
 
- Public Member Functions inherited from CManiaApp
CUILayer UILayerCreate ()
 
Void UILayerDestroy (CUILayer Layer)
 
Void UILayerDestroyAll ()
 
Void LayerCustomEvent (CUILayer Layer, Text Type, Text[] Data)
 
Void OpenLink (Text Url, ELinkType LinkType)
 
Boolean OpenFileInExplorer (Text FileName)
 
Void Dialog_Message (Text Message)
 
Text Dbg_DumpDeclareForVariables (CNod Nod, Boolean StatsOnly)
 

Public Attributes

Boolean CustomEditAnchorData
 
ValidationStatus ValidationStatus
 
Text ValidabilityRequirementsMessage
 
Boolean ValidationEndRequested
 
Boolean ValidationEndNoConfirm
 
const Boolean IsSwitchedToPlayground
 
const CUIConfigMgr UIManager
 
const CUser [] Users
 
- Public Attributes inherited from CMapEditorPlugin
const CMapEditorPluginEvent [] PendingEvents
 
const CMap Map
 
const Text MapName
 
const Text MapFileName
 
const Boolean IsEditorReadyForRequest
 
Boolean HoldLoadingScreen
 
const ShadowsQuality CurrentShadowsQuality
 
const Boolean IsUltraShadowsQualityAvailable
 
PlaceMode PlaceMode
 
EditMode EditMode
 
Boolean UndergroundMode
 
Boolean BlockStockMode
 
Int3 CursorCoord
 
CardinalDirections CursorDir
 
CBlockModel CursorBlockModel
 
CBlockModel CursorTerrainBlockModel
 
CMacroblockModel CursorMacroblockModel
 
Real CameraVAngle
 
Real CameraHAngle
 
Real CameraToTargetDistance
 
Vec3 CameraTargetPosition
 
const Vec3 CameraPosition
 
Real ThumbnailCameraVAngle
 
Real ThumbnailCameraHAngle
 
Real ThumbnailCameraRoll
 
Real ThumbnailCameraFovY
 
Vec3 ThumbnailCameraPosition
 
Boolean EnableAirMapping
 
Boolean EnableMixMapping
 
const CItemAnchor [] Items
 
const Text [] MediatrackIngameClips
 
Integer MediatrackIngameEditedClipIndex
 
const CBlock [] Blocks
 
const CBlockModel [] BlockModels
 
const CBlockModel [] TerrainBlockModels
 
const CMacroblockModel [] MacroblockModels
 
const CBlockClipList [] FixedClipLists
 
const CBlockClipList [] FrameClipLists
 
const CBlockClipList [] MacroblockInstanceClipLists
 
CMacroblockInstance [] MacroblockInstances
 
const CAnchorData [] AnchorData
 
Int3 [] CustomSelectionCoords
 
Vec3 CustomSelectionRGB
 
Boolean EnableEditorInputsCustomProcessing
 
Boolean EnableCursorShowingWhenInterfaceIsFocused
 
Boolean HideEditorInterface
 
Boolean HideBlockHelpers
 
Boolean ShowPlacementGrid
 
Real CursorBrightnessFactor
 
Boolean HideAlwaysCursorDirectionalArrow
 
const Boolean IsTesting
 
const Boolean IsValidating
 
const Boolean EditorInputIsDown_Menu
 
const Boolean EditorInputIsDown_SwitchToRace
 
const Boolean EditorInputIsDown_Undo
 
const Boolean EditorInputIsDown_Redo
 
const Boolean EditorInputIsDown_CursorUp
 
const Boolean EditorInputIsDown_CursorRight
 
const Boolean EditorInputIsDown_CursorDown
 
const Boolean EditorInputIsDown_CursorLeft
 
const Boolean EditorInputIsDown_CursorRaise
 
const Boolean EditorInputIsDown_CursorLower
 
const Boolean EditorInputIsDown_CursorTurn
 
const Boolean EditorInputIsDown_CursorPick
 
const Boolean EditorInputIsDown_CursorPlace
 
const Boolean EditorInputIsDown_CursorDelete
 
const Boolean EditorInputIsDown_CameraUp
 
const Boolean EditorInputIsDown_CameraRight
 
const Boolean EditorInputIsDown_CameraDown
 
const Boolean EditorInputIsDown_CameraLeft
 
const Boolean EditorInputIsDown_CameraZoomNext
 
const Boolean EditorInputIsDown_Camera0
 
const Boolean EditorInputIsDown_Camera1
 
const Boolean EditorInputIsDown_Camera3
 
const Boolean EditorInputIsDown_Camera7
 
const Boolean EditorInputIsDown_Camera9
 
const Boolean EditorInputIsDown_PivotChange
 
const Boolean EditorInputIsDown_CursorTurnSlightly
 
const Boolean EditorInputIsDown_CursorTurnSlightlyAntiClockwise
 
const Boolean EditorInputIsDown_IconUp
 
const Boolean EditorInputIsDown_IconRight
 
const Boolean EditorInputIsDown_IconDown
 
const Boolean EditorInputIsDown_IconLeft
 
const Boolean EditorInputIsDown_RemoveAll
 
const Boolean EditorInputIsDown_Save
 
const Boolean EditorInputIsDown_SaveAs
 
const Boolean EditorInputIsDown_MapStyle
 
const Boolean EditorInputIsDown_ClassicMapEditor
 
const Real CollectionSquareSize
 
const Real CollectionSquareHeight
 
const Integer CollectionGroundY
 
const ValidationStatus ValidationStatus
 
Text ManialinkText
 
const CMlPage ManialinkPage
 
- Public Attributes inherited from CManiaApp
const Text ManiaAppUrl
 
const Text ManiaAppBaseUrl
 
const Integer Now
 
const Boolean IsVisible
 
Integer LayersDefaultManialinkVersion
 
const CUser LocalUser
 
const CTitle LoadedTitle
 
Boolean EnableMenuNavigationInputs
 
const CUILayer [] UILayers
 
const CParsingManager Xml
 
const CHttpManager Http
 
const CVideoManager Video
 
const CAudioManager Audio
 
const CInputManager Input
 
const CDataFileMgr DataFileMgr
 
const CScoreMgr ScoreMgr
 
const CUserV2Manager UserMgr
 
const CSystemPlatform System
 
- Public Attributes inherited from CNod
const Ident Id
 

Detailed Description

Supported declare modes : Local Persistent API for the plugins of the map editor.

Member Enumeration Documentation

◆ ValidationStatus

enum CMapType::ValidationStatus
Enumerator
NotValidable 
Validable 
Validated 

Member Function Documentation

◆ ClearMapMetadata()

Void CMapType::ClearMapMetadata ( )

◆ RequestEnterPlayground()

Void CMapType::RequestEnterPlayground ( )

◆ RequestLeavePlayground()

Void CMapType::RequestLeavePlayground ( )

Member Data Documentation

◆ CustomEditAnchorData

Boolean CMapType::CustomEditAnchorData

◆ IsSwitchedToPlayground

const Boolean CMapType::IsSwitchedToPlayground

◆ UIManager

const CUIConfigMgr CMapType::UIManager

◆ Users

const CUser [] CMapType::Users

◆ ValidabilityRequirementsMessage

Text CMapType::ValidabilityRequirementsMessage

◆ ValidationEndNoConfirm

Boolean CMapType::ValidationEndNoConfirm

◆ ValidationEndRequested

Boolean CMapType::ValidationEndRequested

◆ ValidationStatus

ValidationStatus CMapType::ValidationStatus