mini_arcade_core.engine.gameplay_settings

Gameplay settings that can be modified during gameplay.

Attributes

DifficultyType

Classes

DifficultySettings	Settings related to game difficulty that can be modified during gameplay.
DebugOverlayStyleSettings	Visual configuration for the built-in debug overlay.
DebugOverlaySettings	Gameplay-configurable debug overlay settings.
SceneActionSettings	Declarative command configuration for scene-level actions.
SceneRuntimeSettings	Per-scene gameplay behavior configuration.
GamePlaySettings	Game settings that can be modified during gameplay.

Module Contents

mini_arcade_core.engine.gameplay_settings.DifficultyType

class mini_arcade_core.engine.gameplay_settings.DifficultySettings

Settings related to game difficulty that can be modified during gameplay.

Variables:

(DifficultyType) (level) – Current difficulty level.

level: DifficultyType = 'normal'

classmethod from_dict(data: dict[str, Any] | None) → DifficultySettings

Construct difficulty settings from a dict, typically parsed from a game config file.

Parameters:

data (dict or None) – The input data to parse.

Returns:

A DifficultySettings instance populated with the parsed data.

Return type:

DifficultySettings

class mini_arcade_core.engine.gameplay_settings.DebugOverlayStyleSettings

Visual configuration for the built-in debug overlay.

x: int = 8

y: int = 8

width: int = 360

padding: int = 8

line_height: int = 18

font_size: int = 14

panel_color: tuple[int, Ellipsis] = (0, 0, 0, 166)

text_color: tuple[int, Ellipsis] = (255, 255, 255, 255)

classmethod from_dict(data: dict[str, Any] | None) → DebugOverlayStyleSettings

Construct debug overlay style settings from a dict, typically parsed from a game config file.

Parameters:

data (dict or None) – The input data to parse.

Returns:

A DebugOverlayStyleSettings instance populated with the parsed data.

Return type:

DebugOverlayStyleSettings

class mini_arcade_core.engine.gameplay_settings.DebugOverlaySettings

Gameplay-configurable debug overlay settings.

enabled: bool = False

start_visible: bool = False

scene_id: str = 'debug_overlay'

toggle_key: mini_arcade_core.backend.keys.Key | None

title: str = 'Debug Overlay'

sections: tuple[str, Ellipsis] = ('timing', 'render', 'viewport', 'effects', 'stack', 'scene')

static_lines: list[str] = []

style: DebugOverlayStyleSettings

classmethod from_dict(data: Any) → DebugOverlaySettings

Construct debug overlay settings from a dict, typically parsed from a game config file.

Parameters:

data (dict or any) – The input data to parse.

Returns:

A DebugOverlaySettings instance populated with the parsed data.

Return type:

DebugOverlaySettings

class mini_arcade_core.engine.gameplay_settings.SceneActionSettings

Declarative command configuration for scene-level actions.

command: str

scene_id: str | None = None

as_overlay: bool = False

classmethod from_dict(data: Any) → SceneActionSettings | None

Construct scene action settings from a dict, typically parsed from a game config file.

Parameters:

data (dict or any) – The input data to parse.

Returns:

A SceneActionSettings instance populated with the parsed data, or None if the input data is invalid or does not specify a command.

Return type:

SceneActionSettings or None

class mini_arcade_core.engine.gameplay_settings.SceneRuntimeSettings

Per-scene gameplay behavior configuration.

escape: SceneActionSettings | None = None

data: dict[str, Any]

classmethod from_dict(data: Any) → SceneRuntimeSettings

Construct scene runtime settings from a dict, typically parsed from a game config file.

Parameters:

data (dict or any) – The input data to parse.

Returns:

A SceneRuntimeSettings instance populated with the parsed data.

Return type:

SceneRuntimeSettings

get(key: str, default: Any = None) → Any

Get arbitrary data from the scene settings, for use by game code.

Parameters:

• key (str) – The key to look up in the scene settings data.

• default (Any) – The default value to return if the key is not found.

Returns:

The value associated with the key in the scene settings data, or the default if not found.

Return type:

Any

class mini_arcade_core.engine.gameplay_settings.GamePlaySettings

Game settings that can be modified during gameplay.

Variables:

(DifficultySettings) (difficulty) – Current game difficulty settings.

difficulty: DifficultySettings

controls: dict[str, Any]

effects_stack: mini_arcade_core.engine.render.effects.base.EffectStack | None = None

debug_overlay: DebugOverlaySettings

scenes: dict[str, SceneRuntimeSettings]

classmethod from_dict(data: dict[str, Any] | None) → GamePlaySettings

Construct gameplay settings from a dict, typically parsed from a game config file.

Parameters:

data (dict or None) – The input data to parse.

Returns:

A GamePlaySettings instance populated with the parsed data.

Return type:

GamePlaySettings

scene_settings(scene_id: str) → SceneRuntimeSettings | None

Resolve runtime scene settings by registered scene id.