pokerogue/main/classes/test_utils_mocks_mockTimedE...

11 lines
24 KiB
HTML
Raw Normal View History

2024-11-17 23:35:40 +00:00
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>MockTimedEventManager | pokemon-rogue-battle</title><meta name="description" content="Documentation for pokemon-rogue-battle"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">pokemon-rogue-battle</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">pokemon-rogue-battle</a></li><li><a href="../modules/test_utils_mocks_mockTimedEventManager.html">test/utils/mocks/mockTimedEventManager</a></li><li><a href="test_utils_mocks_mockTimedEventManager.MockTimedEventManager.html">MockTimedEventManager</a></li></ul><h1>Class MockTimedEventManager</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Mock TimedEventManager so that ongoing events don't impact tests</p>
2024-11-18 18:42:56 +00:00
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a href="../hierarchy.html#test/utils/mocks/mockTimedEventManager.MockTimedEventManager">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="timed_event_manager.TimedEventManager.html" class="tsd-signature-type tsd-kind-class">TimedEventManager</a><ul class="tsd-hierarchy"><li><span class="target">MockTimedEventManager</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/test/utils/mocks/mockTimedEventManager.ts#L4">src/test/utils/mocks/mockTimedEventManager.ts:4</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="test_utils_mocks_mockTimedEventManager.MockTimedEventManager.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
2024-11-17 23:35:40 +00:00
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="test_utils_mocks_mockTimedEventManager.MockTimedEventManager.html#activeEvent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>active<wbr/>Event</span></a>
<a href="test_utils_mocks_mockTimedEventManager.MockTimedEventManager.html#activeEventHasBanner" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>active<wbr/>Event<wbr/>Has<wbr/>Banner</span></a>
<a href="test_utils_mocks_mockTimedEventManager.MockTimedEventManager.html#getEventBannerFilename" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Event<wbr/>Banner<wbr/>Filename</span></a>
<a href="test_utils_mocks_mockTimedEventManager.MockTimedEventManager.html#getFriendshipMultiplier" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Friendship<wbr/>Multiplier</span></a>
<a href="test_utils_mocks_mockTimedEventManager.MockTimedEventManager.html#getShinyMultiplier" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Shiny<wbr/>Multiplier</span></a>
<a href="test_utils_mocks_mockTimedEventManager.MockTimedEventManager.html#isActive" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Active</span></a>
<a href="test_utils_mocks_mockTimedEventManager.MockTimedEventManager.html#isEventActive" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Event<wbr/>Active</span></a>
2024-11-18 18:42:56 +00:00
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_MockTimedEventManager" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Mock<wbr/>Timed<wbr/>Event<wbr/>Manager</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="test_utils_mocks_mockTimedEventManager.MockTimedEventManager.html" class="tsd-signature-type tsd-kind-class">MockTimedEventManager</a><a href="#constructor.new_MockTimedEventManager" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="test_utils_mocks_mockTimedEventManager.MockTimedEventManager.html" class="tsd-signature-type tsd-kind-class">MockTimedEventManager</a></h4><aside class="tsd-sources"><p>Inherited from <a href="timed_event_manager.TimedEventManager.html">TimedEventManager</a>.<a href="timed_event_manager.TimedEventManager.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/timed-event-manager.ts#L43">src/timed-event-manager.ts:43</a></li></ul></aside></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="activeEvent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>active<wbr/>Event</span><a href="#activeEvent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="activeEvent.activeEvent-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">active<wbr/>Event</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><a href="#activeEvent.activeEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span></h4><aside class="tsd-sources"><p>Overrides <a href="timed_event_manager.TimedEventManager.html">TimedEventManager</a>.<a href="timed_event_manager.TimedEventManager.html#activeEvent">activeEvent</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/test/utils/mocks/mockTimedEventManager.ts#L5">src/test/utils/mocks/mockTimedEventManager.ts:5</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="activeEventHasBanner" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>active<wbr/>Event<wbr/>Has<wbr/>Banner</span><a href="#activeEventHasBanner" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures ts