diff --git a/markdown/bitburner.goanalysis.clearpointhighlight.md b/markdown/bitburner.goanalysis.clearpointhighlight.md index 4ef7b6262..d3ede938c 100644 --- a/markdown/bitburner.goanalysis.clearpointhighlight.md +++ b/markdown/bitburner.goanalysis.clearpointhighlight.md @@ -9,17 +9,21 @@ Removes the highlight color and text from the specified node. **Signature:** ```typescript -clearPointHighlight(x, y): void; +clearPointHighlight(x: number, y: number): void; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| x | (not declared) | the x coordinate to remove highlight from | -| y | (not declared) | the y coordinate to remove highlight from | +| x | number | the x coordinate to remove highlight from | +| y | number | the y coordinate to remove highlight from | **Returns:** void +## Remarks + +RAM cost: 0 GB + diff --git a/markdown/bitburner.goanalysis.highlightpoint.md b/markdown/bitburner.goanalysis.highlightpoint.md index 43acf9f48..663e7995b 100644 --- a/markdown/bitburner.goanalysis.highlightpoint.md +++ b/markdown/bitburner.goanalysis.highlightpoint.md @@ -9,19 +9,23 @@ Adds a colored circle indicator to the specified point. These indicators are rem **Signature:** ```typescript -highlightPoint(x, y, color, text): void; +highlightPoint(x: number, y: number, color?: string, text?: string): void; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| x | (not declared) | the x coordinate to highlight | -| y | (not declared) | the y coordinate to highlight | -| color | (not declared) | optional: the color to use for the circle. Can be given an RGB string like "\#FFF000", or "none" to clear it, or one of these color names from the selected theme: "hack" (green), "hp" (red), "money" (yellow), "int" (blue), "cha" (purple) | -| text | (not declared) | optional: text to add to the node (replaces the default A.1 or B5 seen on hover). Should be kept short to fit well. | +| x | number | The x coordinate to highlight | +| y | number | The y coordinate to highlight | +| color | string | _(Optional)_ The color to use for the circle. It can be any value accepted by [outline-color CSS property](https://developer.mozilla.org/en-US/docs/Web/CSS/outline-color) (e.g., an RGB string like "\#FFF000"). You can also use "none" to clear it or one of 5 special values: "hack", "hp", "money", "int", "cha". The corresponding colors of 5 special values depend on your theme. | +| text | string | _(Optional)_ Text to add to the node (replaces the default A.1 or B5 seen on hover). Should be kept short to fit well. | **Returns:** void +## Remarks + +RAM cost: 0 GB + diff --git a/src/ScriptEditor/NetscriptDefinitions.d.ts b/src/ScriptEditor/NetscriptDefinitions.d.ts index 0855def51..5c9d91738 100644 --- a/src/ScriptEditor/NetscriptDefinitions.d.ts +++ b/src/ScriptEditor/NetscriptDefinitions.d.ts @@ -4656,20 +4656,30 @@ export interface GoAnalysis { /** * Adds a colored circle indicator to the specified point. These indicators are removed once a move is played. - * @param x the x coordinate to highlight - * @param y the y coordinate to highlight - * @param color optional: the color to use for the circle. Can be given an RGB string like "#FFF000", or "none" to clear it, or one of - * these color names from the selected theme: "hack" (green), "hp" (red), "money" (yellow), "int" (blue), "cha" (purple) - * @param text optional: text to add to the node (replaces the default A.1 or B5 seen on hover). Should be kept short to fit well. + * + * @remarks + * RAM cost: 0 GB + * + * @param x - The x coordinate to highlight + * @param y - The y coordinate to highlight + * @param color - The color to use for the circle. It can be any value accepted by + * {@link https://developer.mozilla.org/en-US/docs/Web/CSS/outline-color | outline-color CSS property} (e.g., an RGB + * string like "#FFF000"). You can also use "none" to clear it or one of 5 special values: "hack", "hp", "money", + * "int", "cha". The corresponding colors of 5 special values depend on your theme. + * @param text - Text to add to the node (replaces the default A.1 or B5 seen on hover). Should be kept short to fit well. */ - highlightPoint(x, y, color, text): void; + highlightPoint(x: number, y: number, color?: string, text?: string): void; /** * Removes the highlight color and text from the specified node. - * @param x the x coordinate to remove highlight from - * @param y the y coordinate to remove highlight from + * + * @remarks + * RAM cost: 0 GB + * + * @param x - the x coordinate to remove highlight from + * @param y - the y coordinate to remove highlight from */ - clearPointHighlight(x, y): void; + clearPointHighlight(x: number, y: number): void; /** Removes all highlights from the board. */ clearAllPointHighlights(): void;