<m-interaction>

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

Try it

Attributes

  • range: float

    The range that this interaction can be used from in meters. Default value is 5 meters.

  • in-focus: boolean

    Whether the interaction must be in the direction of the camera to be used. Default value is true.

  • line-of-sight: boolean

    Whether the interaction must be visible to the camera to be used. Default value is false.

  • priority: int

    The priority of this interaction. Lower priority interactions will be shown first. Default value is 1.

  • prompt: string

    The prompt to be displayed when the interaction is presented to the user.

  • oninteract: script

    A script expression that is executed when the element is interacted with. Events are also dispatched to "interact" event listeners.

Attribute Groups

  • Attribute Group: debuggable

    • debug: boolean

      A boolean that indicates whether the element should be drawn with debug information (e.g. axes helper). Default value is false.

  • Attribute Group: transformable

    • x: float

      The position of the element along the X-axis in meters. Default value is 0.

    • y: float

      The position of the element along the Y-axis in meters. Default value is 0.

    • z: float

      The position of the element along the Z-axis in meters. Default value is 0.

    • rx: float

      The rotation of the element around the X-axis in degrees. Default value is 0.

    • ry: float

      The rotation of the element around the Y-axis in degrees. Default value is 0.

    • rz: float

      The rotation of the element around the Z-axis in degrees. Default value is 0.

    • sx: float

      The scale of the element along the X-axis. Default value is 1.

    • sy: float

      The scale of the element along the Y-axis. Default value is 1.

    • sz: float

      The scale of the element along the Z-axis. Default value is 1.

    • visible: boolean

      Whether the element is visible (true) or hidden (false) in the scene. Default value is true.

    • socket: string

      The name of a bone in the parent element's skeletal mesh to which this element will be attached. If not specified, the element will attach to the origin of its parent.

  • Attribute Group: coreattrs

    • id: ID

      A unique identifier for the element, used for selection and manipulation through scripting. It must be unique within the document.

    • class: string

      A space-separated list of class names that can be used for scripting purposes.

Examples

Multiple m-interactions

Multiple m-interactions can be present at once. The menu presents the available interactions. In this example the positions of the m-interaction elements differ to allow moving into range of multiple of the interactions or just a subset.

Compatibility Table

WEBUNREAL
m-interaction✓✓
range✓✓
in-focus✓✗
line-of-sight✓✗
priority✓✓
prompt✓✓
oninteract✓✓
debug✓✓
x✓✓
y✓✓
z✓✓
rx✓✓
ry✓✓
rz✓✓
sx✓✓
sy✓✓
sz✓✓
visible✓✓
socket✓✗
id✓✓
class✓✓