General

Array Functions

• Integer .count: Returns the number of elements of the array.
• Boolean .exists(Value): Expects a value; returns True or False.
• Boolean .existskey(Key): Expects a key; returns True or False
• Boolean .remove(Value): Removes a value of the array; returns whether it was successful.
• Boolean .removekey(Key): Removes a key of the array; returns whether it was successful.
• .add(Value): Expects a value to add to the array.
• Array .sort(): No arguments; returns the sorted array.
• Key .keyof(Value): Expects a value of the array; returns the key of this value. If the value doesn't exist, it causes an error, so make sure you have checked it before with exists()

MathLib

• Real/Integer MathLib::Rand(Real/Integer, Real/Integer): Both arguments have to be either Real or Integer. First will return a random Integer between the first and second number, second will be the same, only with a Real.
• Integer MathLib::NearestInteger(Real): Examples: 1.3 -> 1; 1.5 -> 2
• Integer MathLib::CeilingInteger(Real): Example: 1.3 -> 2
• Integer MathLib::FloorInteger(Real): Example: 1.6 -> 1
• Real MathLib::Sin(Real): Example: 3.141593/2 -> 1
• Real MathLib::Cos(Real): Example: 3.141593 -> -1
• Real MathLib::Tan(Real): Example: 3.141593/4 -> 1
• Real MathLib::Exp(Real): Exp(x) equals e^x, where e is Euler's number.

TextLib

• Text TextLib::SubString(Text, Integer start, Integer length): Returns the portion of a Text where start is the first letter (0 is the first) and length is the length of the portion.
• Integer TextLib::Length(Text): Returns the length of a Text.
• Text TextLib::ToText(Integer/Real/Boolean/Int3/Vec3): Converts a lot of types to Text.
• Real TextLib::ToReal(Text): Converts a text to a real.
• Integer TextLib::ToInteger(Text): Converts a text to an integer.

Manialinks

Events

• Enum Event.Type: There are the following types:
  • CGameManialinkScriptEvent::Type::MouseClick
  • CGameManialinkScriptEvent::Type::MouseOver
  • CGameManialinkScriptEvent::Type::MouseOut
  • CGameManialinkScriptEvent::Type::KeyPress
  The mouse events occur only, if the corresponding Manialink element has the property ScriptEvents="1" set. The element doesn't need to have an id="".
• Text Event.ControlId: In case of the mouse events (MouseClick; MouseOver; MouseOut) this property has the id of the element. If the element doesn't have an id, the value is "Unassigned".
• Text Event.CharPressed: In case of KeyPress this property returns an unique number (which is a Text, however) of the key pressed, e.g. 327680, 393216. Those (decimal) numbers make more sense in a hexadecimal output. Shift, Ctrl and Alt won't cause an event and futhermore, there is no difference between a and A e.g. This event is always provoked, you don't need to have selected an entry or so. Even further, it is also provoked in the script editor or when you type in the address bar.

Page

• CGameManialinkControl Page.GetFirstChild(Text): Expects the id of a Manialink element. There doesn't need to be a ScriptEvents="1" for this, this is only for events (as the name says^^). GetFirstChild() is global over the Manialink: you can also address elements within a frame.
• CGameManialinkControl Page.MainFrame.Controls: The second possibility is MainFrame.Controls, which is an Array. That way you can also select elements by its id (Text), but also by the position it occurs in the Manialink (Integer). Examples:
  Page.MainFrame.Controls["myQuad"] Page.MainFrame.Controls[3] // Addresses the fourth element in the manialink
  With Controls you cannot address only elements on the same level, so no elements within a frame.

Element Classes

• Text Id: Id of the element; Normally only relevant for addressing elements by its position with Controls.
• Real PosnX: x-value of the element
• Real PosnY: y-value of the element
• Real PosnZ: z-value of the element
• AlignHorizontal HorizontalAlign: halign value. Has one of the following values:
  • CGameManialinkControl::AlignHorizontal::None (e.g. music/frame)
  • CGameManialinkControl::AlignHorizontal::Left
  • CGameManialinkControl::AlignHorizontal::HCenter
  • CGameManialinkControl::AlignHorizontal::Right
• AlignVertical VerticalAlign: valign value. Has one of the following values:
  • CGameManialinkControl::AlignVertical::None (e.g. music/frame)
  • CGameManialinkControl::AlignVertical::Top
  • CGameManialinkControl::AlignVertical::VCenter
  • CGameManialinkControl::AlignVertical::Bottom
• Hide(): Hides the element
• Show(): Shows the element (again)
• Unload(): Deletes the element. Using the variable afterwards will cause an error.

• Text ImageUrl: The image URL of a quad
• ChangeImageUrl(Text): Changes the image URL of a quad
• Boolean DownloadInProgress: A boolean which doesn't appear to work (is always False)

• Text Value: the value of an entry

• Text Value: the value of a fileentry
• Text FullFileName: the file name of a fileentry

• SetText(Text): Set a text to a label

• Controls: Like MainFrame.Controls - you can access elements in this frame on the same level with it.
• GetFirstChild(Text): Like Page.GetFirstChild() - you can access elements in this frame on the same level and also within frames with it.

Key and Mouse States

• Boolean MouseLeftButton
• Boolean MouseRightButton
• Boolean MouseMiddleButton
• Boolean KeyUp
• Boolean KeyDown
• Boolean KeyLeft
• Boolean KeyRight
• Boolean KeyReturn
• Boolean KeySpace (not working yet)
• Boolean KeyDelete (not working yet)

Other Variables and Functions

• OpenLink(Text url, LinkType): Opens a new Manialink or a website in an extern browser. There are 5 values of LinkType:
  • ::LinkType::Goto: Redirects to Manialink url
  • ::LinkType::ExternalBrowser: Opens the website url in your webbrowser
  • ::LinkType::ManialinkFromId: Redirects to the Manialink, whose name belongs to the Id url of your language in a dico. If the Id isn't found, nothing happens.
  • ::LinkType::GotoFromId: Redirects to the Manialink, whose name belongs to the Id url of your language in a dico. If the Id isn't found, nothing happens. (I don't know the difference to ::ManialinkFromId.)
  • ::LinkType::ExternalFromId: Opens the website, whose name belongs to the Id url of your language in a dico. If the Id isn't found, nothing happens.
  Relative links (e.g. "./index.xml") will not work. This function doesn't work in Editor Plugin Manialinks (nothing happens there). Example for Id usage:
  <dico><language id="en"> <manialink>exemple</manialink> </language></dico> <script><!-- OpenLink("manialink", ::LinkType::ManialinkFromId) // -> exemple --></script>
• Real MouseX and MouseY: Returns the position (Real) of the mouse in Manialink positioning of version="1", whether you use version="1" or not (in my case, hovering a version="0" element with x=10 resulted in MouseX=25).
• Text CurrentLocalDateText: Local date and time. Example: 2011/09/05 15:35:12
• Text CurrentTimeText: The time since ManiaPlanet has started. Syntax: (Hours:)Minutes:Seconds.Hundredths; Example: 3:15.20 or 1:33:29.82
• Integer CurrentTime: The number of milliseconds that have passed since ManiaPlanet has started.

Editor Plugins

Events

• CGameCtnEditorPluginScriptEvent::Type::CursorChange: When the position of the cursor changes.
• CGameCtnEditorPluginScriptEvent::Type::CursorSelectionBegin: When (starting) placing a block.
• CGameCtnEditorPluginScriptEvent::Type::CursorSelectionEnd: When (ending) placing a block.

Manialinks

• Text ManialinkText: Text to set a Manialink on the editor interface. There doesn't need to be a <manialink> and XML header. This Manialink can also have a <script> tag, of course.
• CGameManialinkPage ManialinkPage: To interact with ManiaScripts within the Manialink set with ManialinkText, you can declare variables for ManialinkPage. Example:
  declare Text var for ManialinkPage; ManialinkText = """<script><!-- declare Text var for Page; declare Text oldvar; while (True) { declare Text var for Page; if (var != oldvar) { log(var); log("Congratulations! You INTERACTED."); oldvar = var; } yield; } --></script>"""; var = "This variable has been changed"; while (True) { yield; }
  Redeclaring a variable reloads the variable.

Directions and Position

• ::CardinalDirections: Yes, this variable is called like this, with the double colon at the beginning.
  • ::North; ::East; ::South; ::West
• CursorCoord: An Int3 value with the current coordinate.
• CursorDir: The current cursor direction (Terrain blocks are always aligned to North).

MapUnits

• CardinalDirections MapUnits::GetNextDir(CardinalDirections): Returns the next direction in the order North-East-South-West (and then North again, of course)
• CardinalDirections MapUnits::GetPreviousDir(CardinalDirections): Returns the previous direction like GetNextDir()
• CardinalDirections MapUnits::GetOpposedDir(CardinalDirections): Returns the opposed direction (so East will become West e.g.)
• CardinalDirections MapUnits::AddDirs(CardinalDirections, CardinalDirections): Adds two directions. Assuming North is 0, East 1, South 2 and West 3 you just add their values (after West comes North again, of course).
• CardinalDirections MapUnits::SubDirs(CardinalDirections, CardinalDirections): Subtracts the first direction from the other (or the other way round?^^). Like AddDirs().
• Int3 MapUnits::GetNeighbourCoord(Int3, CardinalDirections): Returns the next coordinate looking into the CardinalDirection.
• Int3 MapUnits::GetRotatedOffset(Int3, CardinalDirections): Returns the coordinate in opposition to the direction. By name: North will leave the value as it is, East inverts the Z value, South inverts the X and Z value and West inverts the X value.
• Int3 MapUnits::GetRotatedOffsetPositive(Int3, CardinalDirections, Int3): I can't really tell you how it works, this function returns some kind of difference, but I don't know exactly.

Map

• Int3 Size == <32, 40, 32>. Always.
• Text MapName: The map name
• Text Comments: Map comments
• Text CollectionName: Environment
• Text AuthorLogin: Author login
• Text AuthorNickname: Author nickname
• Text AuthorZonePath: Author zone path
• Text CopperPrice: Map size
• CGameCtnChallengeParameters MapParameters: All properties are milliseconds.
  • Integer AuthorScore == AuthorTime apparently
  • Integer AuthorTime
  • Integer GoldTime
  • Integer SilverTime
  • Integer BronzeTime
  • Integer TimeLimit == 60000 normally

Block Models

• CGameCtnBlockInfo BlockModels[]: An array with all block models as a key; It returns the block model info. You can find a list of them in the links.
• CGameCtnBlockInfo TerrainBlockModels[]: An array with all terrain block models as a key; It returns the block model info.
• CGameCtnMacroBlockInfo MacroblockModels[]: An array with all macroblock models as a key; It returns the macroblock model info.
• CGameCtnBlockInfo CursorBlockModel: The information of the currently selected block model
• CGameCtnBlockInfo CursorTerrainBlockModel: The information of the currently selected terrain block model
• CGameCtnMacroBlockInfo CursorMacroblockModel: The information of the currently selected macroblock model

• Text Id: Name of the current block.
• CGameCtnBlockInfoVariant(Air?) VariantAir:
• CGameCtnBlockInfoVariant(Ground?) VariantGround:
• Boolean IsRoad: There is only one road block: 2-1-1 (the road block which you can drag)
• Boolean IsTerrain: To be terrain or not to be.

• Id: The name of the macro block
• Boolean IsGround: Whether it is on the ground (which means, can only be placed on the ground)
• Boolean HasStart: Whether it has a start (multilap start/finish doesn't count)
• Boolean HasFinish: Whether it has a finish (multilap start/finish doesn't count)
• Boolean HasCheckpoint: Whether it has a checkpoint
• Boolean IsPureTerrain: Whether it is terrain only
• CGameCtnBlockInfo GeneratedBlockModel

• Text Name: Either "Variant Air" or "Variant Ground"
• Boolean IsAllUnderground
• Boolean IsPartUnderground
• Int3 Size: Size of the block (also of a macroblock)

Block functions

• Boolean CanPlaceBlock(CGameCtnBlockInfo BlockModel, Int3 Coord, CardinalDirections Dir, Boolean OnGround, Integer VariantIndex): Returns whether a block can be placed at this position and direction or not. OnGround and VariantIndex is required and affected by the function, so you need to set them before:
  declare Boolean OnGround; declare Integer VariantIndex;
• Boolean PlaceBlock(CGameCtnBlockInfo BlockModel, Int3 Coord, CardinalDirections Dir): Tries to place a block. Returns whether it was successful or not (no, no error, if it doesn't work).
• Integer GetBlockGroundHeight(CGameCtnBlockInfo, Integer CoordX, Integer CoordZ, CardinalDirections Dir): Returns the block ground height.
• Boolean RemoveBlock(Int3 Coord): Removes a block at a certain position. Also, if the block is bigger than just one block place.
• Boolean CanPlaceBlock_NoDestruction()
• Boolean PlaceBlock_NoDestruction()
• Boolean CanPlaceTerrainBlocks(CGameCtnBlockInfo TerrainBlockModel, Int3 CoordStart, Int3 CoordEnd): Returns whether terrain of the kind of terrain block model can be placed at the range between the coordinates or not.
• Boolean PlaceTerrainBlocks(CGameCtnBlockInfo TerrainBlockModel, Int3 CoordStart, Int3 CoordEnd): Places terrain. Also on the second/third/... level.
• Boolean RemoveTerrainBlocks(Int3 CoordStart, Int3 CoordEnd): Removes terrain. Also returns True, if there isn't anything to remove.
• Boolean CanPlaceRoadBlocks(CGameCtnBlockInfo BlockModel, Int3 CoordStart, Int3 CoordStart): Returns whether road blocks can be placed here or not.
• Boolean PlaceRoadBlocks(CGameCtnBlockInfo BlockModel, Int3 CoordStart, Int3 CoordStart): This function is very buggy; It can crash the game and apparently places not the block given in the first argument but the block previously placed.
• CanPlaceMacroblock(CGameCtnMacroBlockInfo MacroblockModel, Int3 Coord, CardinalDirections Dir): Checks whether a macroblock can be placed there.
• PlaceMacroblock(CGameCtnMacroBlockInfo MacroblockModel, Int3 Coord, CardinalDirections Dir): Tries to place a macroblock model
• CanPlaceMacroblock_NoDestruction()
• PlaceMacroblock_NoDestruction()
• RemoveAllBlocks(): Removes all blocks, not the terrain.
• RemoveAllBlocksAndTerrain(): Removes all blocks and terrain.
• CGameCtnBlock GetBlock(Int3 Coord): Returns the block of the chosen position.
• CGameCtnBlock GetStartLineBlock(): Gets the block model of the start line. Or something^^

Place and Edit mode

• PlaceMode
  • Unknown, Terraform, Block, Macroblock, Skin, CopyPaste, Test, Plugin, CustomSelection
• EditMode
  • Unknown, Place, FreeLook, Erase, Pick, SelectionAdd, SelectionRemove
• Boolean UndergroundMode: Set or get whether the underground mode is activated
• (These are some functions concerning macroblocks)
  CopyPaste_Copy(), CopyPaste_Cut(), CopyPaste_SelectAll(), CopyPaste_ResetSelection()
• CopyPaste_AddOrSubSelection(Int3 StartCoord, Int3 EndCoord)
• Boolean CopyPaste_Symmetrize()

Other variables and functions

• SaveMap(Text FileName, Text Directory): Saves the map after a confirmation; Directory within Maps\
• ComputeShadows(): Does something like computing the shadows, but this doesn't replace the need to compute shadows when saving a challenge.
• Help(): Shows the track editor help window.
• Undo(): Equals Undo function in the editor.
• Redo(): Equals Redo function in the editor.
• Quit(): Quits the editor (and shows the confirmation if the map hasn't been saved).
• Real CameraHAngle and CameraVAngle: Returns the camera angle in radian. Range: H: -3/2π to 3/2π (yes, it is more than 2π); V: 0 to 1/2π
• Real CameraToTargetDistance: Distance to target (which means, to the point the camera is focussing on)
• Integer Now: Equivalent to Manialink CurrentTime

MediaTracker Camera Effect Scripts

Variables

• Vec3 OffsetPos: 0 is the x-, 1 the y- and 2 the z-position relatively to the actual camera position
• Vec3 OffsetRot: 0 is pitch, 1 is yaw and 2 is roll in radians relatively to the actual camera values
• Integer A, B and C: You can define these values when selecting an EffectScript element in the MT on the left
• Integer Now: The time in milliseconds since the MT trigger element started. You should use this always when changing the camera position or rotation.