Skip to content

Change color.js typing to be "number" instead of "integer" #501

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from
+32 −32
Open

Change color.js typing to be "number" instead of "integer" #501

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
be7c70c
refactor(color): change type in function documentation
Oct 7, 2024
17fd712
doc(color): regenerate doc with new types
Oct 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions docs/Class_RGBAColor.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,35 +60,35 @@
</div>
<div id="main" class="main">
<h1>RGBAColor</h1>
<div class="description">RGBA color object. Components are integers in the range of 0..255.</div>
<div class="description">RGBA color object. Components are numbers in the range of 0..255.</div>
<h2>Constructor</h2>
<div class="function_container">
<div id="RGBAColor" class="function_signature">new RGBAColor (r, g, b, a)</div>
<div class="function_title">Parameters</div>
<div class="parameter_header">
<span class="parameter_name">r</span>
<span class="type parameter_type">integer</span>
<span class="type parameter_type">number</span>
</div>
<div class="parameter_main">
<div class="parameter_description">Red component.</div>
</div>
<div class="parameter_header">
<span class="parameter_name">g</span>
<span class="type parameter_type">integer</span>
<span class="type parameter_type">number</span>
</div>
<div class="parameter_main">
<div class="parameter_description">Green component.</div>
</div>
<div class="parameter_header">
<span class="parameter_name">b</span>
<span class="type parameter_type">integer</span>
<span class="type parameter_type">number</span>
</div>
<div class="parameter_main">
<div class="parameter_description">Blue component.</div>
</div>
<div class="parameter_header">
<span class="parameter_name">a</span>
<span class="type parameter_type">integer</span>
<span class="type parameter_type">number</span>
</div>
<div class="parameter_main">
<div class="parameter_description">Alpha component.</div>
Expand All @@ -102,28 +102,28 @@ <h2>Methods</h2>
<div class="function_title">Parameters</div>
<div class="parameter_header">
<span class="parameter_name">r</span>
<span class="type parameter_type">integer</span>
<span class="type parameter_type">number</span>
</div>
<div class="parameter_main">
<div class="parameter_description">Red component.</div>
</div>
<div class="parameter_header">
<span class="parameter_name">g</span>
<span class="type parameter_type">integer</span>
<span class="type parameter_type">number</span>
</div>
<div class="parameter_main">
<div class="parameter_description">Green component.</div>
</div>
<div class="parameter_header">
<span class="parameter_name">b</span>
<span class="type parameter_type">integer</span>
<span class="type parameter_type">number</span>
</div>
<div class="parameter_main">
<div class="parameter_description">Blue component.</div>
</div>
<div class="parameter_header">
<span class="parameter_name">a</span>
<span class="type parameter_type">integer</span>
<span class="type parameter_type">number</span>
</div>
<div class="parameter_main">
<div class="parameter_description">Alpha component.</div>
Expand Down
14 changes: 7 additions & 7 deletions docs/Class_RGBColor.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,28 +60,28 @@
</div>
<div id="main" class="main">
<h1>RGBColor</h1>
<div class="description">RGB color object. Components are integers in the range of 0..255.</div>
<div class="description">RGB color object. Components are numbers in the range of 0..255.</div>
<h2>Constructor</h2>
<div class="function_container">
<div id="RGBColor" class="function_signature">new RGBColor (r, g, b)</div>
<div class="function_title">Parameters</div>
<div class="parameter_header">
<span class="parameter_name">r</span>
<span class="type parameter_type">integer</span>
<span class="type parameter_type">number</span>
</div>
<div class="parameter_main">
<div class="parameter_description">Red component.</div>
</div>
<div class="parameter_header">
<span class="parameter_name">g</span>
<span class="type parameter_type">integer</span>
<span class="type parameter_type">number</span>
</div>
<div class="parameter_main">
<div class="parameter_description">Green component.</div>
</div>
<div class="parameter_header">
<span class="parameter_name">b</span>
<span class="type parameter_type">integer</span>
<span class="type parameter_type">number</span>
</div>
<div class="parameter_main">
<div class="parameter_description">Blue component.</div>
Expand All @@ -95,21 +95,21 @@ <h2>Methods</h2>
<div class="function_title">Parameters</div>
<div class="parameter_header">
<span class="parameter_name">r</span>
<span class="type parameter_type">integer</span>
<span class="type parameter_type">number</span>
</div>
<div class="parameter_main">
<div class="parameter_description">Red component.</div>
</div>
<div class="parameter_header">
<span class="parameter_name">g</span>
<span class="type parameter_type">integer</span>
<span class="type parameter_type">number</span>
</div>
<div class="parameter_main">
<div class="parameter_description">Green component.</div>
</div>
<div class="parameter_header">
<span class="parameter_name">b</span>
<span class="type parameter_type">integer</span>
<span class="type parameter_type">number</span>
</div>
<div class="parameter_main">
<div class="parameter_description">Blue component.</div>
Expand Down
32 changes: 16 additions & 16 deletions source/engine/model/color.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
/**
* RGB color object. Components are integers in the range of 0..255.
* RGB color object. Components are numbers in the range of 0..255.
*/
export class RGBColor
{
/**
* @param {integer} r Red component.
* @param {integer} g Green component.
* @param {integer} b Blue component.
* @param {number} r Red component.
* @param {number} g Green component.
* @param {number} b Blue component.
*/
constructor (r, g, b)
{
Expand All @@ -17,9 +17,9 @@ export class RGBColor

/**
* Sets the value of all components.
* @param {integer} r Red component.
* @param {integer} g Green component.
* @param {integer} b Blue component.
* @param {number} r Red component.
* @param {number} g Green component.
* @param {number} b Blue component.
*/
Set (r, g, b)
{
Expand All @@ -39,15 +39,15 @@ export class RGBColor
}

/**
* RGBA color object. Components are integers in the range of 0..255.
* RGBA color object. Components are numbers in the range of 0..255.
*/
export class RGBAColor
{
/**
* @param {integer} r Red component.
* @param {integer} g Green component.
* @param {integer} b Blue component.
* @param {integer} a Alpha component.
* @param {number} r Red component.
* @param {number} g Green component.
* @param {number} b Blue component.
* @param {number} a Alpha component.
*/
constructor (r, g, b, a)
{
Expand All @@ -59,10 +59,10 @@ export class RGBAColor

/**
* Sets the value of all components.
* @param {integer} r Red component.
* @param {integer} g Green component.
* @param {integer} b Blue component.
* @param {integer} a Alpha component.
* @param {number} r Red component.
* @param {number} g Green component.
* @param {number} b Blue component.
* @param {number} a Alpha component.
*/
Set (r, g, b, a)
{
Expand Down