From 2612ea7621152b2087a7183e985383c8f765ecb3 Mon Sep 17 00:00:00 2001 From: cv <34649812+cpvalente@users.noreply.github.com> Date: Thu, 10 Jun 2021 23:39:48 +0200 Subject: [PATCH] docs: comment osc functions --- server/src/classes/EventTimer.js | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/server/src/classes/EventTimer.js b/server/src/classes/EventTimer.js index ae418990b..fe7e789d0 100644 --- a/server/src/classes/EventTimer.js +++ b/server/src/classes/EventTimer.js @@ -88,10 +88,18 @@ export class EventTimer extends Timer { this.updateOSCClient(oscClient); } + /** + * @description Updates the osc client used in the object + * @param {object} oscClient + */ updateOSCClient(oscClient) { this.oscClient = oscClient; } + /** + * @description Sends osc value from predefined messages + * @param {string} event - message to be sent + */ sendOSC(event) { if (this.oscClient == null) return;