Module: Lich::Common

Defined in:
documented/games.rb,
documented/vars.rb,
documented/common/gtk.rb,
documented/common/hmr.rb,
documented/common/log.rb,
documented/common/vars.rb,
documented/global_defs.rb,
documented/common/spell.rb,
documented/common/buffer.rb,
documented/common/script.rb,
documented/common/account.rb,
documented/common/eaccess.rb,
documented/common/gameobj.rb,
documented/attributes/char.rb,
documented/common/db_store.rb,
documented/common/postload.rb,
documented/common/settings.rb,
documented/common/uservars.rb,
documented/common/watchfor.rb,
documented/common/front-end.rb,
documented/common/gui-login.rb,
documented/common/gui/state.rb,
documented/common/gui_login.rb,
documented/common/watchable.rb,
documented/common/xmlparser.rb,
documented/common/arg_parser.rb,
documented/common/gameloader.rb,
documented/common/map/map_dr.rb,
documented/common/map/map_gs.rb,
documented/common/game-loader.rb,
documented/common/setup_files.rb,
documented/common/limitedarray.rb,
documented/common/map/map_base.rb,
documented/common/sharedbuffer.rb,
documented/common/upstreamhook.rb,
documented/common/cli/cli_login.rb,
documented/common/feature_flags.rb,
documented/common/gui/utilities.rb,
documented/common/downstreamhook.rb,
documented/common/gui/components.rb,
documented/common/gui/yaml_state.rb,
documented/common/gui/theme_utils.rb,
documented/common/session_launcher.rb,
documented/common/gui/accessibility.rb,
documented/common/gui/conversion_ui.rb,
documented/common/session_lifecycle.rb,
documented/common/authentication/cli.rb,
documented/common/authentication/gui.rb,
documented/common/cli/cli_conversion.rb,
documented/common/gui/authentication.rb,
documented/common/gui/game_selection.rb,
documented/common/socketconfigurator.rb,
documented/common/gui/account_manager.rb,
documented/common/gui/login_tab_utils.rb,
documented/common/gui/password_change.rb,
documented/common/gui/password_cipher.rb,
documented/common/gui/saved_login_tab.rb,
documented/common/gui/window_settings.rb,
documented/common/reusable_tcp_server.rb,
documented/common/gui/manual_login_tab.rb,
documented/common/gui/password_manager.rb,
documented/common/gui/tab_communicator.rb,
documented/common/settings_transformer.rb,
documented/common/class_exts/stringproc.rb,
documented/common/cli/cli_orchestration.rb,
documented/common/gui/favorites_manager.rb,
documented/common/gui/parameter_objects.rb,
documented/common/settings/charsettings.rb,
documented/common/settings/gamesettings.rb,
documented/common/authentication/eaccess.rb,
documented/common/gui/account_manager_ui.rb,
documented/common/settings/path_navigator.rb,
documented/common/settings/settings_proxy.rb,
documented/dragonrealms/drinfomon/startup.rb,
documented/common/cli/cli_options_registry.rb,
documented/common/cli/cli_password_manager.rb,
documented/common/cli/active_sessions_query.rb,
documented/common/settings/database_adapter.rb,
documented/common/authentication/entry_store.rb,
documented/common/authentication/launch_data.rb,
documented/common/gui/encryption_mode_change.rb,
documented/common/gui/master_password_change.rb,
documented/common/gui/master_password_prompt.rb,
documented/common/settings/instance_settings.rb,
documented/common/settings/sessions_settings.rb,
documented/common/authentication/cli_password.rb,
documented/common/gui/master_password_manager.rb,
documented/common/authentication/authenticator.rb,
documented/common/authentication/login_helpers.rb,
documented/common/class_exts/synchronizedsocket.rb,
documented/common/gui/master_password_prompt_ui.rb,
documented/common/cli/cli_encryption_mode_change.rb,
documented/common/gui/windows_credential_manager.rb,
documented/common/settings/session_database_adapter.rb

Overview

Provides common utilities for the Lich framework.

See Also:

Defined Under Namespace

Modules: Account, Authentication, Buffer, CLI, CharSettings, DB_Store, EAccess, FeatureFlags, Frontend, GUI, GameLoader, GameSettings, HMR, InstanceSettings, Log, MapBase, PostLoad, ReusableTCPServer, SessionLauncher, SessionLifecycle, SessionsSettings, Settings, SettingsTransformer, SocketConfigurator, UserVars, Vars, Watchable Classes: ArgParser, Char, DatabaseAdapter, DownstreamHook, ExecScript, GameObj, LimitedArray, LruIndex, Map, MinHeap, PathNavigator, Room, RoomObj, Script, Scripting, SessionDatabaseAdapter, SettingsProxy, SetupFiles, SharedBuffer, Spell, StringProc, SynchronizedSocket, UpstreamHook, Watchfor, WizardScript, XMLParser

Constant Summary collapse

CORE_GET_SETTINGS = 
true
CORE_SCRIPT_LOADER = 
true
CORE_PARSE_ARGS = 
true
CORE_AUTOSTART = 
true
TRUSTED_SCRIPT_BINDING =

A proc that returns a trusted script binding context.

See Also:

proc { _script }
CORE_ARGPARSER = 
true
CORE_SETUPFILES = 
true
CORE_MAP_OVERRIDES = 
true
CORE_DR_STARTUP = 
true

Instance Method Summary collapse

Instance Method Details

#_script ⇒ Binding

Creates a new script binding context.

Returns:

  • (Binding) —

    the binding context for the script.



18
19
20
 
# File 'documented/common/script.rb', line 18

def _script
  Proc.new {}.binding
end

#gui_login ⇒ Hash?

Initializes the GUI login process.

Examples:

Start the GUI login process

Lich::Common.

Returns:

  • (Hash, nil) —

    launch data if successful, otherwise nil



31
32
33
34
35
36
37
38
39
40
 
# File 'documented/common/gui-login.rb', line 31

def 
  
  setup_gui_window

  wait_until { @done }

  save_entry_data_if_needed

  return_launch_data_or_exit
end