bauiv1lib.helpui

  1# Released under the MIT License. See LICENSE for details.
  2#
  3"""Provides help related ui."""
  4
  5from __future__ import annotations
  6
  7import bauiv1 as bui
  8
  9
 10class HelpWindow(bui.Window):
 11    """A window providing help on how to play."""
 12
 13    def __init__(
 14        self, main_menu: bool = False, origin_widget: bui.Widget | None = None
 15    ):
 16        # pylint: disable=too-many-statements
 17        # pylint: disable=too-many-locals
 18
 19        bui.set_analytics_screen('Help Window')
 20
 21        # If they provided an origin-widget, scale up from that.
 22        scale_origin: tuple[float, float] | None
 23        if origin_widget is not None:
 24            self._transition_out = 'out_scale'
 25            scale_origin = origin_widget.get_screen_space_center()
 26            transition = 'in_scale'
 27        else:
 28            self._transition_out = 'out_right'
 29            scale_origin = None
 30            transition = 'in_right'
 31
 32        self._r = 'helpWindow'
 33
 34        getres = bui.app.lang.get_resource
 35
 36        self._main_menu = main_menu
 37        assert bui.app.classic is not None
 38        uiscale = bui.app.ui_v1.uiscale
 39        width = 950 if uiscale is bui.UIScale.SMALL else 750
 40        x_offs = 100 if uiscale is bui.UIScale.SMALL else 0
 41        height = (
 42            460
 43            if uiscale is bui.UIScale.SMALL
 44            else 530
 45            if uiscale is bui.UIScale.MEDIUM
 46            else 600
 47        )
 48
 49        super().__init__(
 50            root_widget=bui.containerwidget(
 51                size=(width, height),
 52                transition=transition,
 53                toolbar_visibility='menu_minimal',
 54                scale_origin_stack_offset=scale_origin,
 55                scale=(
 56                    1.77
 57                    if uiscale is bui.UIScale.SMALL
 58                    else 1.25
 59                    if uiscale is bui.UIScale.MEDIUM
 60                    else 1.0
 61                ),
 62                stack_offset=(0, -30)
 63                if uiscale is bui.UIScale.SMALL
 64                else (0, 15)
 65                if uiscale is bui.UIScale.MEDIUM
 66                else (0, 0),
 67            )
 68        )
 69
 70        bui.textwidget(
 71            parent=self._root_widget,
 72            position=(0, height - (50 if uiscale is bui.UIScale.SMALL else 45)),
 73            size=(width, 25),
 74            text=bui.Lstr(
 75                resource=self._r + '.titleText',
 76                subs=[('${APP_NAME}', bui.Lstr(resource='titleText'))],
 77            ),
 78            color=bui.app.ui_v1.title_color,
 79            h_align='center',
 80            v_align='top',
 81        )
 82
 83        self._scrollwidget = bui.scrollwidget(
 84            parent=self._root_widget,
 85            position=(44 + x_offs, 55 if uiscale is bui.UIScale.SMALL else 55),
 86            simple_culling_v=100.0,
 87            size=(
 88                width - (88 + 2 * x_offs),
 89                height - 120 + (5 if uiscale is bui.UIScale.SMALL else 0),
 90            ),
 91            capture_arrows=True,
 92        )
 93
 94        if bui.app.ui_v1.use_toolbars:
 95            bui.widget(
 96                edit=self._scrollwidget,
 97                right_widget=bui.get_special_widget('party_button'),
 98            )
 99        bui.containerwidget(
100            edit=self._root_widget, selected_child=self._scrollwidget
101        )
102
103        # ugly: create this last so it gets first dibs at touch events (since
104        # we have it close to the scroll widget)
105        if uiscale is bui.UIScale.SMALL and bui.app.ui_v1.use_toolbars:
106            bui.containerwidget(
107                edit=self._root_widget, on_cancel_call=self._close
108            )
109            bui.widget(
110                edit=self._scrollwidget,
111                left_widget=bui.get_special_widget('back_button'),
112            )
113        else:
114            btn = bui.buttonwidget(
115                parent=self._root_widget,
116                position=(
117                    x_offs + (40 + 0 if uiscale is bui.UIScale.SMALL else 70),
118                    height - (59 if uiscale is bui.UIScale.SMALL else 50),
119                ),
120                size=(140, 60),
121                scale=0.7 if uiscale is bui.UIScale.SMALL else 0.8,
122                label=bui.Lstr(resource='backText')
123                if self._main_menu
124                else 'Close',
125                button_type='back' if self._main_menu else None,
126                extra_touch_border_scale=2.0,
127                autoselect=True,
128                on_activate_call=self._close,
129            )
130            bui.containerwidget(edit=self._root_widget, cancel_button=btn)
131
132            if self._main_menu:
133                bui.buttonwidget(
134                    edit=btn,
135                    button_type='backSmall',
136                    size=(60, 55),
137                    label=bui.charstr(bui.SpecialChar.BACK),
138                )
139
140        self._sub_width = 660
141        self._sub_height = (
142            1590
143            + bui.app.lang.get_resource(self._r + '.someDaysExtraSpace')
144            + bui.app.lang.get_resource(
145                self._r + '.orPunchingSomethingExtraSpace'
146            )
147        )
148
149        self._subcontainer = bui.containerwidget(
150            parent=self._scrollwidget,
151            size=(self._sub_width, self._sub_height),
152            background=False,
153            claims_left_right=False,
154            claims_tab=False,
155        )
156
157        spacing = 1.0
158        h = self._sub_width * 0.5
159        v = self._sub_height - 55
160        logo_tex = bui.gettexture('logo')
161        icon_buffer = 1.1
162        header = (0.7, 1.0, 0.7, 1.0)
163        header2 = (0.8, 0.8, 1.0, 1.0)
164        paragraph = (0.8, 0.8, 1.0, 1.0)
165
166        txt = bui.Lstr(
167            resource=self._r + '.welcomeText',
168            subs=[('${APP_NAME}', bui.Lstr(resource='titleText'))],
169        ).evaluate()
170        txt_scale = 1.4
171        txt_maxwidth = 480
172        bui.textwidget(
173            parent=self._subcontainer,
174            position=(h, v),
175            size=(0, 0),
176            scale=txt_scale,
177            flatness=0.5,
178            res_scale=1.5,
179            text=txt,
180            h_align='center',
181            color=header,
182            v_align='center',
183            maxwidth=txt_maxwidth,
184        )
185        txt_width = min(
186            txt_maxwidth,
187            bui.get_string_width(txt, suppress_warning=True) * txt_scale,
188        )
189
190        icon_size = 70
191        hval2 = h - (txt_width * 0.5 + icon_size * 0.5 * icon_buffer)
192        bui.imagewidget(
193            parent=self._subcontainer,
194            size=(icon_size, icon_size),
195            position=(hval2 - 0.5 * icon_size, v - 0.45 * icon_size),
196            texture=logo_tex,
197        )
198
199        app = bui.app
200        assert app.classic is not None
201
202        v -= spacing * 50.0
203        txt = bui.Lstr(resource=self._r + '.someDaysText').evaluate()
204        bui.textwidget(
205            parent=self._subcontainer,
206            position=(h, v),
207            size=(0, 0),
208            scale=1.2,
209            maxwidth=self._sub_width * 0.9,
210            text=txt,
211            h_align='center',
212            color=paragraph,
213            v_align='center',
214            flatness=1.0,
215        )
216        v -= spacing * 25.0 + getres(self._r + '.someDaysExtraSpace')
217        txt_scale = 0.66
218        txt = bui.Lstr(resource=self._r + '.orPunchingSomethingText').evaluate()
219        bui.textwidget(
220            parent=self._subcontainer,
221            position=(h, v),
222            size=(0, 0),
223            scale=txt_scale,
224            maxwidth=self._sub_width * 0.9,
225            text=txt,
226            h_align='center',
227            color=paragraph,
228            v_align='center',
229            flatness=1.0,
230        )
231        v -= spacing * 27.0 + getres(self._r + '.orPunchingSomethingExtraSpace')
232        txt_scale = 1.0
233        txt = bui.Lstr(
234            resource=self._r + '.canHelpText',
235            subs=[('${APP_NAME}', bui.Lstr(resource='titleText'))],
236        ).evaluate()
237        bui.textwidget(
238            parent=self._subcontainer,
239            position=(h, v),
240            size=(0, 0),
241            scale=txt_scale,
242            flatness=1.0,
243            text=txt,
244            h_align='center',
245            color=paragraph,
246            v_align='center',
247        )
248
249        v -= spacing * 70.0
250        txt_scale = 1.0
251        txt = bui.Lstr(resource=self._r + '.toGetTheMostText').evaluate()
252        bui.textwidget(
253            parent=self._subcontainer,
254            position=(h, v),
255            size=(0, 0),
256            scale=txt_scale,
257            maxwidth=self._sub_width * 0.9,
258            text=txt,
259            h_align='center',
260            color=header,
261            v_align='center',
262            flatness=1.0,
263        )
264
265        v -= spacing * 40.0
266        txt_scale = 0.74
267        txt = bui.Lstr(resource=self._r + '.friendsText').evaluate()
268        hval2 = h - 220
269        bui.textwidget(
270            parent=self._subcontainer,
271            position=(hval2, v),
272            size=(0, 0),
273            scale=txt_scale,
274            maxwidth=100,
275            text=txt,
276            h_align='right',
277            color=header,
278            v_align='center',
279            flatness=1.0,
280        )
281
282        txt = bui.Lstr(
283            resource=self._r + '.friendsGoodText',
284            subs=[('${APP_NAME}', bui.Lstr(resource='titleText'))],
285        ).evaluate()
286        txt_scale = 0.7
287        bui.textwidget(
288            parent=self._subcontainer,
289            position=(hval2 + 10, v + 8),
290            size=(0, 0),
291            scale=txt_scale,
292            maxwidth=500,
293            text=txt,
294            h_align='left',
295            color=paragraph,
296            flatness=1.0,
297        )
298
299        app = bui.app
300
301        v -= spacing * 45.0
302        txt = (
303            bui.Lstr(resource=self._r + '.devicesText').evaluate()
304            if app.env.vr
305            else bui.Lstr(resource=self._r + '.controllersText').evaluate()
306        )
307        txt_scale = 0.74
308        hval2 = h - 220
309        bui.textwidget(
310            parent=self._subcontainer,
311            position=(hval2, v),
312            size=(0, 0),
313            scale=txt_scale,
314            maxwidth=100,
315            text=txt,
316            h_align='right',
317            v_align='center',
318            color=header,
319            flatness=1.0,
320        )
321
322        txt_scale = 0.7
323        if not app.env.vr:
324            infotxt = '.controllersInfoText'
325            txt = bui.Lstr(
326                resource=self._r + infotxt,
327                fallback_resource=self._r + '.controllersInfoText',
328                subs=[
329                    ('${APP_NAME}', bui.Lstr(resource='titleText')),
330                    ('${REMOTE_APP_NAME}', bui.get_remote_app_name()),
331                ],
332            ).evaluate()
333        else:
334            txt = bui.Lstr(
335                resource=self._r + '.devicesInfoText',
336                subs=[('${APP_NAME}', bui.Lstr(resource='titleText'))],
337            ).evaluate()
338
339        bui.textwidget(
340            parent=self._subcontainer,
341            position=(hval2 + 10, v + 8),
342            size=(0, 0),
343            scale=txt_scale,
344            maxwidth=500,
345            max_height=105,
346            text=txt,
347            h_align='left',
348            color=paragraph,
349            flatness=1.0,
350        )
351
352        v -= spacing * 150.0
353
354        txt = bui.Lstr(resource=self._r + '.controlsText').evaluate()
355        txt_scale = 1.4
356        txt_maxwidth = 480
357        bui.textwidget(
358            parent=self._subcontainer,
359            position=(h, v),
360            size=(0, 0),
361            scale=txt_scale,
362            flatness=0.5,
363            text=txt,
364            h_align='center',
365            color=header,
366            v_align='center',
367            res_scale=1.5,
368            maxwidth=txt_maxwidth,
369        )
370        txt_width = min(
371            txt_maxwidth,
372            bui.get_string_width(txt, suppress_warning=True) * txt_scale,
373        )
374        icon_size = 70
375
376        hval2 = h - (txt_width * 0.5 + icon_size * 0.5 * icon_buffer)
377        bui.imagewidget(
378            parent=self._subcontainer,
379            size=(icon_size, icon_size),
380            position=(hval2 - 0.5 * icon_size, v - 0.45 * icon_size),
381            texture=logo_tex,
382        )
383
384        v -= spacing * 45.0
385
386        txt_scale = 0.7
387        txt = bui.Lstr(
388            resource=self._r + '.controlsSubtitleText',
389            subs=[('${APP_NAME}', bui.Lstr(resource='titleText'))],
390        ).evaluate()
391        bui.textwidget(
392            parent=self._subcontainer,
393            position=(h, v),
394            size=(0, 0),
395            scale=txt_scale,
396            maxwidth=self._sub_width * 0.9,
397            flatness=1.0,
398            text=txt,
399            h_align='center',
400            color=paragraph,
401            v_align='center',
402        )
403        v -= spacing * 160.0
404
405        sep = 70
406        icon_size = 100
407        # icon_size_2 = 30
408        hval2 = h - sep
409        vval2 = v
410        bui.imagewidget(
411            parent=self._subcontainer,
412            size=(icon_size, icon_size),
413            position=(hval2 - 0.5 * icon_size, vval2 - 0.5 * icon_size),
414            texture=bui.gettexture('buttonPunch'),
415            color=(1, 0.7, 0.3),
416        )
417
418        txt_scale = getres(self._r + '.punchInfoTextScale')
419        txt = bui.Lstr(resource=self._r + '.punchInfoText').evaluate()
420        bui.textwidget(
421            parent=self._subcontainer,
422            position=(h - sep - 185 + 70, v + 120),
423            size=(0, 0),
424            scale=txt_scale,
425            flatness=1.0,
426            text=txt,
427            h_align='center',
428            color=(1, 0.7, 0.3, 1.0),
429            v_align='top',
430        )
431
432        hval2 = h + sep
433        vval2 = v
434        bui.imagewidget(
435            parent=self._subcontainer,
436            size=(icon_size, icon_size),
437            position=(hval2 - 0.5 * icon_size, vval2 - 0.5 * icon_size),
438            texture=bui.gettexture('buttonBomb'),
439            color=(1, 0.3, 0.3),
440        )
441
442        txt = bui.Lstr(resource=self._r + '.bombInfoText').evaluate()
443        txt_scale = getres(self._r + '.bombInfoTextScale')
444        bui.textwidget(
445            parent=self._subcontainer,
446            position=(h + sep + 50 + 60, v - 35),
447            size=(0, 0),
448            scale=txt_scale,
449            flatness=1.0,
450            maxwidth=270,
451            text=txt,
452            h_align='center',
453            color=(1, 0.3, 0.3, 1.0),
454            v_align='top',
455        )
456
457        hval2 = h
458        vval2 = v + sep
459        bui.imagewidget(
460            parent=self._subcontainer,
461            size=(icon_size, icon_size),
462            position=(hval2 - 0.5 * icon_size, vval2 - 0.5 * icon_size),
463            texture=bui.gettexture('buttonPickUp'),
464            color=(0.5, 0.5, 1),
465        )
466
467        txtl = bui.Lstr(resource=self._r + '.pickUpInfoText')
468        txt_scale = getres(self._r + '.pickUpInfoTextScale')
469        bui.textwidget(
470            parent=self._subcontainer,
471            position=(h + 60 + 120, v + sep + 50),
472            size=(0, 0),
473            scale=txt_scale,
474            flatness=1.0,
475            text=txtl,
476            h_align='center',
477            color=(0.5, 0.5, 1, 1.0),
478            v_align='top',
479        )
480
481        hval2 = h
482        vval2 = v - sep
483        bui.imagewidget(
484            parent=self._subcontainer,
485            size=(icon_size, icon_size),
486            position=(hval2 - 0.5 * icon_size, vval2 - 0.5 * icon_size),
487            texture=bui.gettexture('buttonJump'),
488            color=(0.4, 1, 0.4),
489        )
490
491        txt = bui.Lstr(resource=self._r + '.jumpInfoText').evaluate()
492        txt_scale = getres(self._r + '.jumpInfoTextScale')
493        bui.textwidget(
494            parent=self._subcontainer,
495            position=(h - 250 + 75, v - sep - 15 + 30),
496            size=(0, 0),
497            scale=txt_scale,
498            flatness=1.0,
499            text=txt,
500            h_align='center',
501            color=(0.4, 1, 0.4, 1.0),
502            v_align='top',
503        )
504
505        txt = bui.Lstr(resource=self._r + '.runInfoText').evaluate()
506        txt_scale = getres(self._r + '.runInfoTextScale')
507        bui.textwidget(
508            parent=self._subcontainer,
509            position=(h, v - sep - 100),
510            size=(0, 0),
511            scale=txt_scale,
512            maxwidth=self._sub_width * 0.93,
513            flatness=1.0,
514            text=txt,
515            h_align='center',
516            color=(0.7, 0.7, 1.0, 1.0),
517            v_align='center',
518        )
519
520        v -= spacing * 280.0
521
522        txt = bui.Lstr(resource=self._r + '.powerupsText').evaluate()
523        txt_scale = 1.4
524        txt_maxwidth = 480
525        bui.textwidget(
526            parent=self._subcontainer,
527            position=(h, v),
528            size=(0, 0),
529            scale=txt_scale,
530            flatness=0.5,
531            text=txt,
532            h_align='center',
533            color=header,
534            v_align='center',
535            maxwidth=txt_maxwidth,
536        )
537        txt_width = min(
538            txt_maxwidth,
539            bui.get_string_width(txt, suppress_warning=True) * txt_scale,
540        )
541        icon_size = 70
542        hval2 = h - (txt_width * 0.5 + icon_size * 0.5 * icon_buffer)
543        bui.imagewidget(
544            parent=self._subcontainer,
545            size=(icon_size, icon_size),
546            position=(hval2 - 0.5 * icon_size, v - 0.45 * icon_size),
547            texture=logo_tex,
548        )
549
550        v -= spacing * 50.0
551        txt_scale = getres(self._r + '.powerupsSubtitleTextScale')
552        txt = bui.Lstr(resource=self._r + '.powerupsSubtitleText').evaluate()
553        bui.textwidget(
554            parent=self._subcontainer,
555            position=(h, v),
556            size=(0, 0),
557            scale=txt_scale,
558            maxwidth=self._sub_width * 0.9,
559            text=txt,
560            h_align='center',
561            color=paragraph,
562            v_align='center',
563            flatness=1.0,
564        )
565
566        v -= spacing * 1.0
567
568        mm1 = -270
569        mm2 = -215
570        mm3 = 0
571        icon_size = 50
572        shadow_size = 80
573        shadow_offs_x = 3
574        shadow_offs_y = -4
575        t_big = 1.1
576        t_small = 0.65
577
578        shadow_tex = bui.gettexture('shadowSharp')
579
580        for tex in [
581            'powerupPunch',
582            'powerupShield',
583            'powerupBomb',
584            'powerupHealth',
585            'powerupIceBombs',
586            'powerupImpactBombs',
587            'powerupStickyBombs',
588            'powerupLandMines',
589            'powerupCurse',
590        ]:
591            name = bui.Lstr(resource=self._r + '.' + tex + 'NameText')
592            desc = bui.Lstr(resource=self._r + '.' + tex + 'DescriptionText')
593
594            v -= spacing * 60.0
595
596            bui.imagewidget(
597                parent=self._subcontainer,
598                size=(shadow_size, shadow_size),
599                position=(
600                    h + mm1 + shadow_offs_x - 0.5 * shadow_size,
601                    v + shadow_offs_y - 0.5 * shadow_size,
602                ),
603                texture=shadow_tex,
604                color=(0, 0, 0),
605                opacity=0.5,
606            )
607            bui.imagewidget(
608                parent=self._subcontainer,
609                size=(icon_size, icon_size),
610                position=(h + mm1 - 0.5 * icon_size, v - 0.5 * icon_size),
611                texture=bui.gettexture(tex),
612            )
613
614            txt_scale = t_big
615            txtl = name
616            bui.textwidget(
617                parent=self._subcontainer,
618                position=(h + mm2, v + 3),
619                size=(0, 0),
620                scale=txt_scale,
621                maxwidth=200,
622                flatness=1.0,
623                text=txtl,
624                h_align='left',
625                color=header2,
626                v_align='center',
627            )
628            txt_scale = t_small
629            txtl = desc
630            bui.textwidget(
631                parent=self._subcontainer,
632                position=(h + mm3, v),
633                size=(0, 0),
634                scale=txt_scale,
635                maxwidth=300,
636                flatness=1.0,
637                text=txtl,
638                h_align='left',
639                color=paragraph,
640                v_align='center',
641                res_scale=0.5,
642            )
643
644    def _close(self) -> None:
645        # pylint: disable=cyclic-import
646        from bauiv1lib.mainmenu import MainMenuWindow
647
648        bui.containerwidget(
649            edit=self._root_widget, transition=self._transition_out
650        )
651        if self._main_menu:
652            assert bui.app.classic is not None
653            bui.app.ui_v1.set_main_menu_window(
654                MainMenuWindow(transition='in_left').get_root_widget()
655            )