<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).

Try it

Attributes

  • range: float

    The range from its position that the position probe requests user positions for in meters. Default value is 10 meters.

  • interval: int

    The time in milliseconds between user positions being sent to the position probe. Default value is 1000 (1 second).

  • onpositionenter: script

    A script expression to be executed when a user enters the range of the position probe. Receives a PositionEnterEvent.

  • onpositionmove: script

    A script expression to be executed when a user moves within the range of the position probe. Receives a PositionMoveEvent.

  • onpositionleave: script

    A script expression to be executed when a user leaves the range of the position probe. Receives a PositionLeaveEvent.

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.

Compatibility Table

WEBUNREAL
m-position-probe✓✓
range✓✓
interval✓✓
onpositionenter✓✓
onpositionmove✓✓
onpositionleave✓✓
debug✓✓
x✓✓
y✓✓
z✓✓
rx✓✓
ry✓✓
rz✓✓
sx✓✓
sy✓✓
sz✓✓
visible✓✓
socket✓✗
id✓✓
class✓✓