mika/pokerogue
1
0
Fork 0
mirror of https://github.com/pagefaultgames/pokerogue.git synced 2025-08-07 16:09:27 +02:00
Code Issues Packages Projects Releases Wiki Activity

Convert comments to TSDocs

Browse Source
This commit is contained in:
NightKev 2025-07-28 14:55:52 -07:00
parent f6e477c2f9
commit b3af6a8a0a
1 changed files with 15 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
src/ui/move-info-overlay.ts
View File

@ -10,16 +10,24 @@ import { fixedInt, getLocalizedSpriteKey } from "#utils/common";
import i18next from "i18next";
export interface MoveInfoOverlaySettings {
delayVisibility?: boolean; // if true, showing the overlay will only set it to active and populate the fields and the handler using this field has to manually call setVisible later.
top?: boolean; // should the effect box be on top?
right?: boolean; // should the effect box be on the right?
onSide?: boolean; // should the effect be on the side? ignores top argument if true
//location and width of the component; unaffected by scaling
/**
* If true, showing the overlay will only set it to active and populate the fields
* and the handler using this field has to manually call `setVisible` later.
*/
delayVisibility?: boolean;
/** Whether the effect box should be on top */
top?: boolean;
/** Whether the effect box should be on the right */
right?: boolean;
/** Whether the effect box should be on the side. Overrides the `top` param if `true`. */
onSide?: boolean;
/** `x` position of the component, unaffected by scaling */
x?: number;
/** `y` position of the component, unaffected by scaling */
y?: number;
// Default width is half the screen
/** Width of the component, unaffected by scaling. Defaults to half the screen width. */
width?: number;
// Determines whether to display the small secondary box
/* Whether to display the small secondary box */
hideEffectBox?: boolean;
hideBg?: boolean;
}