getTargetFrameRate issue #5762

[sz245]

Our team (@sz245, @Jorge-Mor, @4slk4) worked on issue #5762. Thank you to @donaldong, our mentor, for guiding us through the process.

Added a method that returns the frame that the user sets (_targetFrameRate) when calling the function getTargetFrameRate().
Resolves #5762.

Changes:

/src/core/environment.js - line 331-338

Code change:

/**
 * Returns the current _targetFrameRate.
 * @private
 * @return {Number} current _targetFrameRate
 */
p5.prototype.getTargetFrameRate = function() {
  return this._targetFrameRate;
};

PR Checklist

• npm run lint passes
• Inline documentation is included / updated
• Unit tests are included / updated
  • Manual browser test:
  • frameRate() prints out actual frameRate and getTargetFrameRate() prints out _targetFrameRate using console.log()
  • Example - Use code from the following link and add the attached code below to the bottom of function draw(): https://p5.javascript.org.pl/amused-loan?template=none

    let j = frameRate(20);
    console.log("frameRate(): ", j.getFrameRate())
    console.log("targetFrameRate(): ", j.getTargetFrameRate())

[welcome]

🎉 Thanks for opening this pull request! Please check out our contributing guidelines if you haven't already. And be sure to add yourself to the list of contributors on the readme page!

[limzykenneth]

Is this function meant to be part of the private? If it is intended for public use it would be great to have a more complete documentation as well as not marking it as @private.

[sz245]

@limzykenneth The function is meant for public use and is now marked as @method. The in-line documentation has also been updated and an example has been included.

[limzykenneth]

One more changes inline.

Would you be able to add unit tests for this functions? No worries if not, we can add it later.

[limzykenneth]

Looks good. Thanks!