babase

Common shared Ballistica components.

For modding purposes, this package should generally not be used directly. Instead one should use purpose-built packages such as bascenev1 or bauiv1 which themselves import various functionality from here and reexpose it in a more focused way.

  1# Released under the MIT License. See LICENSE for details.
  2#
  3"""Common shared Ballistica components.
  4
  5For modding purposes, this package should generally not be used directly.
  6Instead one should use purpose-built packages such as bascenev1 or bauiv1
  7which themselves import various functionality from here and reexpose it in
  8a more focused way.
  9"""
 10# pylint: disable=redefined-builtin
 11
 12# The stuff we expose here at the top level is our 'public' api for use
 13# from other modules/packages. Code *within* this package should import
 14# things from this package's submodules directly to reduce the chance of
 15# dependency loops. The exception is TYPE_CHECKING blocks and
 16# annotations since those aren't evaluated at runtime.
 17
 18from efro.util import set_canonical_module_names
 19
 20
 21import _babase
 22from _babase import (
 23    add_clean_frame_callback,
 24    android_get_external_files_dir,
 25    appname,
 26    appnameupper,
 27    apptime,
 28    apptimer,
 29    AppTimer,
 30    fullscreen_control_available,
 31    fullscreen_control_get,
 32    fullscreen_control_key_shortcut,
 33    fullscreen_control_set,
 34    charstr,
 35    clipboard_get_text,
 36    clipboard_has_text,
 37    clipboard_is_supported,
 38    clipboard_set_text,
 39    ContextCall,
 40    ContextRef,
 41    displaytime,
 42    displaytimer,
 43    DisplayTimer,
 44    do_once,
 45    env,
 46    Env,
 47    fade_screen,
 48    fatal_error,
 49    get_display_resolution,
 50    get_immediate_return_code,
 51    get_input_idle_time,
 52    get_low_level_config_value,
 53    get_max_graphics_quality,
 54    get_replays_dir,
 55    get_string_height,
 56    get_string_width,
 57    get_v1_cloud_log_file_path,
 58    getsimplesound,
 59    has_user_run_commands,
 60    have_chars,
 61    have_permission,
 62    in_logic_thread,
 63    increment_analytics_count,
 64    invoke_main_menu,
 65    is_os_playing_music,
 66    is_xcode_build,
 67    lock_all_input,
 68    mac_music_app_get_playlists,
 69    mac_music_app_get_volume,
 70    mac_music_app_init,
 71    mac_music_app_play_playlist,
 72    mac_music_app_set_volume,
 73    mac_music_app_stop,
 74    music_player_play,
 75    music_player_set_volume,
 76    music_player_shutdown,
 77    music_player_stop,
 78    native_review_request,
 79    native_review_request_supported,
 80    native_stack_trace,
 81    open_file_externally,
 82    open_url,
 83    overlay_web_browser_close,
 84    overlay_web_browser_is_open,
 85    overlay_web_browser_is_supported,
 86    overlay_web_browser_open_url,
 87    print_load_info,
 88    pushcall,
 89    quit,
 90    reload_media,
 91    request_permission,
 92    safecolor,
 93    screenmessage,
 94    set_analytics_screen,
 95    set_low_level_config_value,
 96    set_thread_name,
 97    set_ui_input_device,
 98    show_progress_bar,
 99    shutdown_suppress_begin,
100    shutdown_suppress_end,
101    shutdown_suppress_count,
102    SimpleSound,
103    supports_max_fps,
104    supports_vsync,
105    unlock_all_input,
106    user_agent_string,
107    Vec3,
108    workspaces_in_use,
109)
110
111from babase._accountv2 import AccountV2Handle, AccountV2Subsystem
112from babase._app import App
113from babase._appconfig import commit_app_config
114from babase._appintent import AppIntent, AppIntentDefault, AppIntentExec
115from babase._appmode import AppMode
116from babase._appsubsystem import AppSubsystem
117from babase._appmodeselector import AppModeSelector
118from babase._appconfig import AppConfig
119from babase._apputils import (
120    handle_leftover_v1_cloud_log_file,
121    is_browser_likely_available,
122    garbage_collect,
123    get_remote_app_name,
124    AppHealthMonitor,
125)
126from babase._devconsole import (
127    DevConsoleTab,
128    DevConsoleTabEntry,
129    DevConsoleSubsystem,
130)
131from babase._emptyappmode import EmptyAppMode
132from babase._error import (
133    print_exception,
134    print_error,
135    ContextError,
136    NotFoundError,
137    PlayerNotFoundError,
138    SessionPlayerNotFoundError,
139    NodeNotFoundError,
140    ActorNotFoundError,
141    InputDeviceNotFoundError,
142    WidgetNotFoundError,
143    ActivityNotFoundError,
144    TeamNotFoundError,
145    MapNotFoundError,
146    SessionTeamNotFoundError,
147    SessionNotFoundError,
148    DelegateNotFoundError,
149)
150from babase._general import (
151    utf8_all,
152    DisplayTime,
153    AppTime,
154    WeakCall,
155    Call,
156    existing,
157    Existable,
158    verify_object_death,
159    storagename,
160    getclass,
161    get_type_name,
162)
163from babase._language import Lstr, LanguageSubsystem
164from babase._login import LoginAdapter, LoginInfo
165
166# noinspection PyProtectedMember
167# (PyCharm inspection bug?)
168from babase._mgen.enums import (
169    Permission,
170    SpecialChar,
171    InputType,
172    UIScale,
173    QuitType,
174)
175from babase._math import normalized_color, is_point_in_box, vec3validate
176from babase._meta import MetadataSubsystem
177from babase._net import get_ip_address_type, DEFAULT_REQUEST_TIMEOUT_SECONDS
178from babase._plugin import PluginSpec, Plugin, PluginSubsystem
179from babase._stringedit import StringEditAdapter, StringEditSubsystem
180from babase._text import timestring
181
182_babase.app = app = App()
183app.postinit()
184
185__all__ = [
186    'AccountV2Handle',
187    'AccountV2Subsystem',
188    'ActivityNotFoundError',
189    'ActorNotFoundError',
190    'add_clean_frame_callback',
191    'android_get_external_files_dir',
192    'app',
193    'app',
194    'App',
195    'AppConfig',
196    'AppHealthMonitor',
197    'AppIntent',
198    'AppIntentDefault',
199    'AppIntentExec',
200    'AppMode',
201    'appname',
202    'appnameupper',
203    'AppModeSelector',
204    'AppSubsystem',
205    'apptime',
206    'AppTime',
207    'apptime',
208    'apptimer',
209    'AppTimer',
210    'Call',
211    'fullscreen_control_available',
212    'fullscreen_control_get',
213    'fullscreen_control_key_shortcut',
214    'fullscreen_control_set',
215    'charstr',
216    'clipboard_get_text',
217    'clipboard_has_text',
218    'clipboard_is_supported',
219    'clipboard_set_text',
220    'commit_app_config',
221    'ContextCall',
222    'ContextError',
223    'ContextRef',
224    'DelegateNotFoundError',
225    'DevConsoleTab',
226    'DevConsoleTabEntry',
227    'DevConsoleSubsystem',
228    'DisplayTime',
229    'displaytime',
230    'displaytimer',
231    'DisplayTimer',
232    'do_once',
233    'EmptyAppMode',
234    'env',
235    'Env',
236    'Existable',
237    'existing',
238    'fade_screen',
239    'fatal_error',
240    'garbage_collect',
241    'get_display_resolution',
242    'get_immediate_return_code',
243    'get_input_idle_time',
244    'get_ip_address_type',
245    'get_low_level_config_value',
246    'get_max_graphics_quality',
247    'get_remote_app_name',
248    'get_replays_dir',
249    'get_string_height',
250    'get_string_width',
251    'get_v1_cloud_log_file_path',
252    'get_type_name',
253    'getclass',
254    'getsimplesound',
255    'handle_leftover_v1_cloud_log_file',
256    'has_user_run_commands',
257    'have_chars',
258    'have_permission',
259    'in_logic_thread',
260    'increment_analytics_count',
261    'InputDeviceNotFoundError',
262    'InputType',
263    'invoke_main_menu',
264    'is_browser_likely_available',
265    'is_browser_likely_available',
266    'is_os_playing_music',
267    'is_point_in_box',
268    'is_xcode_build',
269    'LanguageSubsystem',
270    'lock_all_input',
271    'LoginAdapter',
272    'LoginInfo',
273    'Lstr',
274    'mac_music_app_get_playlists',
275    'mac_music_app_get_volume',
276    'mac_music_app_init',
277    'mac_music_app_play_playlist',
278    'mac_music_app_set_volume',
279    'mac_music_app_stop',
280    'MapNotFoundError',
281    'MetadataSubsystem',
282    'music_player_play',
283    'music_player_set_volume',
284    'music_player_shutdown',
285    'music_player_stop',
286    'native_review_request',
287    'native_review_request_supported',
288    'native_stack_trace',
289    'NodeNotFoundError',
290    'normalized_color',
291    'NotFoundError',
292    'open_file_externally',
293    'open_url',
294    'overlay_web_browser_close',
295    'overlay_web_browser_is_open',
296    'overlay_web_browser_is_supported',
297    'overlay_web_browser_open_url',
298    'Permission',
299    'PlayerNotFoundError',
300    'Plugin',
301    'PluginSubsystem',
302    'PluginSpec',
303    'print_error',
304    'print_exception',
305    'print_load_info',
306    'pushcall',
307    'quit',
308    'QuitType',
309    'reload_media',
310    'request_permission',
311    'safecolor',
312    'screenmessage',
313    'SessionNotFoundError',
314    'SessionPlayerNotFoundError',
315    'SessionTeamNotFoundError',
316    'set_analytics_screen',
317    'set_low_level_config_value',
318    'set_thread_name',
319    'set_ui_input_device',
320    'show_progress_bar',
321    'shutdown_suppress_begin',
322    'shutdown_suppress_end',
323    'shutdown_suppress_count',
324    'SimpleSound',
325    'SpecialChar',
326    'storagename',
327    'StringEditAdapter',
328    'StringEditSubsystem',
329    'supports_max_fps',
330    'supports_vsync',
331    'TeamNotFoundError',
332    'timestring',
333    'UIScale',
334    'unlock_all_input',
335    'user_agent_string',
336    'utf8_all',
337    'Vec3',
338    'vec3validate',
339    'verify_object_death',
340    'WeakCall',
341    'WidgetNotFoundError',
342    'workspaces_in_use',
343    'DEFAULT_REQUEST_TIMEOUT_SECONDS',
344]
345
346# We want stuff to show up as babase.Foo instead of babase._sub.Foo.
347set_canonical_module_names(globals())
348
349# Allow the native layer to wrap a few things up.
350_babase.reached_end_of_babase()
351
352# Marker we pop down at the very end so other modules can run sanity
353# checks to make sure we aren't importing them reciprocally when they
354# import us.
355_REACHED_END_OF_MODULE = True
class AccountV2Handle:
426class AccountV2Handle:
427    """Handle for interacting with a V2 account.
428
429    This class supports the 'with' statement, which is how it is
430    used with some operations such as cloud messaging.
431    """
432
433    accountid: str
434    tag: str
435    workspacename: str | None
436    workspaceid: str | None
437    logins: dict[LoginType, LoginInfo]
438
439    def __enter__(self) -> None:
440        """Support for "with" statement.
441
442        This allows cloud messages to be sent on our behalf.
443        """
444
445    def __exit__(self, exc_type: Any, exc_value: Any, traceback: Any) -> Any:
446        """Support for "with" statement.
447
448        This allows cloud messages to be sent on our behalf.
449        """

Handle for interacting with a V2 account.

This class supports the 'with' statement, which is how it is used with some operations such as cloud messaging.

accountid: str
tag: str
workspacename: str | None
workspaceid: str | None
class AccountV2Subsystem:
 26class AccountV2Subsystem:
 27    """Subsystem for modern account handling in the app.
 28
 29    Category: **App Classes**
 30
 31    Access the single shared instance of this class at 'ba.app.plus.accounts'.
 32    """
 33
 34    def __init__(self) -> None:
 35        from babase._login import LoginAdapterGPGS, LoginAdapterGameCenter
 36
 37        # Whether or not everything related to an initial login
 38        # (or lack thereof) has completed. This includes things like
 39        # workspace syncing. Completion of this is what flips the app
 40        # into 'running' state.
 41        self._initial_sign_in_completed = False
 42
 43        self._kicked_off_workspace_load = False
 44
 45        self.login_adapters: dict[LoginType, LoginAdapter] = {}
 46
 47        self._implicit_signed_in_adapter: LoginAdapter | None = None
 48        self._implicit_state_changed = False
 49        self._can_do_auto_sign_in = True
 50
 51        adapter: LoginAdapter
 52        if _babase.using_google_play_game_services():
 53            adapter = LoginAdapterGPGS()
 54            self.login_adapters[adapter.login_type] = adapter
 55        if _babase.using_game_center():
 56            adapter = LoginAdapterGameCenter()
 57            self.login_adapters[adapter.login_type] = adapter
 58
 59    def on_app_loading(self) -> None:
 60        """Should be called at standard on_app_loading time."""
 61
 62        for adapter in self.login_adapters.values():
 63            adapter.on_app_loading()
 64
 65    def have_primary_credentials(self) -> bool:
 66        """Are credentials currently set for the primary app account?
 67
 68        Note that this does not mean these credentials are currently valid;
 69        only that they exist. If/when credentials are validated, the 'primary'
 70        account handle will be set.
 71        """
 72        raise NotImplementedError('This should be overridden.')
 73
 74    @property
 75    def primary(self) -> AccountV2Handle | None:
 76        """The primary account for the app, or None if not logged in."""
 77        return self.do_get_primary()
 78
 79    def on_primary_account_changed(
 80        self, account: AccountV2Handle | None
 81    ) -> None:
 82        """Callback run after the primary account changes.
 83
 84        Will be called with None on log-outs and when new credentials
 85        are set but have not yet been verified.
 86        """
 87        assert _babase.in_logic_thread()
 88
 89        # Currently don't do anything special on sign-outs.
 90        if account is None:
 91            return
 92
 93        # If this new account has a workspace, update it and ask to be
 94        # informed when that process completes.
 95        if account.workspaceid is not None:
 96            assert account.workspacename is not None
 97            if (
 98                not self._initial_sign_in_completed
 99                and not self._kicked_off_workspace_load
100            ):
101                self._kicked_off_workspace_load = True
102                _babase.app.workspaces.set_active_workspace(
103                    account=account,
104                    workspaceid=account.workspaceid,
105                    workspacename=account.workspacename,
106                    on_completed=self._on_set_active_workspace_completed,
107                )
108            else:
109                # Don't activate workspaces if we've already told the game
110                # that initial-log-in is done or if we've already kicked
111                # off a workspace load.
112                _babase.screenmessage(
113                    f'\'{account.workspacename}\''
114                    f' will be activated at next app launch.',
115                    color=(1, 1, 0),
116                )
117                _babase.getsimplesound('error').play()
118            return
119
120        # Ok; no workspace to worry about; carry on.
121        if not self._initial_sign_in_completed:
122            self._initial_sign_in_completed = True
123            _babase.app.on_initial_sign_in_complete()
124
125    def on_active_logins_changed(self, logins: dict[LoginType, str]) -> None:
126        """Should be called when logins for the active account change."""
127
128        for adapter in self.login_adapters.values():
129            adapter.set_active_logins(logins)
130
131    def on_implicit_sign_in(
132        self, login_type: LoginType, login_id: str, display_name: str
133    ) -> None:
134        """An implicit sign-in happened (called by native layer)."""
135        from babase._login import LoginAdapter
136
137        assert _babase.in_logic_thread()
138
139        with _babase.ContextRef.empty():
140            self.login_adapters[login_type].set_implicit_login_state(
141                LoginAdapter.ImplicitLoginState(
142                    login_id=login_id, display_name=display_name
143                )
144            )
145
146    def on_implicit_sign_out(self, login_type: LoginType) -> None:
147        """An implicit sign-out happened (called by native layer)."""
148        assert _babase.in_logic_thread()
149        with _babase.ContextRef.empty():
150            self.login_adapters[login_type].set_implicit_login_state(None)
151
152    def on_no_initial_primary_account(self) -> None:
153        """Callback run if the app has no primary account after launch.
154
155        Either this callback or on_primary_account_changed will be called
156        within a few seconds of app launch; the app can move forward
157        with the startup sequence at that point.
158        """
159        if not self._initial_sign_in_completed:
160            self._initial_sign_in_completed = True
161            _babase.app.on_initial_sign_in_complete()
162
163    @staticmethod
164    def _hashstr(val: str) -> str:
165        md5 = hashlib.md5()
166        md5.update(val.encode())
167        return md5.hexdigest()
168
169    def on_implicit_login_state_changed(
170        self,
171        login_type: LoginType,
172        state: LoginAdapter.ImplicitLoginState | None,
173    ) -> None:
174        """Called when implicit login state changes.
175
176        Login systems that tend to sign themselves in/out in the
177        background are considered implicit. We may choose to honor or
178        ignore their states, allowing the user to opt for other login
179        types even if the default implicit one can't be explicitly
180        logged out or otherwise controlled.
181        """
182        from babase._language import Lstr
183
184        assert _babase.in_logic_thread()
185
186        cfg = _babase.app.config
187        cfgkey = 'ImplicitLoginStates'
188        cfgdict = _babase.app.config.setdefault(cfgkey, {})
189
190        # Store which (if any) adapter is currently implicitly signed
191        # in. Making the assumption there will only ever be one implicit
192        # adapter at a time; may need to revisit this logic if that
193        # changes.
194        prev_state = cfgdict.get(login_type.value)
195        if state is None:
196            self._implicit_signed_in_adapter = None
197            new_state = cfgdict[login_type.value] = None
198        else:
199            self._implicit_signed_in_adapter = self.login_adapters[login_type]
200            new_state = cfgdict[login_type.value] = self._hashstr(
201                state.login_id
202            )
203
204            # Special case: if the user is already signed in but not
205            # with this implicit login, let them know that the 'Welcome
206            # back FOO' they likely just saw is not actually accurate.
207            if (
208                self.primary is not None
209                and not self.login_adapters[login_type].is_back_end_active()
210            ):
211                service_str: Lstr | None
212                if login_type is LoginType.GPGS:
213                    service_str = Lstr(resource='googlePlayText')
214                elif login_type is LoginType.GAME_CENTER:
215                    # Note: Apparently Game Center is just called 'Game
216                    # Center' in all languages. Can revisit if not true.
217                    # https://developer.apple.com/forums/thread/725779
218                    service_str = Lstr(value='Game Center')
219                elif login_type is LoginType.EMAIL:
220                    # Not possible; just here for exhaustive coverage.
221                    service_str = None
222                else:
223                    assert_never(login_type)
224                if service_str is not None:
225                    _babase.apptimer(
226                        2.0,
227                        tpartial(
228                            _babase.screenmessage,
229                            Lstr(
230                                resource='notUsingAccountText',
231                                subs=[
232                                    ('${ACCOUNT}', state.display_name),
233                                    ('${SERVICE}', service_str),
234                                ],
235                            ),
236                            (1, 0.5, 0),
237                        ),
238                    )
239
240        cfg.commit()
241
242        # We want to respond any time the implicit state changes;
243        # generally this means the user has explicitly signed in/out or
244        # switched accounts within that back-end.
245        if prev_state != new_state:
246            if DEBUG_LOG:
247                logging.debug(
248                    'AccountV2: Implicit state changed (%s -> %s);'
249                    ' will update app sign-in state accordingly.',
250                    prev_state,
251                    new_state,
252                )
253            self._implicit_state_changed = True
254
255        # We may want to auto-sign-in based on this new state.
256        self._update_auto_sign_in()
257
258    def on_cloud_connectivity_changed(self, connected: bool) -> None:
259        """Should be called with cloud connectivity changes."""
260        del connected  # Unused.
261        assert _babase.in_logic_thread()
262
263        # We may want to auto-sign-in based on this new state.
264        self._update_auto_sign_in()
265
266    def do_get_primary(self) -> AccountV2Handle | None:
267        """Internal - should be overridden by subclass."""
268        raise NotImplementedError('This should be overridden.')
269
270    def set_primary_credentials(self, credentials: str | None) -> None:
271        """Set credentials for the primary app account."""
272        raise NotImplementedError('This should be overridden.')
273
274    def _update_auto_sign_in(self) -> None:
275        plus = _babase.app.plus
276        assert plus is not None
277
278        # If implicit state has changed, try to respond.
279        if self._implicit_state_changed:
280            if self._implicit_signed_in_adapter is None:
281                # If implicit back-end has signed out, we follow suit
282                # immediately; no need to wait for network connectivity.
283                if DEBUG_LOG:
284                    logging.debug(
285                        'AccountV2: Signing out as result'
286                        ' of implicit state change...',
287                    )
288                plus.accounts.set_primary_credentials(None)
289                self._implicit_state_changed = False
290
291                # Once we've made a move here we don't want to
292                # do any more automatic stuff.
293                self._can_do_auto_sign_in = False
294
295            else:
296                # Ok; we've got a new implicit state. If we've got
297                # connectivity, let's attempt to sign in with it.
298                # Consider this an 'explicit' sign in because the
299                # implicit-login state change presumably was triggered
300                # by some user action (signing in, signing out, or
301                # switching accounts via the back-end). NOTE: should
302                # test case where we don't have connectivity here.
303                if plus.cloud.is_connected():
304                    if DEBUG_LOG:
305                        logging.debug(
306                            'AccountV2: Signing in as result'
307                            ' of implicit state change...',
308                        )
309                    self._implicit_signed_in_adapter.sign_in(
310                        self._on_explicit_sign_in_completed,
311                        description='implicit state change',
312                    )
313                    self._implicit_state_changed = False
314
315                    # Once we've made a move here we don't want to
316                    # do any more automatic stuff.
317                    self._can_do_auto_sign_in = False
318
319        if not self._can_do_auto_sign_in:
320            return
321
322        # If we're not currently signed in, we have connectivity, and
323        # we have an available implicit login, auto-sign-in with it once.
324        # The implicit-state-change logic above should keep things
325        # mostly in-sync, but that might not always be the case due to
326        # connectivity or other issues. We prefer to keep people signed
327        # in as a rule, even if there are corner cases where this might
328        # not be what they want (A user signing out and then restarting
329        # may be auto-signed back in).
330        connected = plus.cloud.is_connected()
331        signed_in_v1 = plus.get_v1_account_state() == 'signed_in'
332        signed_in_v2 = plus.accounts.have_primary_credentials()
333        if (
334            connected
335            and not signed_in_v1
336            and not signed_in_v2
337            and self._implicit_signed_in_adapter is not None
338        ):
339            if DEBUG_LOG:
340                logging.debug(
341                    'AccountV2: Signing in due to on-launch-auto-sign-in...',
342                )
343            self._can_do_auto_sign_in = False  # Only ATTEMPT once
344            self._implicit_signed_in_adapter.sign_in(
345                self._on_implicit_sign_in_completed, description='auto-sign-in'
346            )
347
348    def _on_explicit_sign_in_completed(
349        self,
350        adapter: LoginAdapter,
351        result: LoginAdapter.SignInResult | Exception,
352    ) -> None:
353        """A sign-in has completed that the user asked for explicitly."""
354        from babase._language import Lstr
355
356        del adapter  # Unused.
357
358        plus = _babase.app.plus
359        assert plus is not None
360
361        # Make some noise on errors since the user knows a
362        # sign-in attempt is happening in this case (the 'explicit' part).
363        if isinstance(result, Exception):
364            # We expect the occasional communication errors;
365            # Log a full exception for anything else though.
366            if not isinstance(result, CommunicationError):
367                logging.warning(
368                    'Error on explicit accountv2 sign in attempt.',
369                    exc_info=result,
370                )
371
372            # For now just show 'error'. Should do better than this.
373            _babase.screenmessage(
374                Lstr(resource='internal.signInErrorText'),
375                color=(1, 0, 0),
376            )
377            _babase.getsimplesound('error').play()
378
379            # Also I suppose we should sign them out in this case since
380            # it could be misleading to be still signed in with the old
381            # account.
382            plus.accounts.set_primary_credentials(None)
383            return
384
385        plus.accounts.set_primary_credentials(result.credentials)
386
387    def _on_implicit_sign_in_completed(
388        self,
389        adapter: LoginAdapter,
390        result: LoginAdapter.SignInResult | Exception,
391    ) -> None:
392        """A sign-in has completed that the user didn't ask for explicitly."""
393        plus = _babase.app.plus
394        assert plus is not None
395
396        del adapter  # Unused.
397
398        # Log errors but don't inform the user; they're not aware of this
399        # attempt and ignorance is bliss.
400        if isinstance(result, Exception):
401            # We expect the occasional communication errors;
402            # Log a full exception for anything else though.
403            if not isinstance(result, CommunicationError):
404                logging.warning(
405                    'Error on implicit accountv2 sign in attempt.',
406                    exc_info=result,
407                )
408            return
409
410        # If we're still connected and still not signed in,
411        # plug in the credentials we got. We want to be extra cautious
412        # in case the user has since explicitly signed in since we
413        # kicked off.
414        connected = plus.cloud.is_connected()
415        signed_in_v1 = plus.get_v1_account_state() == 'signed_in'
416        signed_in_v2 = plus.accounts.have_primary_credentials()
417        if connected and not signed_in_v1 and not signed_in_v2:
418            plus.accounts.set_primary_credentials(result.credentials)
419
420    def _on_set_active_workspace_completed(self) -> None:
421        if not self._initial_sign_in_completed:
422            self._initial_sign_in_completed = True
423            _babase.app.on_initial_sign_in_complete()

Subsystem for modern account handling in the app.

Category: App Classes

Access the single shared instance of this class at 'ba.app.plus.accounts'.

login_adapters: dict[bacommon.login.LoginType, LoginAdapter]
def on_app_loading(self) -> None:
59    def on_app_loading(self) -> None:
60        """Should be called at standard on_app_loading time."""
61
62        for adapter in self.login_adapters.values():
63            adapter.on_app_loading()

Should be called at standard on_app_loading time.

def have_primary_credentials(self) -> bool:
65    def have_primary_credentials(self) -> bool:
66        """Are credentials currently set for the primary app account?
67
68        Note that this does not mean these credentials are currently valid;
69        only that they exist. If/when credentials are validated, the 'primary'
70        account handle will be set.
71        """
72        raise NotImplementedError('This should be overridden.')

Are credentials currently set for the primary app account?

Note that this does not mean these credentials are currently valid; only that they exist. If/when credentials are validated, the 'primary' account handle will be set.

primary: AccountV2Handle | None
74    @property
75    def primary(self) -> AccountV2Handle | None:
76        """The primary account for the app, or None if not logged in."""
77        return self.do_get_primary()

The primary account for the app, or None if not logged in.

def on_primary_account_changed(self, account: AccountV2Handle | None) -> None:
 79    def on_primary_account_changed(
 80        self, account: AccountV2Handle | None
 81    ) -> None:
 82        """Callback run after the primary account changes.
 83
 84        Will be called with None on log-outs and when new credentials
 85        are set but have not yet been verified.
 86        """
 87        assert _babase.in_logic_thread()
 88
 89        # Currently don't do anything special on sign-outs.
 90        if account is None:
 91            return
 92
 93        # If this new account has a workspace, update it and ask to be
 94        # informed when that process completes.
 95        if account.workspaceid is not None:
 96            assert account.workspacename is not None
 97            if (
 98                not self._initial_sign_in_completed
 99                and not self._kicked_off_workspace_load
100            ):
101                self._kicked_off_workspace_load = True
102                _babase.app.workspaces.set_active_workspace(
103                    account=account,
104                    workspaceid=account.workspaceid,
105                    workspacename=account.workspacename,
106                    on_completed=self._on_set_active_workspace_completed,
107                )
108            else:
109                # Don't activate workspaces if we've already told the game
110                # that initial-log-in is done or if we've already kicked
111                # off a workspace load.
112                _babase.screenmessage(
113                    f'\'{account.workspacename}\''
114                    f' will be activated at next app launch.',
115                    color=(1, 1, 0),
116                )
117                _babase.getsimplesound('error').play()
118            return
119
120        # Ok; no workspace to worry about; carry on.
121        if not self._initial_sign_in_completed:
122            self._initial_sign_in_completed = True
123            _babase.app.on_initial_sign_in_complete()

Callback run after the primary account changes.

Will be called with None on log-outs and when new credentials are set but have not yet been verified.

def on_active_logins_changed(self, logins: dict[bacommon.login.LoginType, str]) -> None:
125    def on_active_logins_changed(self, logins: dict[LoginType, str]) -> None:
126        """Should be called when logins for the active account change."""
127
128        for adapter in self.login_adapters.values():
129            adapter.set_active_logins(logins)

Should be called when logins for the active account change.

def on_implicit_sign_in( self, login_type: bacommon.login.LoginType, login_id: str, display_name: str) -> None:
131    def on_implicit_sign_in(
132        self, login_type: LoginType, login_id: str, display_name: str
133    ) -> None:
134        """An implicit sign-in happened (called by native layer)."""
135        from babase._login import LoginAdapter
136
137        assert _babase.in_logic_thread()
138
139        with _babase.ContextRef.empty():
140            self.login_adapters[login_type].set_implicit_login_state(
141                LoginAdapter.ImplicitLoginState(
142                    login_id=login_id, display_name=display_name
143                )
144            )

An implicit sign-in happened (called by native layer).

def on_implicit_sign_out(self, login_type: bacommon.login.LoginType) -> None:
146    def on_implicit_sign_out(self, login_type: LoginType) -> None:
147        """An implicit sign-out happened (called by native layer)."""
148        assert _babase.in_logic_thread()
149        with _babase.ContextRef.empty():
150            self.login_adapters[login_type].set_implicit_login_state(None)

An implicit sign-out happened (called by native layer).

def on_no_initial_primary_account(self) -> None:
152    def on_no_initial_primary_account(self) -> None:
153        """Callback run if the app has no primary account after launch.
154
155        Either this callback or on_primary_account_changed will be called
156        within a few seconds of app launch; the app can move forward
157        with the startup sequence at that point.
158        """
159        if not self._initial_sign_in_completed:
160            self._initial_sign_in_completed = True
161            _babase.app.on_initial_sign_in_complete()

Callback run if the app has no primary account after launch.

Either this callback or on_primary_account_changed will be called within a few seconds of app launch; the app can move forward with the startup sequence at that point.

def on_implicit_login_state_changed( self, login_type: bacommon.login.LoginType, state: LoginAdapter.ImplicitLoginState | None) -> None:
169    def on_implicit_login_state_changed(
170        self,
171        login_type: LoginType,
172        state: LoginAdapter.ImplicitLoginState | None,
173    ) -> None:
174        """Called when implicit login state changes.
175
176        Login systems that tend to sign themselves in/out in the
177        background are considered implicit. We may choose to honor or
178        ignore their states, allowing the user to opt for other login
179        types even if the default implicit one can't be explicitly
180        logged out or otherwise controlled.
181        """
182        from babase._language import Lstr
183
184        assert _babase.in_logic_thread()
185
186        cfg = _babase.app.config
187        cfgkey = 'ImplicitLoginStates'
188        cfgdict = _babase.app.config.setdefault(cfgkey, {})
189
190        # Store which (if any) adapter is currently implicitly signed
191        # in. Making the assumption there will only ever be one implicit
192        # adapter at a time; may need to revisit this logic if that
193        # changes.
194        prev_state = cfgdict.get(login_type.value)
195        if state is None:
196            self._implicit_signed_in_adapter = None
197            new_state = cfgdict[login_type.value] = None
198        else:
199            self._implicit_signed_in_adapter = self.login_adapters[login_type]
200            new_state = cfgdict[login_type.value] = self._hashstr(
201                state.login_id
202            )
203
204            # Special case: if the user is already signed in but not
205            # with this implicit login, let them know that the 'Welcome
206            # back FOO' they likely just saw is not actually accurate.
207            if (
208                self.primary is not None
209                and not self.login_adapters[login_type].is_back_end_active()
210            ):
211                service_str: Lstr | None
212                if login_type is LoginType.GPGS:
213                    service_str = Lstr(resource='googlePlayText')
214                elif login_type is LoginType.GAME_CENTER:
215                    # Note: Apparently Game Center is just called 'Game
216                    # Center' in all languages. Can revisit if not true.
217                    # https://developer.apple.com/forums/thread/725779
218                    service_str = Lstr(value='Game Center')
219                elif login_type is LoginType.EMAIL:
220                    # Not possible; just here for exhaustive coverage.
221                    service_str = None
222                else:
223                    assert_never(login_type)
224                if service_str is not None:
225                    _babase.apptimer(
226                        2.0,
227                        tpartial(
228                            _babase.screenmessage,
229                            Lstr(
230                                resource='notUsingAccountText',
231                                subs=[
232                                    ('${ACCOUNT}', state.display_name),
233                                    ('${SERVICE}', service_str),
234                                ],
235                            ),
236                            (1, 0.5, 0),
237                        ),
238                    )
239
240        cfg.commit()
241
242        # We want to respond any time the implicit state changes;
243        # generally this means the user has explicitly signed in/out or
244        # switched accounts within that back-end.
245        if prev_state != new_state:
246            if DEBUG_LOG:
247                logging.debug(
248                    'AccountV2: Implicit state changed (%s -> %s);'
249                    ' will update app sign-in state accordingly.',
250                    prev_state,
251                    new_state,
252                )
253            self._implicit_state_changed = True
254
255        # We may want to auto-sign-in based on this new state.
256        self._update_auto_sign_in()

Called when implicit login state changes.

Login systems that tend to sign themselves in/out in the background are considered implicit. We may choose to honor or ignore their states, allowing the user to opt for other login types even if the default implicit one can't be explicitly logged out or otherwise controlled.

def on_cloud_connectivity_changed(self, connected: bool) -> None:
258    def on_cloud_connectivity_changed(self, connected: bool) -> None:
259        """Should be called with cloud connectivity changes."""
260        del connected  # Unused.
261        assert _babase.in_logic_thread()
262
263        # We may want to auto-sign-in based on this new state.
264        self._update_auto_sign_in()

Should be called with cloud connectivity changes.

def do_get_primary(self) -> AccountV2Handle | None:
266    def do_get_primary(self) -> AccountV2Handle | None:
267        """Internal - should be overridden by subclass."""
268        raise NotImplementedError('This should be overridden.')

Internal - should be overridden by subclass.

def set_primary_credentials(self, credentials: str | None) -> None:
270    def set_primary_credentials(self, credentials: str | None) -> None:
271        """Set credentials for the primary app account."""
272        raise NotImplementedError('This should be overridden.')

Set credentials for the primary app account.

class ActivityNotFoundError(babase.NotFoundError):
89class ActivityNotFoundError(NotFoundError):
90    """Exception raised when an expected bascenev1.Activity does not exist.
91
92    Category: **Exception Classes**
93    """

Exception raised when an expected bascenev1.Activity does not exist.

Category: Exception Classes

Inherited Members
builtins.Exception
Exception
builtins.BaseException
with_traceback
add_note
args
class ActorNotFoundError(babase.NotFoundError):
82class ActorNotFoundError(NotFoundError):
83    """Exception raised when an expected actor does not exist.
84
85    Category: **Exception Classes**
86    """

Exception raised when an expected actor does not exist.

Category: Exception Classes

Inherited Members
builtins.Exception
Exception
builtins.BaseException
with_traceback
add_note
args
app = <App object>
class App:
  51class App:
  52    """A class for high level app functionality and state.
  53
  54    Category: **App Classes**
  55
  56    Use babase.app to access the single shared instance of this class.
  57
  58    Note that properties not documented here should be considered internal
  59    and subject to change without warning.
  60    """
  61
  62    # pylint: disable=too-many-public-methods
  63
  64    # A few things defined as non-optional values but not actually
  65    # available until the app starts.
  66    plugins: PluginSubsystem
  67    lang: LanguageSubsystem
  68    health_monitor: AppHealthMonitor
  69
  70    # How long we allow shutdown tasks to run before killing them.
  71    # Currently the entire app hard-exits if shutdown takes 10 seconds,
  72    # so we need to keep it under that.
  73    SHUTDOWN_TASK_TIMEOUT_SECONDS = 5
  74
  75    class State(Enum):
  76        """High level state the app can be in."""
  77
  78        # The app has not yet begun starting and should not be used in
  79        # any way.
  80        NOT_STARTED = 0
  81
  82        # The native layer is spinning up its machinery (screens,
  83        # renderers, etc.). Nothing should happen in the Python layer
  84        # until this completes.
  85        NATIVE_BOOTSTRAPPING = 1
  86
  87        # Python app subsystems are being inited but should not yet
  88        # interact or do any work.
  89        INITING = 2
  90
  91        # Python app subsystems are inited and interacting, but the app
  92        # has not yet embarked on a high level course of action. It is
  93        # doing initial account logins, workspace & asset downloads,
  94        # etc.
  95        LOADING = 3
  96
  97        # All pieces are in place and the app is now doing its thing.
  98        RUNNING = 4
  99
 100        # Used on platforms such as mobile where the app basically needs
 101        # to shut down while backgrounded. In this state, all event
 102        # loops are suspended and all graphics and audio must cease
 103        # completely. Be aware that the suspended state can be entered
 104        # from any other state including NATIVE_BOOTSTRAPPING and
 105        # SHUTTING_DOWN.
 106        SUSPENDED = 5
 107
 108        # The app is shutting down. This process may involve sending
 109        # network messages or other things that can take up to a few
 110        # seconds, so ideally graphics and audio should remain
 111        # functional (with fades or spinners or whatever to show
 112        # something is happening).
 113        SHUTTING_DOWN = 6
 114
 115        # The app has completed shutdown. Any code running here should
 116        # be basically immediate.
 117        SHUTDOWN_COMPLETE = 7
 118
 119    class DefaultAppModeSelector(AppModeSelector):
 120        """Decides which AppModes to use to handle AppIntents.
 121
 122        This default version is generated by the project updater based
 123        on the 'default_app_modes' value in the projectconfig.
 124
 125        It is also possible to modify app mode selection behavior by
 126        setting app.mode_selector to an instance of a custom
 127        AppModeSelector subclass. This is a good way to go if you are
 128        modifying app behavior dynamically via a plugin instead of
 129        statically in a spinoff project.
 130        """
 131
 132        @override
 133        def app_mode_for_intent(
 134            self, intent: AppIntent
 135        ) -> type[AppMode] | None:
 136            # pylint: disable=cyclic-import
 137
 138            # __DEFAULT_APP_MODE_SELECTION_BEGIN__
 139            # This section generated by batools.appmodule; do not edit.
 140
 141            # Ask our default app modes to handle it.
 142            # (generated from 'default_app_modes' in projectconfig).
 143            import bascenev1
 144            import babase
 145
 146            for appmode in [
 147                bascenev1.SceneV1AppMode,
 148                babase.EmptyAppMode,
 149            ]:
 150                if appmode.can_handle_intent(intent):
 151                    return appmode
 152
 153            return None
 154
 155            # __DEFAULT_APP_MODE_SELECTION_END__
 156
 157    def __init__(self) -> None:
 158        """(internal)
 159
 160        Do not instantiate this class. You can access the single shared
 161        instance of it through various high level packages: 'babase.app',
 162        'bascenev1.app', 'bauiv1.app', etc.
 163        """
 164
 165        # Hack for docs-generation: we can be imported with dummy modules
 166        # instead of our actual binary ones, but we don't function.
 167        if os.environ.get('BA_RUNNING_WITH_DUMMY_MODULES') == '1':
 168            return
 169
 170        self.env: babase.Env = _babase.Env()
 171        self.state = self.State.NOT_STARTED
 172
 173        # Default executor which can be used for misc background
 174        # processing. It should also be passed to any additional asyncio
 175        # loops we create so that everything shares the same single set
 176        # of worker threads.
 177        self.threadpool = ThreadPoolExecutor(
 178            thread_name_prefix='baworker',
 179            initializer=self._thread_pool_thread_init,
 180        )
 181
 182        self.meta = MetadataSubsystem()
 183        self.net = NetworkSubsystem()
 184        self.workspaces = WorkspaceSubsystem()
 185        self.components = AppComponentSubsystem()
 186        self.stringedit = StringEditSubsystem()
 187        self.devconsole = DevConsoleSubsystem()
 188
 189        # This is incremented any time the app is backgrounded or
 190        # foregrounded; can be a simple way to determine if network data
 191        # should be refreshed/etc.
 192        self.fg_state = 0
 193
 194        self._subsystems: list[AppSubsystem] = []
 195        self._native_bootstrapping_completed = False
 196        self._init_completed = False
 197        self._meta_scan_completed = False
 198        self._native_start_called = False
 199        self._native_suspended = False
 200        self._native_shutdown_called = False
 201        self._native_shutdown_complete_called = False
 202        self._initial_sign_in_completed = False
 203        self._called_on_initing = False
 204        self._called_on_loading = False
 205        self._called_on_running = False
 206        self._subsystem_registration_ended = False
 207        self._pending_apply_app_config = False
 208        self._asyncio_loop: asyncio.AbstractEventLoop | None = None
 209        self._asyncio_tasks: set[asyncio.Task] = set()
 210        self._asyncio_timer: babase.AppTimer | None = None
 211        self._config: babase.AppConfig | None = None
 212        self._pending_intent: AppIntent | None = None
 213        self._intent: AppIntent | None = None
 214        self._mode: AppMode | None = None
 215        self._mode_selector: babase.AppModeSelector | None = None
 216        self._shutdown_task: asyncio.Task[None] | None = None
 217        self._shutdown_tasks: list[Coroutine[None, None, None]] = [
 218            self._wait_for_shutdown_suppressions(),
 219            self._fade_and_shutdown_graphics(),
 220            self._fade_and_shutdown_audio(),
 221        ]
 222        self._pool_thread_count = 0
 223
 224        # We hold a lock while lazy-loading our subsystem properties so
 225        # we don't spin up any subsystem more than once, but the lock is
 226        # recursive so that the subsystems can instantiate other
 227        # subsystems.
 228        self._subsystem_property_lock = RLock()
 229        self._subsystem_property_data: dict[str, AppSubsystem | bool] = {}
 230
 231    def postinit(self) -> None:
 232        """Called after we've been inited and assigned to babase.app.
 233
 234        Anything that accesses babase.app as part of its init process
 235        must go here instead of __init__.
 236        """
 237
 238        # Hack for docs-generation: We can be imported with dummy
 239        # modules instead of our actual binary ones, but we don't
 240        # function.
 241        if os.environ.get('BA_RUNNING_WITH_DUMMY_MODULES') == '1':
 242            return
 243
 244        self.lang = LanguageSubsystem()
 245        self.plugins = PluginSubsystem()
 246
 247    @property
 248    def active(self) -> bool:
 249        """Whether the app is currently front and center.
 250
 251        This will be False when the app is hidden, other activities
 252        are covering it, etc. (depending on the platform).
 253        """
 254        return _babase.app_is_active()
 255
 256    @property
 257    def asyncio_loop(self) -> asyncio.AbstractEventLoop:
 258        """The logic thread's asyncio event loop.
 259
 260        This allow async tasks to be run in the logic thread.
 261
 262        Generally you should call App.create_async_task() to schedule
 263        async code to run instead of using this directly. That will
 264        handle retaining the task and logging errors automatically.
 265        Only schedule tasks onto asyncio_loop yourself when you intend
 266        to hold on to the returned task and await its results. Releasing
 267        the task reference can lead to subtle bugs such as unreported
 268        errors and garbage-collected tasks disappearing before their
 269        work is done.
 270
 271        Note that, at this time, the asyncio loop is encapsulated
 272        and explicitly stepped by the engine's logic thread loop and
 273        thus things like asyncio.get_running_loop() will unintuitively
 274        *not* return this loop from most places in the logic thread;
 275        only from within a task explicitly created in this loop.
 276        Hopefully this situation will be improved in the future with a
 277        unified event loop.
 278        """
 279        assert _babase.in_logic_thread()
 280        assert self._asyncio_loop is not None
 281        return self._asyncio_loop
 282
 283    def create_async_task(
 284        self, coro: Coroutine[Any, Any, T], *, name: str | None = None
 285    ) -> None:
 286        """Create a fully managed async task.
 287
 288        This will automatically retain and release a reference to the task
 289        and log any exceptions that occur in it. If you need to await a task
 290        or otherwise need more control, schedule a task directly using
 291        App.asyncio_loop.
 292        """
 293        assert _babase.in_logic_thread()
 294
 295        # Hold a strong reference to the task until it is done.
 296        # Otherwise it is possible for it to be garbage collected and
 297        # disappear midway if the caller does not hold on to the
 298        # returned task, which seems like a great way to introduce
 299        # hard-to-track bugs.
 300        task = self.asyncio_loop.create_task(coro, name=name)
 301        self._asyncio_tasks.add(task)
 302        task.add_done_callback(self._on_task_done)
 303
 304    def _on_task_done(self, task: asyncio.Task) -> None:
 305        # Report any errors that occurred.
 306        try:
 307            exc = task.exception()
 308            if exc is not None:
 309                logging.error(
 310                    "Error in async task '%s'.", task.get_name(), exc_info=exc
 311                )
 312        except Exception:
 313            logging.exception('Error reporting async task error.')
 314
 315        self._asyncio_tasks.remove(task)
 316
 317    @property
 318    def config(self) -> babase.AppConfig:
 319        """The babase.AppConfig instance representing the app's config state."""
 320        assert self._config is not None
 321        return self._config
 322
 323    @property
 324    def mode_selector(self) -> babase.AppModeSelector:
 325        """Controls which app-modes are used for handling given intents.
 326
 327        Plugins can override this to change high level app behavior and
 328        spinoff projects can change the default implementation for the
 329        same effect.
 330        """
 331        if self._mode_selector is None:
 332            raise RuntimeError(
 333                'mode_selector cannot be used until the app reaches'
 334                ' the running state.'
 335            )
 336        return self._mode_selector
 337
 338    @mode_selector.setter
 339    def mode_selector(self, selector: babase.AppModeSelector) -> None:
 340        self._mode_selector = selector
 341
 342    def _get_subsystem_property(
 343        self, ssname: str, create_call: Callable[[], AppSubsystem | None]
 344    ) -> AppSubsystem | None:
 345
 346        # Quick-out: if a subsystem is present, just return it; no
 347        # locking necessary.
 348        val = self._subsystem_property_data.get(ssname)
 349        if val is not None:
 350            if val is False:
 351                # False means subsystem is confirmed as unavailable.
 352                return None
 353            if val is not True:
 354                # A subsystem has been set. Return it.
 355                return val
 356
 357        # Anything else (no val present or val True) requires locking.
 358        with self._subsystem_property_lock:
 359            val = self._subsystem_property_data.get(ssname)
 360            if val is not None:
 361                if val is False:
 362                    # False means confirmed as not present.
 363                    return None
 364                if val is True:
 365                    # True means this property is already being loaded,
 366                    # and the fact that we're holding the lock means
 367                    # we're doing the loading, so this is a dependency
 368                    # loop. Not good.
 369                    raise RuntimeError(
 370                        f'Subsystem dependency loop detected for {ssname}'
 371                    )
 372                # Must be an instantiated subsystem. Noice.
 373                return val
 374
 375            # Ok, there's nothing here for it. Instantiate and set it
 376            # while we hold the lock. Set a placeholder value of True
 377            # while we load so we can error if something we're loading
 378            # tries to recursively load us.
 379            self._subsystem_property_data[ssname] = True
 380
 381            # Do our one attempt to create the singleton.
 382            val = create_call()
 383            self._subsystem_property_data[ssname] = (
 384                False if val is None else val
 385            )
 386
 387        return val
 388
 389    # __FEATURESET_APP_SUBSYSTEM_PROPERTIES_BEGIN__
 390    # This section generated by batools.appmodule; do not edit.
 391
 392    @property
 393    def classic(self) -> ClassicSubsystem | None:
 394        """Our classic subsystem (if available)."""
 395        return self._get_subsystem_property(
 396            'classic', self._create_classic_subsystem
 397        )  # type: ignore
 398
 399    @staticmethod
 400    def _create_classic_subsystem() -> ClassicSubsystem | None:
 401        # pylint: disable=cyclic-import
 402        try:
 403            from baclassic import ClassicSubsystem
 404
 405            return ClassicSubsystem()
 406        except ImportError:
 407            return None
 408        except Exception:
 409            logging.exception('Error importing baclassic.')
 410            return None
 411
 412    @property
 413    def plus(self) -> PlusSubsystem | None:
 414        """Our plus subsystem (if available)."""
 415        return self._get_subsystem_property(
 416            'plus', self._create_plus_subsystem
 417        )  # type: ignore
 418
 419    @staticmethod
 420    def _create_plus_subsystem() -> PlusSubsystem | None:
 421        # pylint: disable=cyclic-import
 422        try:
 423            from baplus import PlusSubsystem
 424
 425            return PlusSubsystem()
 426        except ImportError:
 427            return None
 428        except Exception:
 429            logging.exception('Error importing baplus.')
 430            return None
 431
 432    @property
 433    def ui_v1(self) -> UIV1Subsystem:
 434        """Our ui_v1 subsystem (always available)."""
 435        return self._get_subsystem_property(
 436            'ui_v1', self._create_ui_v1_subsystem
 437        )  # type: ignore
 438
 439    @staticmethod
 440    def _create_ui_v1_subsystem() -> UIV1Subsystem:
 441        # pylint: disable=cyclic-import
 442
 443        from bauiv1 import UIV1Subsystem
 444
 445        return UIV1Subsystem()
 446
 447    # __FEATURESET_APP_SUBSYSTEM_PROPERTIES_END__
 448
 449    def register_subsystem(self, subsystem: AppSubsystem) -> None:
 450        """Called by the AppSubsystem class. Do not use directly."""
 451
 452        # We only allow registering new subsystems if we've not yet
 453        # reached the 'running' state. This ensures that all subsystems
 454        # receive a consistent set of callbacks starting with
 455        # on_app_running().
 456
 457        if self._subsystem_registration_ended:
 458            raise RuntimeError(
 459                'Subsystems can no longer be registered at this point.'
 460            )
 461        self._subsystems.append(subsystem)
 462
 463    def add_shutdown_task(self, coro: Coroutine[None, None, None]) -> None:
 464        """Add a task to be run on app shutdown.
 465
 466        Note that shutdown tasks will be canceled after
 467        App.SHUTDOWN_TASK_TIMEOUT_SECONDS if they are still running.
 468        """
 469        if (
 470            self.state is self.State.SHUTTING_DOWN
 471            or self.state is self.State.SHUTDOWN_COMPLETE
 472        ):
 473            stname = self.state.name
 474            raise RuntimeError(
 475                f'Cannot add shutdown tasks with current state {stname}.'
 476            )
 477        self._shutdown_tasks.append(coro)
 478
 479    def run(self) -> None:
 480        """Run the app to completion.
 481
 482        Note that this only works on builds where Ballistica manages
 483        its own event loop.
 484        """
 485        _babase.run_app()
 486
 487    def threadpool_submit_no_wait(self, call: Callable[[], Any]) -> None:
 488        """Submit a call to the app threadpool where result is not needed.
 489
 490        Normally, doing work in a thread-pool involves creating a future
 491        and waiting for its result, which is an important step because it
 492        propagates any Exceptions raised by the submitted work. When the
 493        result in not important, however, this call can be used. The app
 494        will log any exceptions that occur.
 495        """
 496        fut = self.threadpool.submit(call)
 497        fut.add_done_callback(self._threadpool_no_wait_done)
 498
 499    def set_intent(self, intent: AppIntent) -> None:
 500        """Set the intent for the app.
 501
 502        Intent defines what the app is trying to do at a given time.
 503        This call is asynchronous; the intent switch will happen in the
 504        logic thread in the near future. If set_intent is called
 505        repeatedly before the change takes place, the final intent to be
 506        set will be used.
 507        """
 508
 509        # Mark this one as pending. We do this synchronously so that the
 510        # last one marked actually takes effect if there is overlap
 511        # (doing this in the bg thread could result in race conditions).
 512        self._pending_intent = intent
 513
 514        # Do the actual work of calcing our app-mode/etc. in a bg thread
 515        # since it may block for a moment to load modules/etc.
 516        self.threadpool_submit_no_wait(tpartial(self._set_intent, intent))
 517
 518    def push_apply_app_config(self) -> None:
 519        """Internal. Use app.config.apply() to apply app config changes."""
 520        # To be safe, let's run this by itself in the event loop.
 521        # This avoids potential trouble if this gets called mid-draw or
 522        # something like that.
 523        self._pending_apply_app_config = True
 524        _babase.pushcall(self._apply_app_config, raw=True)
 525
 526    def on_native_start(self) -> None:
 527        """Called by the native layer when the app is being started."""
 528        assert _babase.in_logic_thread()
 529        assert not self._native_start_called
 530        self._native_start_called = True
 531        self._update_state()
 532
 533    def on_native_bootstrapping_complete(self) -> None:
 534        """Called by the native layer once its ready to rock."""
 535        assert _babase.in_logic_thread()
 536        assert not self._native_bootstrapping_completed
 537        self._native_bootstrapping_completed = True
 538        self._update_state()
 539
 540    def on_native_suspend(self) -> None:
 541        """Called by the native layer when the app is suspended."""
 542        assert _babase.in_logic_thread()
 543        assert not self._native_suspended  # Should avoid redundant calls.
 544        self._native_suspended = True
 545        self._update_state()
 546
 547    def on_native_unsuspend(self) -> None:
 548        """Called by the native layer when the app suspension ends."""
 549        assert _babase.in_logic_thread()
 550        assert self._native_suspended  # Should avoid redundant calls.
 551        self._native_suspended = False
 552        self._update_state()
 553
 554    def on_native_shutdown(self) -> None:
 555        """Called by the native layer when the app starts shutting down."""
 556        assert _babase.in_logic_thread()
 557        self._native_shutdown_called = True
 558        self._update_state()
 559
 560    def on_native_shutdown_complete(self) -> None:
 561        """Called by the native layer when the app is done shutting down."""
 562        assert _babase.in_logic_thread()
 563        self._native_shutdown_complete_called = True
 564        self._update_state()
 565
 566    def on_native_active_changed(self) -> None:
 567        """Called by the native layer when the app active state changes."""
 568        assert _babase.in_logic_thread()
 569        if self._mode is not None:
 570            self._mode.on_app_active_changed()
 571
 572    def read_config(self) -> None:
 573        """(internal)"""
 574        from babase._appconfig import read_app_config
 575
 576        self._config = read_app_config()
 577
 578    def handle_deep_link(self, url: str) -> None:
 579        """Handle a deep link URL."""
 580        from babase._language import Lstr
 581
 582        assert _babase.in_logic_thread()
 583
 584        appname = _babase.appname()
 585        if url.startswith(f'{appname}://code/'):
 586            code = url.replace(f'{appname}://code/', '')
 587            if self.classic is not None:
 588                self.classic.accounts.add_pending_promo_code(code)
 589        else:
 590            try:
 591                _babase.screenmessage(
 592                    Lstr(resource='errorText'), color=(1, 0, 0)
 593                )
 594                _babase.getsimplesound('error').play()
 595            except ImportError:
 596                pass
 597
 598    def on_initial_sign_in_complete(self) -> None:
 599        """Called when initial sign-in (or lack thereof) completes.
 600
 601        This normally gets called by the plus subsystem. The
 602        initial-sign-in process may include tasks such as syncing
 603        account workspaces or other data so it may take a substantial
 604        amount of time.
 605        """
 606        assert _babase.in_logic_thread()
 607        assert not self._initial_sign_in_completed
 608
 609        # Tell meta it can start scanning extra stuff that just showed
 610        # up (namely account workspaces).
 611        self.meta.start_extra_scan()
 612
 613        self._initial_sign_in_completed = True
 614        self._update_state()
 615
 616    def _set_intent(self, intent: AppIntent) -> None:
 617        # This should be happening in a bg thread.
 618        assert not _babase.in_logic_thread()
 619        try:
 620            # Ask the selector what app-mode to use for this intent.
 621            if self.mode_selector is None:
 622                raise RuntimeError('No AppModeSelector set.')
 623            modetype = self.mode_selector.app_mode_for_intent(intent)
 624
 625            # NOTE: Since intents are somewhat high level things, should
 626            # we do some universal thing like a screenmessage saying
 627            # 'The app cannot handle that request' on failure?
 628
 629            if modetype is None:
 630                raise RuntimeError(
 631                    f'No app-mode found to handle app-intent'
 632                    f' type {type(intent)}.'
 633                )
 634
 635            # Make sure the app-mode the selector gave us *actually*
 636            # supports the intent.
 637            if not modetype.can_handle_intent(intent):
 638                raise RuntimeError(
 639                    f'Intent {intent} cannot be handled by AppMode type'
 640                    f' {modetype} (selector {self.mode_selector}'
 641                    f' incorrectly thinks that it can be).'
 642                )
 643
 644            # Ok; seems legit. Now instantiate the mode if necessary and
 645            # kick back to the logic thread to apply.
 646            mode = modetype()
 647            _babase.pushcall(
 648                tpartial(self._apply_intent, intent, mode),
 649                from_other_thread=True,
 650            )
 651        except Exception:
 652            logging.exception('Error setting app intent to %s.', intent)
 653            _babase.pushcall(
 654                tpartial(self._display_set_intent_error, intent),
 655                from_other_thread=True,
 656            )
 657
 658    def _apply_intent(self, intent: AppIntent, mode: AppMode) -> None:
 659        assert _babase.in_logic_thread()
 660
 661        # ONLY apply this intent if it is still the most recent one
 662        # submitted.
 663        if intent is not self._pending_intent:
 664            return
 665
 666        # If the app-mode for this intent is different than the active
 667        # one, switch.
 668        if type(mode) is not type(self._mode):
 669            if self._mode is None:
 670                is_initial_mode = True
 671            else:
 672                is_initial_mode = False
 673                try:
 674                    self._mode.on_deactivate()
 675                except Exception:
 676                    logging.exception(
 677                        'Error deactivating app-mode %s.', self._mode
 678                    )
 679            self._mode = mode
 680            try:
 681                mode.on_activate()
 682            except Exception:
 683                # Hmm; what should we do in this case?...
 684                logging.exception('Error activating app-mode %s.', mode)
 685
 686            # Let the world know when we first have an app-mode; certain
 687            # app stuff such as input processing can proceed at that
 688            # point.
 689            if is_initial_mode:
 690                _babase.on_initial_app_mode_set()
 691
 692        try:
 693            mode.handle_intent(intent)
 694        except Exception:
 695            logging.exception(
 696                'Error handling intent %s in app-mode %s.', intent, mode
 697            )
 698
 699    def _display_set_intent_error(self, intent: AppIntent) -> None:
 700        """Show the *user* something went wrong setting an intent."""
 701        from babase._language import Lstr
 702
 703        del intent
 704        _babase.screenmessage(Lstr(resource='errorText'), color=(1, 0, 0))
 705        _babase.getsimplesound('error').play()
 706
 707    def _on_initing(self) -> None:
 708        """Called when the app enters the initing state.
 709
 710        Here we can put together subsystems and other pieces for the
 711        app, but most things should not be doing any work yet.
 712        """
 713        # pylint: disable=cyclic-import
 714        from babase import _asyncio
 715        from babase import _appconfig
 716        from babase._apputils import AppHealthMonitor
 717        from babase import _env
 718
 719        assert _babase.in_logic_thread()
 720
 721        _env.on_app_state_initing()
 722
 723        self._asyncio_loop = _asyncio.setup_asyncio()
 724        self.health_monitor = AppHealthMonitor()
 725
 726        # __FEATURESET_APP_SUBSYSTEM_CREATE_BEGIN__
 727        # This section generated by batools.appmodule; do not edit.
 728
 729        # Poke these attrs to create all our subsystems.
 730        _ = self.plus
 731        _ = self.classic
 732        _ = self.ui_v1
 733
 734        # __FEATURESET_APP_SUBSYSTEM_CREATE_END__
 735
 736        # We're a pretty short-lived state. This should flip us to
 737        # 'loading'.
 738        self._init_completed = True
 739        self._update_state()
 740
 741    def _on_loading(self) -> None:
 742        """Called when we enter the loading state.
 743
 744        At this point, all built-in pieces of the app should be in place
 745        and can start talking to each other and doing work. Though at a
 746        high level, the goal of the app at this point is only to sign in
 747        to initial accounts, download workspaces, and otherwise prepare
 748        itself to really 'run'.
 749        """
 750        assert _babase.in_logic_thread()
 751
 752        # Get meta-system scanning built-in stuff in the bg.
 753        self.meta.start_scan(scan_complete_cb=self._on_meta_scan_complete)
 754
 755        # Inform all app subsystems in the same order they were inited.
 756        # Operate on a copy here because subsystems can still be added
 757        # at this point.
 758        for subsystem in self._subsystems.copy():
 759            try:
 760                subsystem.on_app_loading()
 761            except Exception:
 762                logging.exception(
 763                    'Error in on_app_loading for subsystem %s.', subsystem
 764                )
 765
 766        # Normally plus tells us when initial sign-in is done. If plus
 767        # is not present, however, we just do it ourself so we can
 768        # proceed on to the running state.
 769        if self.plus is None:
 770            _babase.pushcall(self.on_initial_sign_in_complete)
 771
 772    def _on_meta_scan_complete(self) -> None:
 773        """Called when meta-scan is done doing its thing."""
 774        assert _babase.in_logic_thread()
 775
 776        # Now that we know what's out there, build our final plugin set.
 777        self.plugins.on_meta_scan_complete()
 778
 779        assert not self._meta_scan_completed
 780        self._meta_scan_completed = True
 781        self._update_state()
 782
 783    def _on_running(self) -> None:
 784        """Called when we enter the running state.
 785
 786        At this point, all workspaces, initial accounts, etc. are in place
 787        and we can actually get started doing whatever we're gonna do.
 788        """
 789        assert _babase.in_logic_thread()
 790
 791        # Let our native layer know.
 792        _babase.on_app_running()
 793
 794        # Set a default app-mode-selector if none has been set yet
 795        # by a plugin or whatnot.
 796        if self._mode_selector is None:
 797            self._mode_selector = self.DefaultAppModeSelector()
 798
 799        # Inform all app subsystems in the same order they were
 800        # registered. Operate on a copy here because subsystems can
 801        # still be added at this point.
 802        #
 803        # NOTE: Do we need to allow registering still at this point? If
 804        # something gets registered here, it won't have its
 805        # on_app_running callback called. Hmm; I suppose that's the only
 806        # way that plugins can register subsystems though.
 807        for subsystem in self._subsystems.copy():
 808            try:
 809                subsystem.on_app_running()
 810            except Exception:
 811                logging.exception(
 812                    'Error in on_app_running for subsystem %s.', subsystem
 813                )
 814
 815        # Cut off new subsystem additions at this point.
 816        self._subsystem_registration_ended = True
 817
 818        # If 'exec' code was provided to the app, always kick that off
 819        # here as an intent.
 820        exec_cmd = _babase.exec_arg()
 821        if exec_cmd is not None:
 822            self.set_intent(AppIntentExec(exec_cmd))
 823        elif self._pending_intent is None:
 824            # Otherwise tell the app to do its default thing *only* if a
 825            # plugin hasn't already told it to do something.
 826            self.set_intent(AppIntentDefault())
 827
 828    def _apply_app_config(self) -> None:
 829        assert _babase.in_logic_thread()
 830
 831        _babase.lifecyclelog('apply-app-config')
 832
 833        # If multiple apply calls have been made, only actually apply
 834        # once.
 835        if not self._pending_apply_app_config:
 836            return
 837
 838        _pending_apply_app_config = False
 839
 840        # Inform all app subsystems in the same order they were inited.
 841        # Operate on a copy here because subsystems may still be able to
 842        # be added at this point.
 843        for subsystem in self._subsystems.copy():
 844            try:
 845                subsystem.do_apply_app_config()
 846            except Exception:
 847                logging.exception(
 848                    'Error in do_apply_app_config for subsystem %s.', subsystem
 849                )
 850
 851        # Let the native layer do its thing.
 852        _babase.do_apply_app_config()
 853
 854    def _update_state(self) -> None:
 855        # pylint: disable=too-many-branches
 856        assert _babase.in_logic_thread()
 857
 858        # Shutdown-complete trumps absolutely all.
 859        if self._native_shutdown_complete_called:
 860            if self.state is not self.State.SHUTDOWN_COMPLETE:
 861                self.state = self.State.SHUTDOWN_COMPLETE
 862                _babase.lifecyclelog('app state shutdown complete')
 863                self._on_shutdown_complete()
 864
 865        # Shutdown trumps all. Though we can't start shutting down until
 866        # init is completed since we need our asyncio stuff to exist for
 867        # the shutdown process.
 868        elif self._native_shutdown_called and self._init_completed:
 869            # Entering shutdown state:
 870            if self.state is not self.State.SHUTTING_DOWN:
 871                self.state = self.State.SHUTTING_DOWN
 872                _babase.lifecyclelog('app state shutting down')
 873                self._on_shutting_down()
 874
 875        elif self._native_suspended:
 876            # Entering suspended state:
 877            if self.state is not self.State.SUSPENDED:
 878                self.state = self.State.SUSPENDED
 879                self._on_suspend()
 880        else:
 881            # Leaving suspended state:
 882            if self.state is self.State.SUSPENDED:
 883                self._on_unsuspend()
 884
 885            # Entering or returning to running state
 886            if self._initial_sign_in_completed and self._meta_scan_completed:
 887                if self.state != self.State.RUNNING:
 888                    self.state = self.State.RUNNING
 889                    _babase.lifecyclelog('app state running')
 890                    if not self._called_on_running:
 891                        self._called_on_running = True
 892                        self._on_running()
 893            # Entering or returning to loading state:
 894            elif self._init_completed:
 895                if self.state is not self.State.LOADING:
 896                    self.state = self.State.LOADING
 897                    _babase.lifecyclelog('app state loading')
 898                    if not self._called_on_loading:
 899                        self._called_on_loading = True
 900                        self._on_loading()
 901
 902            # Entering or returning to initing state:
 903            elif self._native_bootstrapping_completed:
 904                if self.state is not self.State.INITING:
 905                    self.state = self.State.INITING
 906                    _babase.lifecyclelog('app state initing')
 907                    if not self._called_on_initing:
 908                        self._called_on_initing = True
 909                        self._on_initing()
 910
 911            # Entering or returning to native bootstrapping:
 912            elif self._native_start_called:
 913                if self.state is not self.State.NATIVE_BOOTSTRAPPING:
 914                    self.state = self.State.NATIVE_BOOTSTRAPPING
 915                    _babase.lifecyclelog('app state native bootstrapping')
 916            else:
 917                # Only logical possibility left is NOT_STARTED, in which
 918                # case we should not be getting called.
 919                logging.warning(
 920                    'App._update_state called while in %s state;'
 921                    ' should not happen.',
 922                    self.state.value,
 923                    stack_info=True,
 924                )
 925
 926    async def _shutdown(self) -> None:
 927        import asyncio
 928
 929        _babase.lock_all_input()
 930        try:
 931            async with asyncio.TaskGroup() as task_group:
 932                for task_coro in self._shutdown_tasks:
 933                    # Note: Mypy currently complains if we don't take
 934                    # this return value, but we don't actually need to.
 935                    # https://github.com/python/mypy/issues/15036
 936                    _ = task_group.create_task(
 937                        self._run_shutdown_task(task_coro)
 938                    )
 939        except* Exception:
 940            logging.exception('Unexpected error(s) in shutdown.')
 941
 942        # Note: ideally we should run this directly here, but currently
 943        # it does some legacy stuff which blocks, so running it here
 944        # gives us asyncio task-took-too-long warnings. If we can
 945        # convert those to nice graceful async tasks we should revert
 946        # this to a direct call.
 947        _babase.pushcall(_babase.complete_shutdown)
 948
 949    async def _run_shutdown_task(
 950        self, coro: Coroutine[None, None, None]
 951    ) -> None:
 952        """Run a shutdown task; report errors and abort if taking too long."""
 953        import asyncio
 954
 955        task = asyncio.create_task(coro)
 956        try:
 957            await asyncio.wait_for(task, self.SHUTDOWN_TASK_TIMEOUT_SECONDS)
 958        except Exception:
 959            logging.exception('Error in shutdown task (%s).', coro)
 960
 961    def _on_suspend(self) -> None:
 962        """Called when the app goes to a suspended state."""
 963        assert _babase.in_logic_thread()
 964
 965        # Suspend all app subsystems in the opposite order they were inited.
 966        for subsystem in reversed(self._subsystems):
 967            try:
 968                subsystem.on_app_suspend()
 969            except Exception:
 970                logging.exception(
 971                    'Error in on_app_suspend for subsystem %s.', subsystem
 972                )
 973
 974    def _on_unsuspend(self) -> None:
 975        """Called when unsuspending."""
 976        assert _babase.in_logic_thread()
 977        self.fg_state += 1
 978
 979        # Unsuspend all app subsystems in the same order they were inited.
 980        for subsystem in self._subsystems:
 981            try:
 982                subsystem.on_app_unsuspend()
 983            except Exception:
 984                logging.exception(
 985                    'Error in on_app_unsuspend for subsystem %s.', subsystem
 986                )
 987
 988    def _on_shutting_down(self) -> None:
 989        """(internal)"""
 990        assert _babase.in_logic_thread()
 991
 992        # Inform app subsystems that we're shutting down in the opposite
 993        # order they were inited.
 994        for subsystem in reversed(self._subsystems):
 995            try:
 996                subsystem.on_app_shutdown()
 997            except Exception:
 998                logging.exception(
 999                    'Error in on_app_shutdown for subsystem %s.', subsystem
1000                )
1001
1002        # Now kick off any async shutdown task(s).
1003        assert self._asyncio_loop is not None
1004        self._shutdown_task = self._asyncio_loop.create_task(self._shutdown())
1005
1006    def _on_shutdown_complete(self) -> None:
1007        """(internal)"""
1008        assert _babase.in_logic_thread()
1009
1010        # Inform app subsystems that we're done shutting down in the opposite
1011        # order they were inited.
1012        for subsystem in reversed(self._subsystems):
1013            try:
1014                subsystem.on_app_shutdown_complete()
1015            except Exception:
1016                logging.exception(
1017                    'Error in on_app_shutdown_complete for subsystem %s.',
1018                    subsystem,
1019                )
1020
1021    async def _wait_for_shutdown_suppressions(self) -> None:
1022        import asyncio
1023
1024        # Spin and wait for anything blocking shutdown to complete.
1025        starttime = _babase.apptime()
1026        _babase.lifecyclelog('shutdown-suppress wait begin')
1027        while _babase.shutdown_suppress_count() > 0:
1028            await asyncio.sleep(0.001)
1029        _babase.lifecyclelog('shutdown-suppress wait end')
1030        duration = _babase.apptime() - starttime
1031        if duration > 1.0:
1032            logging.warning(
1033                'Shutdown-suppressions lasted longer than ideal '
1034                '(%.2f seconds).',
1035                duration,
1036            )
1037
1038    async def _fade_and_shutdown_graphics(self) -> None:
1039        import asyncio
1040
1041        # Kick off a short fade and give it time to complete.
1042        _babase.lifecyclelog('fade-and-shutdown-graphics begin')
1043        _babase.fade_screen(False, time=0.15)
1044        await asyncio.sleep(0.15)
1045
1046        # Now tell the graphics system to go down and wait until
1047        # it has done so.
1048        _babase.graphics_shutdown_begin()
1049        while not _babase.graphics_shutdown_is_complete():
1050            await asyncio.sleep(0.01)
1051        _babase.lifecyclelog('fade-and-shutdown-graphics end')
1052
1053    async def _fade_and_shutdown_audio(self) -> None:
1054        import asyncio
1055
1056        # Tell the audio system to go down and give it a bit of
1057        # time to do so gracefully.
1058        _babase.lifecyclelog('fade-and-shutdown-audio begin')
1059        _babase.audio_shutdown_begin()
1060        await asyncio.sleep(0.15)
1061        while not _babase.audio_shutdown_is_complete():
1062            await asyncio.sleep(0.01)
1063        _babase.lifecyclelog('fade-and-shutdown-audio end')
1064
1065    def _threadpool_no_wait_done(self, fut: Future) -> None:
1066        try:
1067            fut.result()
1068        except Exception:
1069            logging.exception(
1070                'Error in work submitted via threadpool_submit_no_wait()'
1071            )
1072
1073    def _thread_pool_thread_init(self) -> None:
1074        # Help keep things clear in profiling tools/etc.
1075        self._pool_thread_count += 1
1076        _babase.set_thread_name(f'ballistica worker-{self._pool_thread_count}')

A class for high level app functionality and state.

Category: App Classes

Use babase.app to access the single shared instance of this class.

Note that properties not documented here should be considered internal and subject to change without warning.

plugins: PluginSubsystem
health_monitor: AppHealthMonitor
SHUTDOWN_TASK_TIMEOUT_SECONDS = 5
env: Env
state
threadpool
meta
net
workspaces
components
stringedit
devconsole
fg_state
def postinit(self) -> None:
231    def postinit(self) -> None:
232        """Called after we've been inited and assigned to babase.app.
233
234        Anything that accesses babase.app as part of its init process
235        must go here instead of __init__.
236        """
237
238        # Hack for docs-generation: We can be imported with dummy
239        # modules instead of our actual binary ones, but we don't
240        # function.
241        if os.environ.get('BA_RUNNING_WITH_DUMMY_MODULES') == '1':
242            return
243
244        self.lang = LanguageSubsystem()
245        self.plugins = PluginSubsystem()

Called after we've been inited and assigned to babase.app.

Anything that accesses babase.app as part of its init process must go here instead of __init__.

active: bool
247    @property
248    def active(self) -> bool:
249        """Whether the app is currently front and center.
250
251        This will be False when the app is hidden, other activities
252        are covering it, etc. (depending on the platform).
253        """
254        return _babase.app_is_active()

Whether the app is currently front and center.

This will be False when the app is hidden, other activities are covering it, etc. (depending on the platform).

asyncio_loop: asyncio.events.AbstractEventLoop
256    @property
257    def asyncio_loop(self) -> asyncio.AbstractEventLoop:
258        """The logic thread's asyncio event loop.
259
260        This allow async tasks to be run in the logic thread.
261
262        Generally you should call App.create_async_task() to schedule
263        async code to run instead of using this directly. That will
264        handle retaining the task and logging errors automatically.
265        Only schedule tasks onto asyncio_loop yourself when you intend
266        to hold on to the returned task and await its results. Releasing
267        the task reference can lead to subtle bugs such as unreported
268        errors and garbage-collected tasks disappearing before their
269        work is done.
270
271        Note that, at this time, the asyncio loop is encapsulated
272        and explicitly stepped by the engine's logic thread loop and
273        thus things like asyncio.get_running_loop() will unintuitively
274        *not* return this loop from most places in the logic thread;
275        only from within a task explicitly created in this loop.
276        Hopefully this situation will be improved in the future with a
277        unified event loop.
278        """
279        assert _babase.in_logic_thread()
280        assert self._asyncio_loop is not None
281        return self._asyncio_loop

The logic thread's asyncio event loop.

This allow async tasks to be run in the logic thread.

Generally you should call App.create_async_task() to schedule async code to run instead of using this directly. That will handle retaining the task and logging errors automatically. Only schedule tasks onto asyncio_loop yourself when you intend to hold on to the returned task and await its results. Releasing the task reference can lead to subtle bugs such as unreported errors and garbage-collected tasks disappearing before their work is done.

Note that, at this time, the asyncio loop is encapsulated and explicitly stepped by the engine's logic thread loop and thus things like asyncio.get_running_loop() will unintuitively not return this loop from most places in the logic thread; only from within a task explicitly created in this loop. Hopefully this situation will be improved in the future with a unified event loop.

def create_async_task(self, coro: Coroutine[Any, Any, ~T], *, name: str | None = None) -> None:
283    def create_async_task(
284        self, coro: Coroutine[Any, Any, T], *, name: str | None = None
285    ) -> None:
286        """Create a fully managed async task.
287
288        This will automatically retain and release a reference to the task
289        and log any exceptions that occur in it. If you need to await a task
290        or otherwise need more control, schedule a task directly using
291        App.asyncio_loop.
292        """
293        assert _babase.in_logic_thread()
294
295        # Hold a strong reference to the task until it is done.
296        # Otherwise it is possible for it to be garbage collected and
297        # disappear midway if the caller does not hold on to the
298        # returned task, which seems like a great way to introduce
299        # hard-to-track bugs.
300        task = self.asyncio_loop.create_task(coro, name=name)
301        self._asyncio_tasks.add(task)
302        task.add_done_callback(self._on_task_done)

Create a fully managed async task.

This will automatically retain and release a reference to the task and log any exceptions that occur in it. If you need to await a task or otherwise need more control, schedule a task directly using App.asyncio_loop.

config: AppConfig
317    @property
318    def config(self) -> babase.AppConfig:
319        """The babase.AppConfig instance representing the app's config state."""
320        assert self._config is not None
321        return self._config

The babase.AppConfig instance representing the app's config state.

mode_selector: AppModeSelector
323    @property
324    def mode_selector(self) -> babase.AppModeSelector:
325        """Controls which app-modes are used for handling given intents.
326
327        Plugins can override this to change high level app behavior and
328        spinoff projects can change the default implementation for the
329        same effect.
330        """
331        if self._mode_selector is None:
332            raise RuntimeError(
333                'mode_selector cannot be used until the app reaches'
334                ' the running state.'
335            )
336        return self._mode_selector

Controls which app-modes are used for handling given intents.

Plugins can override this to change high level app behavior and spinoff projects can change the default implementation for the same effect.

classic: baclassic._subsystem.ClassicSubsystem | None
392    @property
393    def classic(self) -> ClassicSubsystem | None:
394        """Our classic subsystem (if available)."""
395        return self._get_subsystem_property(
396            'classic', self._create_classic_subsystem
397        )  # type: ignore

Our classic subsystem (if available).

plus: baplus._subsystem.PlusSubsystem | None
412    @property
413    def plus(self) -> PlusSubsystem | None:
414        """Our plus subsystem (if available)."""
415        return self._get_subsystem_property(
416            'plus', self._create_plus_subsystem
417        )  # type: ignore

Our plus subsystem (if available).

ui_v1: bauiv1._subsystem.UIV1Subsystem
432    @property
433    def ui_v1(self) -> UIV1Subsystem:
434        """Our ui_v1 subsystem (always available)."""
435        return self._get_subsystem_property(
436            'ui_v1', self._create_ui_v1_subsystem
437        )  # type: ignore

Our ui_v1 subsystem (always available).

def register_subsystem(self, subsystem: AppSubsystem) -> None:
449    def register_subsystem(self, subsystem: AppSubsystem) -> None:
450        """Called by the AppSubsystem class. Do not use directly."""
451
452        # We only allow registering new subsystems if we've not yet
453        # reached the 'running' state. This ensures that all subsystems
454        # receive a consistent set of callbacks starting with
455        # on_app_running().
456
457        if self._subsystem_registration_ended:
458            raise RuntimeError(
459                'Subsystems can no longer be registered at this point.'
460            )
461        self._subsystems.append(subsystem)

Called by the AppSubsystem class. Do not use directly.

def add_shutdown_task(self, coro: Coroutine[NoneType, NoneType, NoneType]) -> None:
463    def add_shutdown_task(self, coro: Coroutine[None, None, None]) -> None:
464        """Add a task to be run on app shutdown.
465
466        Note that shutdown tasks will be canceled after
467        App.SHUTDOWN_TASK_TIMEOUT_SECONDS if they are still running.
468        """
469        if (
470            self.state is self.State.SHUTTING_DOWN
471            or self.state is self.State.SHUTDOWN_COMPLETE
472        ):
473            stname = self.state.name
474            raise RuntimeError(
475                f'Cannot add shutdown tasks with current state {stname}.'
476            )
477        self._shutdown_tasks.append(coro)

Add a task to be run on app shutdown.

Note that shutdown tasks will be canceled after App.SHUTDOWN_TASK_TIMEOUT_SECONDS if they are still running.

def run(self) -> None:
479    def run(self) -> None:
480        """Run the app to completion.
481
482        Note that this only works on builds where Ballistica manages
483        its own event loop.
484        """
485        _babase.run_app()

Run the app to completion.

Note that this only works on builds where Ballistica manages its own event loop.

def threadpool_submit_no_wait(self, call: Callable[[], Any]) -> None:
487    def threadpool_submit_no_wait(self, call: Callable[[], Any]) -> None:
488        """Submit a call to the app threadpool where result is not needed.
489
490        Normally, doing work in a thread-pool involves creating a future
491        and waiting for its result, which is an important step because it
492        propagates any Exceptions raised by the submitted work. When the
493        result in not important, however, this call can be used. The app
494        will log any exceptions that occur.
495        """
496        fut = self.threadpool.submit(call)
497        fut.add_done_callback(self._threadpool_no_wait_done)

Submit a call to the app threadpool where result is not needed.

Normally, doing work in a thread-pool involves creating a future and waiting for its result, which is an important step because it propagates any Exceptions raised by the submitted work. When the result in not important, however, this call can be used. The app will log any exceptions that occur.

def set_intent(self, intent: AppIntent) -> None:
499    def set_intent(self, intent: AppIntent) -> None:
500        """Set the intent for the app.
501
502        Intent defines what the app is trying to do at a given time.
503        This call is asynchronous; the intent switch will happen in the
504        logic thread in the near future. If set_intent is called
505        repeatedly before the change takes place, the final intent to be
506        set will be used.
507        """
508
509        # Mark this one as pending. We do this synchronously so that the
510        # last one marked actually takes effect if there is overlap
511        # (doing this in the bg thread could result in race conditions).
512        self._pending_intent = intent
513
514        # Do the actual work of calcing our app-mode/etc. in a bg thread
515        # since it may block for a moment to load modules/etc.
516        self.threadpool_submit_no_wait(tpartial(self._set_intent, intent))

Set the intent for the app.

Intent defines what the app is trying to do at a given time. This call is asynchronous; the intent switch will happen in the logic thread in the near future. If set_intent is called repeatedly before the change takes place, the final intent to be set will be used.

def push_apply_app_config(self) -> None:
518    def push_apply_app_config(self) -> None:
519        """Internal. Use app.config.apply() to apply app config changes."""
520        # To be safe, let's run this by itself in the event loop.
521        # This avoids potential trouble if this gets called mid-draw or
522        # something like that.
523        self._pending_apply_app_config = True
524        _babase.pushcall(self._apply_app_config, raw=True)

Internal. Use app.config.apply() to apply app config changes.

def on_native_start(self) -> None:
526    def on_native_start(self) -> None:
527        """Called by the native layer when the app is being started."""
528        assert _babase.in_logic_thread()
529        assert not self._native_start_called
530        self._native_start_called = True
531        self._update_state()

Called by the native layer when the app is being started.

def on_native_bootstrapping_complete(self) -> None:
533    def on_native_bootstrapping_complete(self) -> None:
534        """Called by the native layer once its ready to rock."""
535        assert _babase.in_logic_thread()
536        assert not self._native_bootstrapping_completed
537        self._native_bootstrapping_completed = True
538        self._update_state()

Called by the native layer once its ready to rock.

def on_native_suspend(self) -> None:
540    def on_native_suspend(self) -> None:
541        """Called by the native layer when the app is suspended."""
542        assert _babase.in_logic_thread()
543        assert not self._native_suspended  # Should avoid redundant calls.
544        self._native_suspended = True
545        self._update_state()

Called by the native layer when the app is suspended.

def on_native_unsuspend(self) -> None:
547    def on_native_unsuspend(self) -> None:
548        """Called by the native layer when the app suspension ends."""
549        assert _babase.in_logic_thread()
550        assert self._native_suspended  # Should avoid redundant calls.
551        self._native_suspended = False
552        self._update_state()

Called by the native layer when the app suspension ends.

def on_native_shutdown(self) -> None:
554    def on_native_shutdown(self) -> None:
555        """Called by the native layer when the app starts shutting down."""
556        assert _babase.in_logic_thread()
557        self._native_shutdown_called = True
558        self._update_state()

Called by the native layer when the app starts shutting down.

def on_native_shutdown_complete(self) -> None:
560    def on_native_shutdown_complete(self) -> None:
561        """Called by the native layer when the app is done shutting down."""
562        assert _babase.in_logic_thread()
563        self._native_shutdown_complete_called = True
564        self._update_state()

Called by the native layer when the app is done shutting down.

def on_native_active_changed(self) -> None:
566    def on_native_active_changed(self) -> None:
567        """Called by the native layer when the app active state changes."""
568        assert _babase.in_logic_thread()
569        if self._mode is not None:
570            self._mode.on_app_active_changed()

Called by the native layer when the app active state changes.

def on_initial_sign_in_complete(self) -> None:
598    def on_initial_sign_in_complete(self) -> None:
599        """Called when initial sign-in (or lack thereof) completes.
600
601        This normally gets called by the plus subsystem. The
602        initial-sign-in process may include tasks such as syncing
603        account workspaces or other data so it may take a substantial
604        amount of time.
605        """
606        assert _babase.in_logic_thread()
607        assert not self._initial_sign_in_completed
608
609        # Tell meta it can start scanning extra stuff that just showed
610        # up (namely account workspaces).
611        self.meta.start_extra_scan()
612
613        self._initial_sign_in_completed = True
614        self._update_state()

Called when initial sign-in (or lack thereof) completes.

This normally gets called by the plus subsystem. The initial-sign-in process may include tasks such as syncing account workspaces or other data so it may take a substantial amount of time.

class App.State(enum.Enum):
 75    class State(Enum):
 76        """High level state the app can be in."""
 77
 78        # The app has not yet begun starting and should not be used in
 79        # any way.
 80        NOT_STARTED = 0
 81
 82        # The native layer is spinning up its machinery (screens,
 83        # renderers, etc.). Nothing should happen in the Python layer
 84        # until this completes.
 85        NATIVE_BOOTSTRAPPING = 1
 86
 87        # Python app subsystems are being inited but should not yet
 88        # interact or do any work.
 89        INITING = 2
 90
 91        # Python app subsystems are inited and interacting, but the app
 92        # has not yet embarked on a high level course of action. It is
 93        # doing initial account logins, workspace & asset downloads,
 94        # etc.
 95        LOADING = 3
 96
 97        # All pieces are in place and the app is now doing its thing.
 98        RUNNING = 4
 99
100        # Used on platforms such as mobile where the app basically needs
101        # to shut down while backgrounded. In this state, all event
102        # loops are suspended and all graphics and audio must cease
103        # completely. Be aware that the suspended state can be entered
104        # from any other state including NATIVE_BOOTSTRAPPING and
105        # SHUTTING_DOWN.
106        SUSPENDED = 5
107
108        # The app is shutting down. This process may involve sending
109        # network messages or other things that can take up to a few
110        # seconds, so ideally graphics and audio should remain
111        # functional (with fades or spinners or whatever to show
112        # something is happening).
113        SHUTTING_DOWN = 6
114
115        # The app has completed shutdown. Any code running here should
116        # be basically immediate.
117        SHUTDOWN_COMPLETE = 7

High level state the app can be in.

NOT_STARTED = <State.NOT_STARTED: 0>
NATIVE_BOOTSTRAPPING = <State.NATIVE_BOOTSTRAPPING: 1>
INITING = <State.INITING: 2>
LOADING = <State.LOADING: 3>
RUNNING = <State.RUNNING: 4>
SUSPENDED = <State.SUSPENDED: 5>
SHUTTING_DOWN = <State.SHUTTING_DOWN: 6>
SHUTDOWN_COMPLETE = <State.SHUTDOWN_COMPLETE: 7>
Inherited Members
enum.Enum
name
value
class App.DefaultAppModeSelector(babase.AppModeSelector):
119    class DefaultAppModeSelector(AppModeSelector):
120        """Decides which AppModes to use to handle AppIntents.
121
122        This default version is generated by the project updater based
123        on the 'default_app_modes' value in the projectconfig.
124
125        It is also possible to modify app mode selection behavior by
126        setting app.mode_selector to an instance of a custom
127        AppModeSelector subclass. This is a good way to go if you are
128        modifying app behavior dynamically via a plugin instead of
129        statically in a spinoff project.
130        """
131
132        @override
133        def app_mode_for_intent(
134            self, intent: AppIntent
135        ) -> type[AppMode] | None:
136            # pylint: disable=cyclic-import
137
138            # __DEFAULT_APP_MODE_SELECTION_BEGIN__
139            # This section generated by batools.appmodule; do not edit.
140
141            # Ask our default app modes to handle it.
142            # (generated from 'default_app_modes' in projectconfig).
143            import bascenev1
144            import babase
145
146            for appmode in [
147                bascenev1.SceneV1AppMode,
148                babase.EmptyAppMode,
149            ]:
150                if appmode.can_handle_intent(intent):
151                    return appmode
152
153            return None
154
155            # __DEFAULT_APP_MODE_SELECTION_END__

Decides which AppModes to use to handle AppIntents.

This default version is generated by the project updater based on the 'default_app_modes' value in the projectconfig.

It is also possible to modify app mode selection behavior by setting app.mode_selector to an instance of a custom AppModeSelector subclass. This is a good way to go if you are modifying app behavior dynamically via a plugin instead of statically in a spinoff project.

@override
def app_mode_for_intent( self, intent: AppIntent) -> type[AppMode] | None:
132        @override
133        def app_mode_for_intent(
134            self, intent: AppIntent
135        ) -> type[AppMode] | None:
136            # pylint: disable=cyclic-import
137
138            # __DEFAULT_APP_MODE_SELECTION_BEGIN__
139            # This section generated by batools.appmodule; do not edit.
140
141            # Ask our default app modes to handle it.
142            # (generated from 'default_app_modes' in projectconfig).
143            import bascenev1
144            import babase
145
146            for appmode in [
147                bascenev1.SceneV1AppMode,
148                babase.EmptyAppMode,
149            ]:
150                if appmode.can_handle_intent(intent):
151                    return appmode
152
153            return None
154
155            # __DEFAULT_APP_MODE_SELECTION_END__

Given an AppIntent, return the AppMode that should handle it.

If None is returned, the AppIntent will be ignored.

This may be called in a background thread, so avoid any calls limited to logic thread use/etc.

class AppConfig(builtins.dict):
 18class AppConfig(dict):
 19    """A special dict that holds the game's persistent configuration values.
 20
 21    Category: **App Classes**
 22
 23    It also provides methods for fetching values with app-defined fallback
 24    defaults, applying contained values to the game, and committing the
 25    config to storage.
 26
 27    Call babase.appconfig() to get the single shared instance of this class.
 28
 29    AppConfig data is stored as json on disk on so make sure to only place
 30    json-friendly values in it (dict, list, str, float, int, bool).
 31    Be aware that tuples will be quietly converted to lists when stored.
 32    """
 33
 34    def resolve(self, key: str) -> Any:
 35        """Given a string key, return a config value (type varies).
 36
 37        This will substitute application defaults for values not present in
 38        the config dict, filter some invalid values, etc.  Note that these
 39        values do not represent the state of the app; simply the state of its
 40        config. Use babase.App to access actual live state.
 41
 42        Raises an Exception for unrecognized key names. To get the list of keys
 43        supported by this method, use babase.AppConfig.builtin_keys(). Note
 44        that it is perfectly legal to store other data in the config; it just
 45        needs to be accessed through standard dict methods and missing values
 46        handled manually.
 47        """
 48        return _babase.resolve_appconfig_value(key)
 49
 50    def default_value(self, key: str) -> Any:
 51        """Given a string key, return its predefined default value.
 52
 53        This is the value that will be returned by babase.AppConfig.resolve()
 54        if the key is not present in the config dict or of an incompatible
 55        type.
 56
 57        Raises an Exception for unrecognized key names. To get the list of keys
 58        supported by this method, use babase.AppConfig.builtin_keys(). Note
 59        that it is perfectly legal to store other data in the config; it just
 60        needs to be accessed through standard dict methods and missing values
 61        handled manually.
 62        """
 63        return _babase.get_appconfig_default_value(key)
 64
 65    def builtin_keys(self) -> list[str]:
 66        """Return the list of valid key names recognized by babase.AppConfig.
 67
 68        This set of keys can be used with resolve(), default_value(), etc.
 69        It does not vary across platforms and may include keys that are
 70        obsolete or not relevant on the current running version. (for instance,
 71        VR related keys on non-VR platforms). This is to minimize the amount
 72        of platform checking necessary)
 73
 74        Note that it is perfectly legal to store arbitrary named data in the
 75        config, but in that case it is up to the user to test for the existence
 76        of the key in the config dict, fall back to consistent defaults, etc.
 77        """
 78        return _babase.get_appconfig_builtin_keys()
 79
 80    def apply(self) -> None:
 81        """Apply config values to the running app.
 82
 83        This call is thread-safe and asynchronous; changes will happen
 84        in the next logic event loop cycle.
 85        """
 86        _babase.app.push_apply_app_config()
 87
 88    def commit(self) -> None:
 89        """Commits the config to local storage.
 90
 91        Note that this call is asynchronous so the actual write to disk may not
 92        occur immediately.
 93        """
 94        commit_app_config()
 95
 96    def apply_and_commit(self) -> None:
 97        """Run apply() followed by commit(); for convenience.
 98
 99        (This way the commit() will not occur if apply() hits invalid data)
100        """
101        self.apply()
102        self.commit()

A special dict that holds the game's persistent configuration values.

Category: App Classes

It also provides methods for fetching values with app-defined fallback defaults, applying contained values to the game, and committing the config to storage.

Call babase.appconfig() to get the single shared instance of this class.

AppConfig data is stored as json on disk on so make sure to only place json-friendly values in it (dict, list, str, float, int, bool). Be aware that tuples will be quietly converted to lists when stored.

def resolve(self, key: str) -> Any:
34    def resolve(self, key: str) -> Any:
35        """Given a string key, return a config value (type varies).
36
37        This will substitute application defaults for values not present in
38        the config dict, filter some invalid values, etc.  Note that these
39        values do not represent the state of the app; simply the state of its
40        config. Use babase.App to access actual live state.
41
42        Raises an Exception for unrecognized key names. To get the list of keys
43        supported by this method, use babase.AppConfig.builtin_keys(). Note
44        that it is perfectly legal to store other data in the config; it just
45        needs to be accessed through standard dict methods and missing values
46        handled manually.
47        """
48        return _babase.resolve_appconfig_value(key)

Given a string key, return a config value (type varies).

This will substitute application defaults for values not present in the config dict, filter some invalid values, etc. Note that these values do not represent the state of the app; simply the state of its config. Use babase.App to access actual live state.

Raises an Exception for unrecognized key names. To get the list of keys supported by this method, use babase.AppConfig.builtin_keys(). Note that it is perfectly legal to store other data in the config; it just needs to be accessed through standard dict methods and missing values handled manually.

def default_value(self, key: str) -> Any:
50    def default_value(self, key: str) -> Any:
51        """Given a string key, return its predefined default value.
52
53        This is the value that will be returned by babase.AppConfig.resolve()
54        if the key is not present in the config dict or of an incompatible
55        type.
56
57        Raises an Exception for unrecognized key names. To get the list of keys
58        supported by this method, use babase.AppConfig.builtin_keys(). Note
59        that it is perfectly legal to store other data in the config; it just
60        needs to be accessed through standard dict methods and missing values
61        handled manually.
62        """
63        return _babase.get_appconfig_default_value(key)

Given a string key, return its predefined default value.

This is the value that will be returned by babase.AppConfig.resolve() if the key is not present in the config dict or of an incompatible type.

Raises an Exception for unrecognized key names. To get the list of keys supported by this method, use babase.AppConfig.builtin_keys(). Note that it is perfectly legal to store other data in the config; it just needs to be accessed through standard dict methods and missing values handled manually.

def builtin_keys(self) -> list[str]:
65    def builtin_keys(self) -> list[str]:
66        """Return the list of valid key names recognized by babase.AppConfig.
67
68        This set of keys can be used with resolve(), default_value(), etc.
69        It does not vary across platforms and may include keys that are
70        obsolete or not relevant on the current running version. (for instance,
71        VR related keys on non-VR platforms). This is to minimize the amount
72        of platform checking necessary)
73
74        Note that it is perfectly legal to store arbitrary named data in the
75        config, but in that case it is up to the user to test for the existence
76        of the key in the config dict, fall back to consistent defaults, etc.
77        """
78        return _babase.get_appconfig_builtin_keys()

Return the list of valid key names recognized by babase.AppConfig.

This set of keys can be used with resolve(), default_value(), etc. It does not vary across platforms and may include keys that are obsolete or not relevant on the current running version. (for instance, VR related keys on non-VR platforms). This is to minimize the amount of platform checking necessary)

Note that it is perfectly legal to store arbitrary named data in the config, but in that case it is up to the user to test for the existence of the key in the config dict, fall back to consistent defaults, etc.

def apply(self) -> None:
80    def apply(self) -> None:
81        """Apply config values to the running app.
82
83        This call is thread-safe and asynchronous; changes will happen
84        in the next logic event loop cycle.
85        """
86        _babase.app.push_apply_app_config()

Apply config values to the running app.

This call is thread-safe and asynchronous; changes will happen in the next logic event loop cycle.

def commit(self) -> None:
88    def commit(self) -> None:
89        """Commits the config to local storage.
90
91        Note that this call is asynchronous so the actual write to disk may not
92        occur immediately.
93        """
94        commit_app_config()

Commits the config to local storage.

Note that this call is asynchronous so the actual write to disk may not occur immediately.

def apply_and_commit(self) -> None:
 96    def apply_and_commit(self) -> None:
 97        """Run apply() followed by commit(); for convenience.
 98
 99        (This way the commit() will not occur if apply() hits invalid data)
100        """
101        self.apply()
102        self.commit()

Run apply() followed by commit(); for convenience.

(This way the commit() will not occur if apply() hits invalid data)

Inherited Members
builtins.dict
get
setdefault
pop
popitem
keys
items
values
update
fromkeys
clear
copy
class AppHealthMonitor(babase.AppSubsystem):
379class AppHealthMonitor(AppSubsystem):
380    """Logs things like app-not-responding issues."""
381
382    def __init__(self) -> None:
383        assert _babase.in_logic_thread()
384        super().__init__()
385        self._running = True
386        self._thread = Thread(target=self._app_monitor_thread_main, daemon=True)
387        self._thread.start()
388        self._response = False
389        self._first_check = True
390
391    @override
392    def on_app_loading(self) -> None:
393        # If any traceback dumps happened last run, log and clear them.
394        log_dumped_app_state(from_previous_run=True)
395
396    def _app_monitor_thread_main(self) -> None:
397        _babase.set_thread_name('ballistica app-monitor')
398        try:
399            self._monitor_app()
400        except Exception:
401            logging.exception('Error in AppHealthMonitor thread.')
402
403    def _set_response(self) -> None:
404        assert _babase.in_logic_thread()
405        self._response = True
406
407    def _check_running(self) -> bool:
408        # Workaround for the fact that mypy assumes _running
409        # doesn't change during the course of a function.
410        return self._running
411
412    def _monitor_app(self) -> None:
413        import time
414
415        while bool(True):
416            # Always sleep a bit between checks.
417            time.sleep(1.234)
418
419            # Do nothing while backgrounded.
420            while not self._running:
421                time.sleep(2.3456)
422
423            # Wait for the logic thread to run something we send it.
424            starttime = time.monotonic()
425            self._response = False
426            _babase.pushcall(self._set_response, raw=True)
427            while not self._response:
428                # Abort this check if we went into the background.
429                if not self._check_running():
430                    break
431
432                # Wait a bit longer the first time through since the app
433                # could still be starting up; we generally don't want to
434                # report that.
435                threshold = 10 if self._first_check else 5
436
437                # If we've been waiting too long (and the app is running)
438                # dump the app state and bail. Make an exception for the
439                # first check though since the app could just be taking
440                # a while to get going; we don't want to report that.
441                duration = time.monotonic() - starttime
442                if duration > threshold:
443                    dump_app_state(
444                        reason=f'Logic thread unresponsive'
445                        f' for {threshold} seconds.'
446                    )
447
448                    # We just do one alert for now.
449                    return
450
451                time.sleep(1.042)
452
453            self._first_check = False
454
455    @override
456    def on_app_suspend(self) -> None:
457        assert _babase.in_logic_thread()
458        self._running = False
459
460    @override
461    def on_app_unsuspend(self) -> None:
462        assert _babase.in_logic_thread()
463        self._running = True

Logs things like app-not-responding issues.

@override
def on_app_loading(self) -> None:
391    @override
392    def on_app_loading(self) -> None:
393        # If any traceback dumps happened last run, log and clear them.
394        log_dumped_app_state(from_previous_run=True)

Called when the app reaches the loading state.

Note that subsystems created after the app switches to the loading state will not receive this callback. Subsystems created by plugins are an example of this.

@override
def on_app_suspend(self) -> None:
455    @override
456    def on_app_suspend(self) -> None:
457        assert _babase.in_logic_thread()
458        self._running = False

Called when the app enters the suspended state.

@override
def on_app_unsuspend(self) -> None:
460    @override
461    def on_app_unsuspend(self) -> None:
462        assert _babase.in_logic_thread()
463        self._running = True

Called when the app exits the suspended state.

class AppIntent:
13class AppIntent:
14    """A high level directive given to the app.
15
16    Category: **App Classes**
17    """

A high level directive given to the app.

Category: App Classes

class AppIntentDefault(babase.AppIntent):
20class AppIntentDefault(AppIntent):
21    """Tells the app to simply run in its default mode."""

Tells the app to simply run in its default mode.

class AppIntentExec(babase.AppIntent):
24class AppIntentExec(AppIntent):
25    """Tells the app to exec some Python code."""
26
27    def __init__(self, code: str):
28        self.code = code

Tells the app to exec some Python code.

AppIntentExec(code: str)
27    def __init__(self, code: str):
28        self.code = code
code
class AppMode:
14class AppMode:
15    """A high level mode for the app.
16
17    Category: **App Classes**
18
19    """
20
21    @classmethod
22    def get_app_experience(cls) -> AppExperience:
23        """Return the overall experience provided by this mode."""
24        raise NotImplementedError('AppMode subclasses must override this.')
25
26    @classmethod
27    def can_handle_intent(cls, intent: AppIntent) -> bool:
28        """Return whether this mode can handle the provided intent.
29
30        For this to return True, the AppMode must claim to support the
31        provided intent (via its _supports_intent() method) AND the
32        AppExperience associated with the AppMode must be supported by
33        the current app and runtime environment.
34        """
35        # FIXME: check AppExperience.
36        return cls._supports_intent(intent)
37
38    @classmethod
39    def _supports_intent(cls, intent: AppIntent) -> bool:
40        """Return whether our mode can handle the provided intent.
41
42        AppModes should override this to define what they can handle.
43        Note that AppExperience does not have to be considered here; that
44        is handled automatically by the can_handle_intent() call."""
45        raise NotImplementedError('AppMode subclasses must override this.')
46
47    def handle_intent(self, intent: AppIntent) -> None:
48        """Handle an intent."""
49        raise NotImplementedError('AppMode subclasses must override this.')
50
51    def on_activate(self) -> None:
52        """Called when the mode is being activated."""
53
54    def on_deactivate(self) -> None:
55        """Called when the mode is being deactivated."""
56
57    def on_app_active_changed(self) -> None:
58        """Called when babase.app.active changes.
59
60        The app-mode may want to take action such as pausing a running
61        game in such cases.
62        """

A high level mode for the app.

Category: App Classes

@classmethod
def get_app_experience(cls) -> bacommon.app.AppExperience:
21    @classmethod
22    def get_app_experience(cls) -> AppExperience:
23        """Return the overall experience provided by this mode."""
24        raise NotImplementedError('AppMode subclasses must override this.')

Return the overall experience provided by this mode.

@classmethod
def can_handle_intent(cls, intent: AppIntent) -> bool:
26    @classmethod
27    def can_handle_intent(cls, intent: AppIntent) -> bool:
28        """Return whether this mode can handle the provided intent.
29
30        For this to return True, the AppMode must claim to support the
31        provided intent (via its _supports_intent() method) AND the
32        AppExperience associated with the AppMode must be supported by
33        the current app and runtime environment.
34        """
35        # FIXME: check AppExperience.
36        return cls._supports_intent(intent)

Return whether this mode can handle the provided intent.

For this to return True, the AppMode must claim to support the provided intent (via its _supports_intent() method) AND the AppExperience associated with the AppMode must be supported by the current app and runtime environment.

def handle_intent(self, intent: AppIntent) -> None:
47    def handle_intent(self, intent: AppIntent) -> None:
48        """Handle an intent."""
49        raise NotImplementedError('AppMode subclasses must override this.')

Handle an intent.

def on_activate(self) -> None:
51    def on_activate(self) -> None:
52        """Called when the mode is being activated."""

Called when the mode is being activated.

def on_deactivate(self) -> None:
54    def on_deactivate(self) -> None:
55        """Called when the mode is being deactivated."""

Called when the mode is being deactivated.

def on_app_active_changed(self) -> None:
57    def on_app_active_changed(self) -> None:
58        """Called when babase.app.active changes.
59
60        The app-mode may want to take action such as pausing a running
61        game in such cases.
62        """

Called when babase.app.active changes.

The app-mode may want to take action such as pausing a running game in such cases.

class AppModeSelector:
14class AppModeSelector:
15    """Defines which AppModes to use to handle given AppIntents.
16
17    Category: **App Classes**
18
19    The app calls an instance of this class when passed an AppIntent to
20    determine which AppMode to use to handle the intent. Plugins or
21    spinoff projects can modify high level app behavior by replacing or
22    modifying the app's mode-selector.
23    """
24
25    def app_mode_for_intent(self, intent: AppIntent) -> type[AppMode] | None:
26        """Given an AppIntent, return the AppMode that should handle it.
27
28        If None is returned, the AppIntent will be ignored.
29
30        This may be called in a background thread, so avoid any calls
31        limited to logic thread use/etc.
32        """
33        raise NotImplementedError('app_mode_for_intent() should be overridden.')

Defines which AppModes to use to handle given AppIntents.

Category: App Classes

The app calls an instance of this class when passed an AppIntent to determine which AppMode to use to handle the intent. Plugins or spinoff projects can modify high level app behavior by replacing or modifying the app's mode-selector.

def app_mode_for_intent( self, intent: AppIntent) -> type[AppMode] | None:
25    def app_mode_for_intent(self, intent: AppIntent) -> type[AppMode] | None:
26        """Given an AppIntent, return the AppMode that should handle it.
27
28        If None is returned, the AppIntent will be ignored.
29
30        This may be called in a background thread, so avoid any calls
31        limited to logic thread use/etc.
32        """
33        raise NotImplementedError('app_mode_for_intent() should be overridden.')

Given an AppIntent, return the AppMode that should handle it.

If None is returned, the AppIntent will be ignored.

This may be called in a background thread, so avoid any calls limited to logic thread use/etc.

class AppSubsystem:
15class AppSubsystem:
16    """Base class for an app subsystem.
17
18    Category: **App Classes**
19
20    An app 'subsystem' is a bit of a vague term, as pieces of the app
21    can technically be any class and are not required to use this, but
22    building one out of this base class provides conveniences such as
23    predefined callbacks during app state changes.
24
25    Subsystems must be registered with the app before it completes its
26    transition to the 'running' state.
27    """
28
29    def __init__(self) -> None:
30        _babase.app.register_subsystem(self)
31
32    def on_app_loading(self) -> None:
33        """Called when the app reaches the loading state.
34
35        Note that subsystems created after the app switches to the
36        loading state will not receive this callback. Subsystems created
37        by plugins are an example of this.
38        """
39
40    def on_app_running(self) -> None:
41        """Called when the app reaches the running state."""
42
43    def on_app_suspend(self) -> None:
44        """Called when the app enters the suspended state."""
45
46    def on_app_unsuspend(self) -> None:
47        """Called when the app exits the suspended state."""
48
49    def on_app_shutdown(self) -> None:
50        """Called when the app begins shutting down."""
51
52    def on_app_shutdown_complete(self) -> None:
53        """Called when the app completes shutting down."""
54
55    def do_apply_app_config(self) -> None:
56        """Called when the app config should be applied."""

Base class for an app subsystem.

Category: App Classes

An app 'subsystem' is a bit of a vague term, as pieces of the app can technically be any class and are not required to use this, but building one out of this base class provides conveniences such as predefined callbacks during app state changes.

Subsystems must be registered with the app before it completes its transition to the 'running' state.

def on_app_loading(self) -> None:
32    def on_app_loading(self) -> None:
33        """Called when the app reaches the loading state.
34
35        Note that subsystems created after the app switches to the
36        loading state will not receive this callback. Subsystems created
37        by plugins are an example of this.
38        """

Called when the app reaches the loading state.

Note that subsystems created after the app switches to the loading state will not receive this callback. Subsystems created by plugins are an example of this.

def on_app_running(self) -> None:
40    def on_app_running(self) -> None:
41        """Called when the app reaches the running state."""

Called when the app reaches the running state.

def on_app_suspend(self) -> None:
43    def on_app_suspend(self) -> None:
44        """Called when the app enters the suspended state."""

Called when the app enters the suspended state.

def on_app_unsuspend(self) -> None:
46    def on_app_unsuspend(self) -> None:
47        """Called when the app exits the suspended state."""

Called when the app exits the suspended state.

def on_app_shutdown(self) -> None:
49    def on_app_shutdown(self) -> None:
50        """Called when the app begins shutting down."""

Called when the app begins shutting down.

def on_app_shutdown_complete(self) -> None:
52    def on_app_shutdown_complete(self) -> None:
53        """Called when the app completes shutting down."""

Called when the app completes shutting down.

def do_apply_app_config(self) -> None:
55    def do_apply_app_config(self) -> None:
56        """Called when the app config should be applied."""

Called when the app config should be applied.

def apptime() -> AppTime:
547def apptime() -> babase.AppTime:
548    """Return the current app-time in seconds.
549
550    Category: **General Utility Functions**
551
552    App-time is a monotonic time value; it starts at 0.0 when the app
553    launches and will never jump by large amounts or go backwards, even if
554    the system time changes. Its progression will pause when the app is in
555    a suspended state.
556
557    Note that the AppTime returned here is simply float; it just has a
558    unique type in the type-checker's eyes to help prevent it from being
559    accidentally used with time functionality expecting other time types.
560    """
561    import babase  # pylint: disable=cyclic-import
562
563    return babase.AppTime(0.0)

Return the current app-time in seconds.

Category: General Utility Functions

App-time is a monotonic time value; it starts at 0.0 when the app launches and will never jump by large amounts or go backwards, even if the system time changes. Its progression will pause when the app is in a suspended state.

Note that the AppTime returned here is simply float; it just has a unique type in the type-checker's eyes to help prevent it from being accidentally used with time functionality expecting other time types.

AppTime = AppTime
def apptimer(time: float, call: Callable[[], Any]) -> None:
566def apptimer(time: float, call: Callable[[], Any]) -> None:
567    """Schedule a callable object to run based on app-time.
568
569    Category: **General Utility Functions**
570
571    This function creates a one-off timer which cannot be canceled or
572    modified once created. If you require the ability to do so, or need
573    a repeating timer, use the babase.AppTimer class instead.
574
575    ##### Arguments
576    ###### time (float)
577    > Length of time in seconds that the timer will wait before firing.
578
579    ###### call (Callable[[], Any])
580    > A callable Python object. Note that the timer will retain a
581    strong reference to the callable for as long as the timer exists, so you
582    may want to look into concepts such as babase.WeakCall if that is not
583    desired.
584
585    ##### Examples
586    Print some stuff through time:
587    >>> babase.screenmessage('hello from now!')
588    >>> babase.apptimer(1.0, babase.Call(babase.screenmessage,
589                              'hello from the future!'))
590    >>> babase.apptimer(2.0, babase.Call(babase.screenmessage,
591    ...                       'hello from the future 2!'))
592    """
593    return None

Schedule a callable object to run based on app-time.

Category: General Utility Functions

This function creates a one-off timer which cannot be canceled or modified once created. If you require the ability to do so, or need a repeating timer, use the babase.AppTimer class instead.

Arguments
time (float)

Length of time in seconds that the timer will wait before firing.

call (Callable[[], Any])

A callable Python object. Note that the timer will retain a strong reference to the callable for as long as the timer exists, so you may want to look into concepts such as babase.WeakCall if that is not desired.

Examples

Print some stuff through time:

>>> babase.screenmessage('hello from now!')
>>> babase.apptimer(1.0, babase.Call(babase.screenmessage,
                          'hello from the future!'))
>>> babase.apptimer(2.0, babase.Call(babase.screenmessage,
...                       'hello from the future 2!'))
class AppTimer:
53class AppTimer:
54    """Timers are used to run code at later points in time.
55
56    Category: **General Utility Classes**
57
58    This class encapsulates a timer based on app-time.
59    The underlying timer will be destroyed when this object is no longer
60    referenced. If you do not want to worry about keeping a reference to
61    your timer around, use the babase.apptimer() function instead to get a
62    one-off timer.
63
64    ##### Arguments
65    ###### time
66    > Length of time in seconds that the timer will wait before firing.
67
68    ###### call
69    > A callable Python object. Remember that the timer will retain a
70    strong reference to the callable for as long as it exists, so you
71    may want to look into concepts such as babase.WeakCall if that is not
72    desired.
73
74    ###### repeat
75    > If True, the timer will fire repeatedly, with each successive
76    firing having the same delay as the first.
77
78    ##### Example
79
80    Use a Timer object to print repeatedly for a few seconds:
81    ... def say_it():
82    ...     babase.screenmessage('BADGER!')
83    ... def stop_saying_it():
84    ...     global g_timer
85    ...     g_timer = None
86    ...     babase.screenmessage('MUSHROOM MUSHROOM!')
87    ... # Create our timer; it will run as long as we have the self.t ref.
88    ... g_timer = babase.AppTimer(0.3, say_it, repeat=True)
89    ... # Now fire off a one-shot timer to kill it.
90    ... babase.apptimer(3.89, stop_saying_it)
91    """
92
93    def __init__(
94        self, time: float, call: Callable[[], Any], repeat: bool = False
95    ) -> None:
96        pass

Timers are used to run code at later points in time.

Category: General Utility Classes

This class encapsulates a timer based on app-time. The underlying timer will be destroyed when this object is no longer referenced. If you do not want to worry about keeping a reference to your timer around, use the babase.apptimer() function instead to get a one-off timer.

Arguments
time

Length of time in seconds that the timer will wait before firing.

call

A callable Python object. Remember that the timer will retain a strong reference to the callable for as long as it exists, so you may want to look into concepts such as babase.WeakCall if that is not desired.

repeat

If True, the timer will fire repeatedly, with each successive firing having the same delay as the first.

Example

Use a Timer object to print repeatedly for a few seconds: ... def say_it(): ... babase.screenmessage('BADGER!') ... def stop_saying_it(): ... global g_timer ... g_timer = None ... babase.screenmessage('MUSHROOM MUSHROOM!') ... # Create our timer; it will run as long as we have the self.t ref. ... g_timer = babase.AppTimer(0.3, say_it, repeat=True) ... # Now fire off a one-shot timer to kill it. ... babase.apptimer(3.89, stop_saying_it)

AppTimer(time: float, call: Callable[[], Any], repeat: bool = False)
93    def __init__(
94        self, time: float, call: Callable[[], Any], repeat: bool = False
95    ) -> None:
96        pass
Call = <class 'babase._general._Call'>
def charstr(char_id: SpecialChar) -> str:
616def charstr(char_id: babase.SpecialChar) -> str:
617    """Get a unicode string representing a special character.
618
619    Category: **General Utility Functions**
620
621    Note that these utilize the private-use block of unicode characters
622    (U+E000-U+F8FF) and are specific to the game; exporting or rendering
623    them elsewhere will be meaningless.
624
625    See babase.SpecialChar for the list of available characters.
626    """
627    return str()

Get a unicode string representing a special character.

Category: General Utility Functions

Note that these utilize the private-use block of unicode characters (U+E000-U+F8FF) and are specific to the game; exporting or rendering them elsewhere will be meaningless.

See babase.SpecialChar for the list of available characters.

def clipboard_get_text() -> str:
630def clipboard_get_text() -> str:
631    """Return text currently on the system clipboard.
632
633    Category: **General Utility Functions**
634
635    Ensure that babase.clipboard_has_text() returns True before calling
636     this function.
637    """
638    return str()

Return text currently on the system clipboard.

Category: General Utility Functions

Ensure that babase.clipboard_has_text() returns True before calling this function.

def clipboard_has_text() -> bool:
641def clipboard_has_text() -> bool:
642    """Return whether there is currently text on the clipboard.
643
644    Category: **General Utility Functions**
645
646    This will return False if no system clipboard is available; no need
647     to call babase.clipboard_is_supported() separately.
648    """
649    return bool()

Return whether there is currently text on the clipboard.

Category: General Utility Functions

This will return False if no system clipboard is available; no need to call babase.clipboard_is_supported() separately.

def clipboard_is_supported() -> bool:
652def clipboard_is_supported() -> bool:
653    """Return whether this platform supports clipboard operations at all.
654
655    Category: **General Utility Functions**
656
657    If this returns False, UIs should not show 'copy to clipboard'
658    buttons, etc.
659    """
660    return bool()

Return whether this platform supports clipboard operations at all.

Category: General Utility Functions

If this returns False, UIs should not show 'copy to clipboard' buttons, etc.

def clipboard_set_text(value: str) -> None:
663def clipboard_set_text(value: str) -> None:
664    """Copy a string to the system clipboard.
665
666    Category: **General Utility Functions**
667
668    Ensure that babase.clipboard_is_supported() returns True before adding
669     buttons/etc. that make use of this functionality.
670    """
671    return None

Copy a string to the system clipboard.

Category: General Utility Functions

Ensure that babase.clipboard_is_supported() returns True before adding buttons/etc. that make use of this functionality.

class ContextCall:
 99class ContextCall:
100    """A context-preserving callable.
101
102    Category: **General Utility Classes**
103
104    A ContextCall wraps a callable object along with a reference
105    to the current context (see babase.ContextRef); it handles restoring
106    the context when run and automatically clears itself if the context
107    it belongs to dies.
108
109    Generally you should not need to use this directly; all standard
110    Ballistica callbacks involved with timers, materials, UI functions,
111    etc. handle this under-the-hood so you don't have to worry about it.
112    The only time it may be necessary is if you are implementing your
113    own callbacks, such as a worker thread that does some action and then
114    runs some game code when done. By wrapping said callback in one of
115    these, you can ensure that you will not inadvertently be keeping the
116    current activity alive or running code in a torn-down (expired)
117    context_ref.
118
119    You can also use babase.WeakCall for similar functionality, but
120    ContextCall has the added bonus that it will not run during context_ref
121    shutdown, whereas babase.WeakCall simply looks at whether the target
122    object instance still exists.
123
124    ##### Examples
125    **Example A:** code like this can inadvertently prevent our activity
126    (self) from ending until the operation completes, since the bound
127    method we're passing (self.dosomething) contains a strong-reference
128    to self).
129    >>> start_some_long_action(callback_when_done=self.dosomething)
130
131    **Example B:** in this case our activity (self) can still die
132    properly; the callback will clear itself when the activity starts
133    shutting down, becoming a harmless no-op and releasing the reference
134    to our activity.
135
136    >>> start_long_action(
137    ...     callback_when_done=babase.ContextCall(self.mycallback))
138    """
139
140    def __init__(self, call: Callable) -> None:
141        pass
142
143    def __call__(self) -> None:
144        """Support for calling."""
145        pass

A context-preserving callable.

Category: General Utility Classes

A ContextCall wraps a callable object along with a reference to the current context (see babase.ContextRef); it handles restoring the context when run and automatically clears itself if the context it belongs to dies.

Generally you should not need to use this directly; all standard Ballistica callbacks involved with timers, materials, UI functions, etc. handle this under-the-hood so you don't have to worry about it. The only time it may be necessary is if you are implementing your own callbacks, such as a worker thread that does some action and then runs some game code when done. By wrapping said callback in one of these, you can ensure that you will not inadvertently be keeping the current activity alive or running code in a torn-down (expired) context_ref.

You can also use babase.WeakCall for similar functionality, but ContextCall has the added bonus that it will not run during context_ref shutdown, whereas babase.WeakCall simply looks at whether the target object instance still exists.

Examples

Example A: code like this can inadvertently prevent our activity (self) from ending until the operation completes, since the bound method we're passing (self.dosomething) contains a strong-reference to self).

>>> start_some_long_action(callback_when_done=self.dosomething)

Example B: in this case our activity (self) can still die properly; the callback will clear itself when the activity starts shutting down, becoming a harmless no-op and releasing the reference to our activity.

>>> start_long_action(
...     callback_when_done=babase.ContextCall(self.mycallback))
ContextCall(call: Callable)
140    def __init__(self, call: Callable) -> None:
141        pass
class ContextError(builtins.Exception):
16class ContextError(Exception):
17    """Exception raised when a call is made in an invalid context.
18
19    Category: **Exception Classes**
20
21    Examples of this include calling UI functions within an Activity context
22    or calling scene manipulation functions outside of a game context.
23    """

Exception raised when a call is made in an invalid context.

Category: Exception Classes

Examples of this include calling UI functions within an Activity context or calling scene manipulation functions outside of a game context.

Inherited Members
builtins.Exception
Exception
builtins.BaseException
with_traceback
add_note
args
class ContextRef:
148class ContextRef:
149    """Store or use a ballistica context.
150
151    Category: **General Utility Classes**
152
153    Many operations such as bascenev1.newnode() or bascenev1.gettexture()
154    operate implicitly on a current 'context'. A context is some sort of
155    state that functionality can implicitly use. Context determines, for
156    example, which scene nodes or textures get added to without having to
157    specify it explicitly in the newnode()/gettexture() call. Contexts can
158    also affect object lifecycles; for example a babase.ContextCall will
159    become a no-op when the context it was created in is destroyed.
160
161    In general, if you are a modder, you should not need to worry about
162    contexts; mod code should mostly be getting run in the correct
163    context and timers and other callbacks will take care of saving
164    and restoring contexts automatically. There may be rare cases,
165    however, where you need to deal directly with contexts, and that is
166    where this class comes in.
167
168    Creating a babase.ContextRef() will capture a reference to the current
169    context. Other modules may provide ways to access their contexts; for
170    example a bascenev1.Activity instance has a 'context' attribute. You
171    can also use babase.ContextRef.empty() to create a reference to *no*
172    context. Some code such as UI calls may expect this and may complain
173    if you try to use them within a context.
174
175    ##### Usage
176    ContextRefs are generally used with the Python 'with' statement, which
177    sets the context they point to as current on entry and resets it to
178    the previous value on exit.
179
180    ##### Example
181    Explicitly create a few UI bits with no context set.
182    (UI stuff may complain if called within a context):
183    >>> with bui.ContextRef.empty():
184    ...     my_container = bui.containerwidget()
185    """
186
187    def __init__(
188        self,
189    ) -> None:
190        pass
191
192    def __enter__(self) -> None:
193        """Support for "with" statement."""
194        pass
195
196    def __exit__(self, exc_type: Any, exc_value: Any, traceback: Any) -> Any:
197        """Support for "with" statement."""
198        pass
199
200    @classmethod
201    def empty(cls) -> ContextRef:
202        """Return a ContextRef pointing to no context.
203
204        This is useful when code should be run free of a context.
205        For example, UI code generally insists on being run this way.
206        Otherwise, callbacks set on the UI could inadvertently stop working
207        due to a game activity ending, which would be unintuitive behavior.
208        """
209        return ContextRef()
210
211    def is_empty(self) -> bool:
212        """Whether the context was created as empty."""
213        return bool()
214
215    def is_expired(self) -> bool:
216        """Whether the context has expired."""
217        return bool()

Store or use a ballistica context.

Category: General Utility Classes

Many operations such as bascenev1.newnode() or bascenev1.gettexture() operate implicitly on a current 'context'. A context is some sort of state that functionality can implicitly use. Context determines, for example, which scene nodes or textures get added to without having to specify it explicitly in the newnode()/gettexture() call. Contexts can also affect object lifecycles; for example a babase.ContextCall will become a no-op when the context it was created in is destroyed.

In general, if you are a modder, you should not need to worry about contexts; mod code should mostly be getting run in the correct context and timers and other callbacks will take care of saving and restoring contexts automatically. There may be rare cases, however, where you need to deal directly with contexts, and that is where this class comes in.

Creating a babase.ContextRef() will capture a reference to the current context. Other modules may provide ways to access their contexts; for example a bascenev1.Activity instance has a 'context' attribute. You can also use babase.ContextRef.empty() to create a reference to no context. Some code such as UI calls may expect this and may complain if you try to use them within a context.

Usage

ContextRefs are generally used with the Python 'with' statement, which sets the context they point to as current on entry and resets it to the previous value on exit.

Example

Explicitly create a few UI bits with no context set. (UI stuff may complain if called within a context):

>>> with bui.ContextRef.empty():
...     my_container = bui.containerwidget()
@classmethod
def empty(cls) -> ContextRef:
200    @classmethod
201    def empty(cls) -> ContextRef:
202        """Return a ContextRef pointing to no context.
203
204        This is useful when code should be run free of a context.
205        For example, UI code generally insists on being run this way.
206        Otherwise, callbacks set on the UI could inadvertently stop working
207        due to a game activity ending, which would be unintuitive behavior.
208        """
209        return ContextRef()

Return a ContextRef pointing to no context.

This is useful when code should be run free of a context. For example, UI code generally insists on being run this way. Otherwise, callbacks set on the UI could inadvertently stop working due to a game activity ending, which would be unintuitive behavior.

def is_empty(self) -> bool:
211    def is_empty(self) -> bool:
212        """Whether the context was created as empty."""
213        return bool()

Whether the context was created as empty.

def is_expired(self) -> bool:
215    def is_expired(self) -> bool:
216        """Whether the context has expired."""
217        return bool()

Whether the context has expired.

class DelegateNotFoundError(babase.NotFoundError):
61class DelegateNotFoundError(NotFoundError):
62    """Exception raised when an expected delegate object does not exist.
63
64    Category: **Exception Classes**
65    """

Exception raised when an expected delegate object does not exist.

Category: Exception Classes

Inherited Members
builtins.Exception
Exception
builtins.BaseException
with_traceback
add_note
args
class DevConsoleTab:
18class DevConsoleTab:
19    """Defines behavior for a tab in the dev-console."""
20
21    def refresh(self) -> None:
22        """Called when the tab should refresh itself."""
23
24    def request_refresh(self) -> None:
25        """The tab can call this to request that it be refreshed."""
26        _babase.dev_console_request_refresh()
27
28    def button(
29        self,
30        label: str,
31        pos: tuple[float, float],
32        size: tuple[float, float],
33        call: Callable[[], Any] | None = None,
34        h_anchor: Literal['left', 'center', 'right'] = 'center',
35        label_scale: float = 1.0,
36        corner_radius: float = 8.0,
37        style: Literal['normal', 'dark'] = 'normal',
38    ) -> None:
39        """Add a button to the tab being refreshed."""
40        assert _babase.app.devconsole.is_refreshing
41        _babase.dev_console_add_button(
42            label,
43            pos[0],
44            pos[1],
45            size[0],
46            size[1],
47            call,
48            h_anchor,
49            label_scale,
50            corner_radius,
51            style,
52        )
53
54    def text(
55        self,
56        text: str,
57        pos: tuple[float, float],
58        h_anchor: Literal['left', 'center', 'right'] = 'center',
59        h_align: Literal['left', 'center', 'right'] = 'center',
60        v_align: Literal['top', 'center', 'bottom', 'none'] = 'center',
61        scale: float = 1.0,
62    ) -> None:
63        """Add a button to the tab being refreshed."""
64        assert _babase.app.devconsole.is_refreshing
65        _babase.dev_console_add_text(
66            text, pos[0], pos[1], h_anchor, h_align, v_align, scale
67        )
68
69    def python_terminal(self) -> None:
70        """Add a Python Terminal to the tab being refreshed."""
71        assert _babase.app.devconsole.is_refreshing
72        _babase.dev_console_add_python_terminal()
73
74    @property
75    def width(self) -> float:
76        """Return the current tab width. Only call during refreshes."""
77        assert _babase.app.devconsole.is_refreshing
78        return _babase.dev_console_tab_width()
79
80    @property
81    def height(self) -> float:
82        """Return the current tab height. Only call during refreshes."""
83        assert _babase.app.devconsole.is_refreshing
84        return _babase.dev_console_tab_height()
85
86    @property
87    def base_scale(self) -> float:
88        """A scale value set depending on the app's UI scale.
89
90        Dev-console tabs can incorporate this into their UI sizes and
91        positions if they desire. This must be done manually however.
92        """
93        assert _babase.app.devconsole.is_refreshing
94        return _babase.dev_console_base_scale()

Defines behavior for a tab in the dev-console.

def refresh(self) -> None:
21    def refresh(self) -> None:
22        """Called when the tab should refresh itself."""

Called when the tab should refresh itself.

def request_refresh(self) -> None:
24    def request_refresh(self) -> None:
25        """The tab can call this to request that it be refreshed."""
26        _babase.dev_console_request_refresh()

The tab can call this to request that it be refreshed.

def button( self, label: str, pos: tuple[float, float], size: tuple[float, float], call: Optional[Callable[[], Any]] = None, h_anchor: Literal['left', 'center', 'right'] = 'center', label_scale: float = 1.0, corner_radius: float = 8.0, style: Literal['normal', 'dark'] = 'normal') -> None:
28    def button(
29        self,
30        label: str,
31        pos: tuple[float, float],
32        size: tuple[float, float],
33        call: Callable[[], Any] | None = None,
34        h_anchor: Literal['left', 'center', 'right'] = 'center',
35        label_scale: float = 1.0,
36        corner_radius: float = 8.0,
37        style: Literal['normal', 'dark'] = 'normal',
38    ) -> None:
39        """Add a button to the tab being refreshed."""
40        assert _babase.app.devconsole.is_refreshing
41        _babase.dev_console_add_button(
42            label,
43            pos[0],
44            pos[1],
45            size[0],
46            size[1],
47            call,
48            h_anchor,
49            label_scale,
50            corner_radius,
51            style,
52        )

Add a button to the tab being refreshed.

def text( self, text: str, pos: tuple[float, float], h_anchor: Literal['left', 'center', 'right'] = 'center', h_align: Literal['left', 'center', 'right'] = 'center', v_align: Literal['top', 'center', 'bottom', 'none'] = 'center', scale: float = 1.0) -> None:
54    def text(
55        self,
56        text: str,
57        pos: tuple[float, float],
58        h_anchor: Literal['left', 'center', 'right'] = 'center',
59        h_align: Literal['left', 'center', 'right'] = 'center',
60        v_align: Literal['top', 'center', 'bottom', 'none'] = 'center',
61        scale: float = 1.0,
62    ) -> None:
63        """Add a button to the tab being refreshed."""
64        assert _babase.app.devconsole.is_refreshing
65        _babase.dev_console_add_text(
66            text, pos[0], pos[1], h_anchor, h_align, v_align, scale
67        )

Add a button to the tab being refreshed.

def python_terminal(self) -> None:
69    def python_terminal(self) -> None:
70        """Add a Python Terminal to the tab being refreshed."""
71        assert _babase.app.devconsole.is_refreshing
72        _babase.dev_console_add_python_terminal()

Add a Python Terminal to the tab being refreshed.

width: float
74    @property
75    def width(self) -> float:
76        """Return the current tab width. Only call during refreshes."""
77        assert _babase.app.devconsole.is_refreshing
78        return _babase.dev_console_tab_width()

Return the current tab width. Only call during refreshes.

height: float
80    @property
81    def height(self) -> float:
82        """Return the current tab height. Only call during refreshes."""
83        assert _babase.app.devconsole.is_refreshing
84        return _babase.dev_console_tab_height()

Return the current tab height. Only call during refreshes.

base_scale: float
86    @property
87    def base_scale(self) -> float:
88        """A scale value set depending on the app's UI scale.
89
90        Dev-console tabs can incorporate this into their UI sizes and
91        positions if they desire. This must be done manually however.
92        """
93        assert _babase.app.devconsole.is_refreshing
94        return _babase.dev_console_base_scale()

A scale value set depending on the app's UI scale.

Dev-console tabs can incorporate this into their UI sizes and positions if they desire. This must be done manually however.

@dataclass
class DevConsoleTabEntry:
138@dataclass
139class DevConsoleTabEntry:
140    """Represents a distinct tab in the dev-console."""
141
142    name: str
143    factory: Callable[[], DevConsoleTab]

Represents a distinct tab in the dev-console.

DevConsoleTabEntry(name: str, factory: Callable[[], DevConsoleTab])
name: str
factory: Callable[[], DevConsoleTab]
class DevConsoleSubsystem:
146class DevConsoleSubsystem:
147    """Subsystem for wrangling the dev console.
148
149    The single instance of this class can be found at
150    babase.app.devconsole. The dev-console is a simple always-available
151    UI intended for use by developers; not end users. Traditionally it
152    is available by typing a backtick (`) key on a keyboard, but now can
153    be accessed via an on-screen button (see settings/advanced to enable
154    said button).
155    """
156
157    def __init__(self) -> None:
158        # All tabs in the dev-console. Add your own stuff here via
159        # plugins or whatnot.
160        self.tabs: list[DevConsoleTabEntry] = [
161            DevConsoleTabEntry('Python', DevConsoleTabPython)
162        ]
163        if os.environ.get('BA_DEV_CONSOLE_TEST_TAB', '0') == '1':
164            self.tabs.append(DevConsoleTabEntry('Test', DevConsoleTabTest))
165        self.is_refreshing = False
166
167    def do_refresh_tab(self, tabname: str) -> None:
168        """Called by the C++ layer when a tab should be filled out."""
169        assert _babase.in_logic_thread()
170
171        # FIXME: We currently won't handle multiple tabs with the same
172        # name. We should give a clean error or something in that case.
173        tab: DevConsoleTab | None = None
174        for tabentry in self.tabs:
175            if tabentry.name == tabname:
176                tab = tabentry.factory()
177                break
178
179        if tab is None:
180            logging.error(
181                'DevConsole got refresh request for tab'
182                " '%s' which does not exist.",
183                tabname,
184            )
185            return
186
187        self.is_refreshing = True
188        try:
189            tab.refresh()
190        finally:
191            self.is_refreshing = False

Subsystem for wrangling the dev console.

The single instance of this class can be found at babase.app.devconsole. The dev-console is a simple always-available UI intended for use by developers; not end users. Traditionally it is available by typing a backtick (`) key on a keyboard, but now can be accessed via an on-screen button (see settings/advanced to enable said button).

tabs: list[DevConsoleTabEntry]
is_refreshing
def do_refresh_tab(self, tabname: str) -> None:
167    def do_refresh_tab(self, tabname: str) -> None:
168        """Called by the C++ layer when a tab should be filled out."""
169        assert _babase.in_logic_thread()
170
171        # FIXME: We currently won't handle multiple tabs with the same
172        # name. We should give a clean error or something in that case.
173        tab: DevConsoleTab | None = None
174        for tabentry in self.tabs:
175            if tabentry.name == tabname:
176                tab = tabentry.factory()
177                break
178
179        if tab is None:
180            logging.error(
181                'DevConsole got refresh request for tab'
182                " '%s' which does not exist.",
183                tabname,
184            )
185            return
186
187        self.is_refreshing = True
188        try:
189            tab.refresh()
190        finally:
191            self.is_refreshing = False

Called by the C++ layer when a tab should be filled out.

DisplayTime = DisplayTime
def displaytime() -> DisplayTime:
756def displaytime() -> babase.DisplayTime:
757    """Return the current display-time in seconds.
758
759    Category: **General Utility Functions**
760
761    Display-time is a time value intended to be used for animation and other
762    visual purposes. It will generally increment by a consistent amount each
763    frame. It will pass at an overall similar rate to AppTime, but trades
764    accuracy for smoothness.
765
766    Note that the value returned here is simply a float; it just has a
767    unique type in the type-checker's eyes to help prevent it from being
768    accidentally used with time functionality expecting other time types.
769    """
770    import babase  # pylint: disable=cyclic-import
771
772    return babase.DisplayTime(0.0)

Return the current display-time in seconds.

Category: General Utility Functions

Display-time is a time value intended to be used for animation and other visual purposes. It will generally increment by a consistent amount each frame. It will pass at an overall similar rate to AppTime, but trades accuracy for smoothness.

Note that the value returned here is simply a float; it just has a unique type in the type-checker's eyes to help prevent it from being accidentally used with time functionality expecting other time types.

def displaytimer(time: float, call: Callable[[], Any]) -> None:
775def displaytimer(time: float, call: Callable[[], Any]) -> None:
776    """Schedule a callable object to run based on display-time.
777
778    Category: **General Utility Functions**
779
780    This function creates a one-off timer which cannot be canceled or
781    modified once created. If you require the ability to do so, or need
782    a repeating timer, use the babase.DisplayTimer class instead.
783
784    Display-time is a time value intended to be used for animation and other
785    visual purposes. It will generally increment by a consistent amount each
786    frame. It will pass at an overall similar rate to AppTime, but trades
787    accuracy for smoothness.
788
789    ##### Arguments
790    ###### time (float)
791    > Length of time in seconds that the timer will wait before firing.
792
793    ###### call (Callable[[], Any])
794    > A callable Python object. Note that the timer will retain a
795    strong reference to the callable for as long as the timer exists, so you
796    may want to look into concepts such as babase.WeakCall if that is not
797    desired.
798
799    ##### Examples
800    Print some stuff through time:
801    >>> babase.screenmessage('hello from now!')
802    >>> babase.displaytimer(1.0, babase.Call(babase.screenmessage,
803    ...                       'hello from the future!'))
804    >>> babase.displaytimer(2.0, babase.Call(babase.screenmessage,
805    ...                       'hello from the future 2!'))
806    """
807    return None

Schedule a callable object to run based on display-time.

Category: General Utility Functions

This function creates a one-off timer which cannot be canceled or modified once created. If you require the ability to do so, or need a repeating timer, use the babase.DisplayTimer class instead.

Display-time is a time value intended to be used for animation and other visual purposes. It will generally increment by a consistent amount each frame. It will pass at an overall similar rate to AppTime, but trades accuracy for smoothness.

Arguments
time (float)

Length of time in seconds that the timer will wait before firing.

call (Callable[[], Any])

A callable Python object. Note that the timer will retain a strong reference to the callable for as long as the timer exists, so you may want to look into concepts such as babase.WeakCall if that is not desired.

Examples

Print some stuff through time:

>>> babase.screenmessage('hello from now!')
>>> babase.displaytimer(1.0, babase.Call(babase.screenmessage,
...                       'hello from the future!'))
>>> babase.displaytimer(2.0, babase.Call(babase.screenmessage,
...                       'hello from the future 2!'))
class DisplayTimer:
220class DisplayTimer:
221    """Timers are used to run code at later points in time.
222
223    Category: **General Utility Classes**
224
225    This class encapsulates a timer based on display-time.
226    The underlying timer will be destroyed when this object is no longer
227    referenced. If you do not want to worry about keeping a reference to
228    your timer around, use the babase.displaytimer() function instead to get a
229    one-off timer.
230
231    Display-time is a time value intended to be used for animation and
232    other visual purposes. It will generally increment by a consistent
233    amount each frame. It will pass at an overall similar rate to AppTime,
234    but trades accuracy for smoothness.
235
236    ##### Arguments
237    ###### time
238    > Length of time in seconds that the timer will wait before firing.
239
240    ###### call
241    > A callable Python object. Remember that the timer will retain a
242    strong reference to the callable for as long as it exists, so you
243    may want to look into concepts such as babase.WeakCall if that is not
244    desired.
245
246    ###### repeat
247    > If True, the timer will fire repeatedly, with each successive
248    firing having the same delay as the first.
249
250    ##### Example
251
252    Use a Timer object to print repeatedly for a few seconds:
253    ... def say_it():
254    ...     babase.screenmessage('BADGER!')
255    ... def stop_saying_it():
256    ...     global g_timer
257    ...     g_timer = None
258    ...     babase.screenmessage('MUSHROOM MUSHROOM!')
259    ... # Create our timer; it will run as long as we have the self.t ref.
260    ... g_timer = babase.DisplayTimer(0.3, say_it, repeat=True)
261    ... # Now fire off a one-shot timer to kill it.
262    ... babase.displaytimer(3.89, stop_saying_it)
263    """
264
265    def __init__(
266        self, time: float, call: Callable[[], Any], repeat: bool = False
267    ) -> None:
268        pass

Timers are used to run code at later points in time.

Category: General Utility Classes

This class encapsulates a timer based on display-time. The underlying timer will be destroyed when this object is no longer referenced. If you do not want to worry about keeping a reference to your timer around, use the babase.displaytimer() function instead to get a one-off timer.

Display-time is a time value intended to be used for animation and other visual purposes. It will generally increment by a consistent amount each frame. It will pass at an overall similar rate to AppTime, but trades accuracy for smoothness.

Arguments
time

Length of time in seconds that the timer will wait before firing.

call

A callable Python object. Remember that the timer will retain a strong reference to the callable for as long as it exists, so you may want to look into concepts such as babase.WeakCall if that is not desired.

repeat

If True, the timer will fire repeatedly, with each successive firing having the same delay as the first.

Example

Use a Timer object to print repeatedly for a few seconds: ... def say_it(): ... babase.screenmessage('BADGER!') ... def stop_saying_it(): ... global g_timer ... g_timer = None ... babase.screenmessage('MUSHROOM MUSHROOM!') ... # Create our timer; it will run as long as we have the self.t ref. ... g_timer = babase.DisplayTimer(0.3, say_it, repeat=True) ... # Now fire off a one-shot timer to kill it. ... babase.displaytimer(3.89, stop_saying_it)

DisplayTimer(time: float, call: Callable[[], Any], repeat: bool = False)
265    def __init__(
266        self, time: float, call: Callable[[], Any], repeat: bool = False
267    ) -> None:
268        pass
def do_once() -> bool:
815def do_once() -> bool:
816    """Return whether this is the first time running a line of code.
817
818    Category: **General Utility Functions**
819
820    This is used by 'print_once()' type calls to keep from overflowing
821    logs. The call functions by registering the filename and line where
822    The call is made from.  Returns True if this location has not been
823    registered already, and False if it has.
824
825    ##### Example
826    This print will only fire for the first loop iteration:
827    >>> for i in range(10):
828    ... if babase.do_once():
829    ...     print('HelloWorld once from loop!')
830    """
831    return bool()

Return whether this is the first time running a line of code.

Category: General Utility Functions

This is used by 'print_once()' type calls to keep from overflowing logs. The call functions by registering the filename and line where The call is made from. Returns True if this location has not been registered already, and False if it has.

Example

This print will only fire for the first loop iteration:

>>> for i in range(10):
... if babase.do_once():
...     print('HelloWorld once from loop!')
class EmptyAppMode(babase.AppMode):
19class EmptyAppMode(AppMode):
20    """An empty app mode that can be used as a fallback/etc."""
21
22    @override
23    @classmethod
24    def get_app_experience(cls) -> AppExperience:
25        return AppExperience.EMPTY
26
27    @override
28    @classmethod
29    def _supports_intent(cls, intent: AppIntent) -> bool:
30        # We support default and exec intents currently.
31        return isinstance(intent, AppIntentExec | AppIntentDefault)
32
33    @override
34    def handle_intent(self, intent: AppIntent) -> None:
35        if isinstance(intent, AppIntentExec):
36            _babase.empty_app_mode_handle_intent_exec(intent.code)
37            return
38        assert isinstance(intent, AppIntentDefault)
39        _babase.empty_app_mode_handle_intent_default()
40
41    @override
42    def on_activate(self) -> None:
43        # Let the native layer do its thing.
44        _babase.on_empty_app_mode_activate()
45
46    @override
47    def on_deactivate(self) -> None:
48        # Let the native layer do its thing.
49        _babase.on_empty_app_mode_deactivate()

An empty app mode that can be used as a fallback/etc.

@override
@classmethod
def get_app_experience(cls) -> bacommon.app.AppExperience:
22    @override
23    @classmethod
24    def get_app_experience(cls) -> AppExperience:
25        return AppExperience.EMPTY

Return the overall experience provided by this mode.

@override
def handle_intent(self, intent: AppIntent) -> None:
33    @override
34    def handle_intent(self, intent: AppIntent) -> None:
35        if isinstance(intent, AppIntentExec):
36            _babase.empty_app_mode_handle_intent_exec(intent.code)
37            return
38        assert isinstance(intent, AppIntentDefault)
39        _babase.empty_app_mode_handle_intent_default()

Handle an intent.

@override
def on_activate(self) -> None:
41    @override
42    def on_activate(self) -> None:
43        # Let the native layer do its thing.
44        _babase.on_empty_app_mode_activate()

Called when the mode is being activated.

@override
def on_deactivate(self) -> None:
46    @override
47    def on_deactivate(self) -> None:
48        # Let the native layer do its thing.
49        _babase.on_empty_app_mode_deactivate()

Called when the mode is being deactivated.

class Env:
271class Env:
272    """Unchanging values for the current running app instance.
273    Access the single shared instance of this class at `babase.app.env`.
274    """
275
276    android: bool
277    """Is this build targeting an Android based OS?"""
278
279    api_version: int
280    """The app's api version.
281
282       Only Python modules and packages associated with the current API
283       version number will be detected by the game (see the ba_meta tag).
284       This value will change whenever substantial backward-incompatible
285       changes are introduced to Ballistica APIs. When that happens,
286       modules/packages should be updated accordingly and set to target
287       the newer API version number."""
288
289    arcade: bool
290    """Whether the app is targeting an arcade-centric experience."""
291
292    config_file_path: str
293    """Where the app's config file is stored on disk."""
294
295    data_directory: str
296    """Where bundled static app data lives."""
297
298    debug: bool
299    """Whether the app is running in debug mode.
300
301       Debug builds generally run substantially slower than non-debug
302       builds due to compiler optimizations being disabled and extra
303       checks being run."""
304
305    demo: bool
306    """Whether the app is targeting a demo experience."""
307
308    device_name: str
309    """Human readable name of the device running this app."""
310
311    engine_build_number: int
312    """Integer build number for the engine.
313
314       This value increases by at least 1 with each release of the engine.
315       It is independent of the human readable `version` string."""
316
317    engine_version: str
318    """Human-readable version string for the engine; something like '1.3.24'.
319
320       This should not be interpreted as a number; it may contain
321       string elements such as 'alpha', 'beta', 'test', etc.
322       If a numeric version is needed, use `build_number`."""
323
324    gui: bool
325    """Whether the app is running with a gui.
326
327       This is the opposite of `headless`."""
328
329    headless: bool
330    """Whether the app is running headlessly (without a gui).
331
332       This is the opposite of `gui`."""
333
334    python_directory_app: str | None
335    """Path where the app expects its bundled modules to live.
336
337       Be aware that this value may be None if Ballistica is running in
338       a non-standard environment, and that python-path modifications may
339       cause modules to be loaded from other locations."""
340
341    python_directory_app_site: str | None
342    """Path where the app expects its bundled pip modules to live.
343
344       Be aware that this value may be None if Ballistica is running in
345       a non-standard environment, and that python-path modifications may
346       cause modules to be loaded from other locations."""
347
348    python_directory_user: str | None
349    """Path where the app expects its user scripts (mods) to live.
350
351       Be aware that this value may be None if Ballistica is running in
352       a non-standard environment, and that python-path modifications may
353       cause modules to be loaded from other locations."""
354
355    supports_soft_quit: bool
356    """Whether the running app supports 'soft' quit options.
357
358       This generally applies to mobile derived OSs, where an act of
359       'quitting' may leave the app running in the background waiting
360       in case it is used again."""
361
362    test: bool
363    """Whether the app is running in test mode.
364
365       Test mode enables extra checks and features that are useful for
366       release testing but which do not slow the game down significantly."""
367
368    tv: bool
369    """Whether the app is targeting a TV-centric experience."""
370
371    vr: bool
372    """Whether the app is currently running in VR."""
373
374    pass

Unchanging values for the current running app instance. Access the single shared instance of this class at babase.app.env.

android: bool

Is this build targeting an Android based OS?

api_version: int

The app's api version.

Only Python modules and packages associated with the current API version number will be detected by the game (see the ba_meta tag). This value will change whenever substantial backward-incompatible changes are introduced to Ballistica APIs. When that happens, modules/packages should be updated accordingly and set to target the newer API version number.

arcade: bool

Whether the app is targeting an arcade-centric experience.

config_file_path: str

Where the app's config file is stored on disk.

data_directory: str

Where bundled static app data lives.

debug: bool

Whether the app is running in debug mode.

Debug builds generally run substantially slower than non-debug builds due to compiler optimizations being disabled and extra checks being run.

demo: bool

Whether the app is targeting a demo experience.

device_name: str

Human readable name of the device running this app.

engine_build_number: int

Integer build number for the engine.

This value increases by at least 1 with each release of the engine. It is independent of the human readable version string.

engine_version: str

Human-readable version string for the engine; something like '1.3.24'.

This should not be interpreted as a number; it may contain string elements such as 'alpha', 'beta', 'test', etc. If a numeric version is needed, use build_number.

gui: bool

Whether the app is running with a gui.

This is the opposite of headless.

headless: bool

Whether the app is running headlessly (without a gui).

This is the opposite of gui.

python_directory_app: str | None

Path where the app expects its bundled modules to live.

Be aware that this value may be None if Ballistica is running in a non-standard environment, and that python-path modifications may cause modules to be loaded from other locations.

python_directory_app_site: str | None

Path where the app expects its bundled pip modules to live.

Be aware that this value may be None if Ballistica is running in a non-standard environment, and that python-path modifications may cause modules to be loaded from other locations.

python_directory_user: str | None

Path where the app expects its user scripts (mods) to live.

Be aware that this value may be None if Ballistica is running in a non-standard environment, and that python-path modifications may cause modules to be loaded from other locations.

supports_soft_quit: bool

Whether the running app supports 'soft' quit options.

This generally applies to mobile derived OSs, where an act of 'quitting' may leave the app running in the background waiting in case it is used again.

test: bool

Whether the app is running in test mode.

Test mode enables extra checks and features that are useful for release testing but which do not slow the game down significantly.

tv: bool

Whether the app is targeting a TV-centric experience.

vr: bool

Whether the app is currently running in VR.

class Existable(typing.Protocol):
36class Existable(Protocol):
37    """A Protocol for objects supporting an exists() method.
38
39    Category: **Protocols**
40    """
41
42    def exists(self) -> bool:
43        """Whether this object exists."""

A Protocol for objects supporting an exists() method.

Category: Protocols

Existable(*args, **kwargs)
1758def _no_init_or_replace_init(self, *args, **kwargs):
1759    cls = type(self)
1760
1761    if cls._is_protocol:
1762        raise TypeError('Protocols cannot be instantiated')
1763
1764    # Already using a custom `__init__`. No need to calculate correct
1765    # `__init__` to call. This can lead to RecursionError. See bpo-45121.
1766    if cls.__init__ is not _no_init_or_replace_init:
1767        return
1768
1769    # Initially, `__init__` of a protocol subclass is set to `_no_init_or_replace_init`.
1770    # The first instantiation of the subclass will call `_no_init_or_replace_init` which
1771    # searches for a proper new `__init__` in the MRO. The new `__init__`
1772    # replaces the subclass' old `__init__` (ie `_no_init_or_replace_init`). Subsequent
1773    # instantiation of the protocol subclass will thus use the new
1774    # `__init__` and no longer call `_no_init_or_replace_init`.
1775    for base in cls.__mro__:
1776        init = base.__dict__.get('__init__', _no_init_or_replace_init)
1777        if init is not _no_init_or_replace_init:
1778            cls.__init__ = init
1779            break
1780    else:
1781        # should not happen
1782        cls.__init__ = object.__init__
1783
1784    cls.__init__(self, *args, **kwargs)
def exists(self) -> bool:
42    def exists(self) -> bool:
43        """Whether this object exists."""

Whether this object exists.

def existing(obj: Optional[~ExistableT]) -> Optional[~ExistableT]:
50def existing(obj: ExistableT | None) -> ExistableT | None:
51    """Convert invalid references to None for any babase.Existable object.
52
53    Category: **Gameplay Functions**
54
55    To best support type checking, it is important that invalid references
56    not be passed around and instead get converted to values of None.
57    That way the type checker can properly flag attempts to pass possibly-dead
58    objects (FooType | None) into functions expecting only live ones
59    (FooType), etc. This call can be used on any 'existable' object
60    (one with an exists() method) and will convert it to a None value
61    if it does not exist.
62
63    For more info, see notes on 'existables' here:
64    https://ballistica.net/wiki/Coding-Style-Guide
65    """
66    assert obj is None or hasattr(obj, 'exists'), f'No "exists" on {obj}'
67    return obj if obj is not None and obj.exists() else None

Convert invalid references to None for any babase.Existable object.

Category: Gameplay Functions

To best support type checking, it is important that invalid references not be passed around and instead get converted to values of None. That way the type checker can properly flag attempts to pass possibly-dead objects (FooType | None) into functions expecting only live ones (FooType), etc. This call can be used on any 'existable' object (one with an exists() method) and will convert it to a None value if it does not exist.

For more info, see notes on 'existables' here: https://ballistica.net/wiki/Coding-Style-Guide

def fatal_error(message: str) -> None:
893def fatal_error(message: str) -> None:
894    """Trigger a fatal error. Use this in situations where it is not possible
895    for the engine to continue on in a useful way. This can sometimes
896    help provide more clear information at the exact source of a problem
897    as compared to raising an Exception. In the vast majority of cases,
898    however, Exceptions should be preferred.
899    """
900    return None

Trigger a fatal error. Use this in situations where it is not possible for the engine to continue on in a useful way. This can sometimes help provide more clear information at the exact source of a problem as compared to raising an Exception. In the vast majority of cases, however, Exceptions should be preferred.

def garbage_collect() -> None:
214def garbage_collect() -> None:
215    """Run an explicit pass of garbage collection.
216
217    category: General Utility Functions
218
219    May also print warnings/etc. if collection takes too long or if
220    uncollectible objects are found (so use this instead of simply
221    gc.collect().
222    """
223    gc.collect()

Run an explicit pass of garbage collection.

category: General Utility Functions

May also print warnings/etc. if collection takes too long or if uncollectible objects are found (so use this instead of simply gc.collect().

def get_input_idle_time() -> float:
980def get_input_idle_time() -> float:
981    """Return seconds since any local input occurred (touch, keypress, etc.)."""
982    return float()

Return seconds since any local input occurred (touch, keypress, etc.).

def get_ip_address_type(addr: str) -> socket.AddressFamily:
56def get_ip_address_type(addr: str) -> socket.AddressFamily:
57    """Return socket.AF_INET6 or socket.AF_INET4 for the provided address."""
58    import socket
59
60    socket_type = None
61
62    # First try it as an ipv4 address.
63    try:
64        socket.inet_pton(socket.AF_INET, addr)
65        socket_type = socket.AF_INET
66    except OSError:
67        pass
68
69    # Hmm apparently not ipv4; try ipv6.
70    if socket_type is None:
71        try:
72            socket.inet_pton(socket.AF_INET6, addr)
73            socket_type = socket.AF_INET6
74        except OSError:
75            pass
76    if socket_type is None:
77        raise ValueError(f'addr seems to be neither v4 or v6: {addr}')
78    return socket_type

Return socket.AF_INET6 or socket.AF_INET4 for the provided address.

def get_type_name(cls: type) -> str:
<