Mirrors/overte
3
0
Fork 0
mirror of https://github.com/overte-org/overte.git synced 2025-04-20 11:45:36 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Document that getProperty() only works for 3D overlays

Browse source
This commit is contained in:
David Rowe 2017-12-13 10:34:33 +13:00
parent 578c42b4ea
commit 650e7e1922
1 changed files with 4 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
interface/src/ui/overlays/Overlays.h
View file

@ -258,11 +258,12 @@ public slots:
OverlayID getOverlayAtPoint(const glm::vec2& point);
/**jsdoc
* Get the value of an overlay's property.
* Get the value of a 3D overlay's property.
* @function Overlays.getProperty
* @param {Uuid} overlayID - The ID of the overlay.
* @param {Uuid} overlayID - The ID of the overlay. <em>Must be for a 3D {@link Overlays.OverlayType|OverlayType}.</em>
* @param {string} property - The name of the property value to get.
* @returns {object} The value of the property if the overlay and property can be found, otherwise <code>undefined</code>.
* @returns {object} The value of the property if the 3D overlay and property can be found, otherwise
* <code>undefined</code>.
* @example <caption>Create an overlay in front of your avatar then report its alpha property value.</caption>
* var overlay = Overlays.addOverlay("cube", {
* position: Vec3.sum(MyAvatar.position, Vec3.multiplyQbyV(MyAvatar.orientation, { x: 0, y: 0, z: -3 })),