From 650e7e192224be9a63dfae104843565e09525b98 Mon Sep 17 00:00:00 2001 From: David Rowe Date: Wed, 13 Dec 2017 10:34:33 +1300 Subject: [PATCH] Document that getProperty() only works for 3D overlays --- interface/src/ui/overlays/Overlays.h | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/interface/src/ui/overlays/Overlays.h b/interface/src/ui/overlays/Overlays.h index 1a42d5fb5c..abd657074c 100644 --- a/interface/src/ui/overlays/Overlays.h +++ b/interface/src/ui/overlays/Overlays.h @@ -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. Must be for a 3D {@link Overlays.OverlayType|OverlayType}. * @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 undefined. + * @returns {object} The value of the property if the 3D overlay and property can be found, otherwise + * undefined. * @example Create an overlay in front of your avatar then report its alpha property value. * var overlay = Overlays.addOverlay("cube", { * position: Vec3.sum(MyAvatar.position, Vec3.multiplyQbyV(MyAvatar.orientation, { x: 0, y: 0, z: -3 })),