MML Reference Docs

This page has the reference documentation for MML. This can also be found on the mml website https://mml.io/docs/reference

Elements

All of the MML Elements with available attributes and examples.

• <m-group>

  The m-group element can contain other MML tags, allowing all of them to be transformed as single item.

• <m-cube>

  The m-cube element is a primitive 3D cube that can be coloured. It is often used for debugging or initial development purposes.

• <m-sphere>

  The m-sphere element is a primitive 3D sphere that can be coloured. It is often used for debugging or initial development purposes.

• <m-cylinder>

  The m-cylinder element is a primitive 3D cylinder that can be coloured. It is often used for debugging or initial development purposes.

• <m-light>

  The m-light element is a light that supports various types (e.g. point, spotlight) and can be coloured.

• <m-plane>

  The m-plane element is a primitive 3D plane that can be coloured.

• <m-model>

  The m-model element is a 3D model. It can be used to load and display various 3D model file formats, such as OBJ, FBX, or GLTF, depending on the rendering engine being used. The model can be positioned, rotated, and scaled within the 3D scene. It also supports animations.

• <m-character>

  The m-character element is a 3D character. It supports containing other m-model elements, allowing for composing a character from multiple models.

• <m-frame>

  The m-frame element is a 3D frame. It enables composing other MML documents into the document and transforming them as a unit.

• <m-audio>

  The m-audio element is used to play audio in a 3D scene.

• <m-image>

  The m-image element is used to display an image in a 3D scene.

• <m-video>

  The m-video element is used to display a video in a 3D scene.

• <m-label>

  The m-label element is used to display text on a plane in a 3D scene.

• <m-position-probe>

  The m-position-probe element is used to request the position of a user (either camera or avatar depending upon the experience).

• <m-prompt>

  The m-prompt element is used to request a string from the user when the element is clicked in a 3D scene.

• <m-interaction>

  The m-interaction element is used to describe an action that a user can take at a point in 3D space.

• <m-chat-probe>

  The m-chat-probe element is used to receive messages from a chat system. Which chat system that is depends on the client implementation.

• <m-attr-anim>

  The m-attr-anim element is used to describe document time-synchronized changes to element attributes.

Events

All of the MML Event types and their properties.

• ConnectionEvent

  A class that extends Event | Event.

• MMLChatEvent

  A class that extends Event | Event.

• MMLClickEvent

  Received when a user clicks on a 3D object.

• MMLCollisionEndEvent

  Received when a user stops colliding with an element.

• MMLCollisionMoveEvent

  Received when a user moves the collision point they are colliding at on an element.

• MMLCollisionStartEvent

  Received when a user starts colliding with an element.

• MMLInteractionEvent

  Received when a user interacts with an m-interaction.

• MMLPositionEnterEvent

  Received when a user enters the range of an m-position-probe.

• MMLPositionLeaveEvent

  Received when a user leaves the range of an m-position-probe after having entered.

• MMLPositionMoveEvent

  Received when a user moves after having entered the range of an m-position-probe.

• MMLPromptEvent

  Received when a user triggers a prompt with a value.

• RemoteEvent

  A class that extends Event | Event.

You can go to the mml website to learn more about these comonents -> https://mml.io/docs/reference/elements/m-group