World > Konsole

API Reference

class miniworlds.worlds.gui.console.Console(*args, **kwargs)

A scrolling text console that can be docked to a world.

Use console.newline(text) to append lines of text. The console is a special Toolbar that is typically docked below or beside the main world using world.camera.add_bottom(console) or world.camera.add_right(console).

Examples

from miniworlds import *
world = World(200, 200)
console = Console()
world.camera.add_bottom(console)

@world.register
def act(self):
    console.newline("Frame: " + str(world.frame))

world.run()

Öffentliche Datenattribute:

Inherited from Toolbar

background_color	Background color as Tuple, e.g. (255,255,255) for white.
padding_left	Defines left margin
padding_right	Defines right margin
padding_top	Defines top margin
padding_bottom	Defines bottom margin

Inherited from World

layout	Backward-compatible docking API for older example code.
tick_rate	How often world logic runs relative to the frame loop.
fps	Frames per second of the render loop.
world_size_x	Gets the horizontal size of the world in pixels.
world_size_y	Gets the vertical size of the world in pixels.
columns	Gets the number of horizontal pixels (columns) visible in the world.
rows	Gets the number of vertical pixels (rows) visible in the world.
size	Gets the world size as a tuple (width, height), in pixels.
background	Returns the currently active background.
has_background	Returns True if the world has at least one background appearance.
is_running
event_manager

Inherited from WorldBase

window
size
topleft
width
height
class_name
registered_events	Returns the set of all event names that are currently registered.
is_running
event_manager

Öffentliche Methoden:

__init__()	Creates a console toolbar with compact text rows.
newline(text)	Appends a new line of text to the console.

Inherited from Toolbar

__init__()	Base class for toolbars.
on_change()	Reflows all widgets after the toolbar size or layout has changed.
remove(item)	Removes a widget from the toolbar.
has_widget(key)	Checks whether the toolbar contains a widget under key.
get_widget(key)	Gets widget by key
remove_all_widgets()	Removes all widgets from the toolbar at once.
reorder()	Recomputes the positions of all toolbar widgets.
update_width_and_height()	Updates cached toolbar dimensions after a layout change.
send_message(text)	Sends a broadcast message to the world and all actors.
scroll_up(value)	Scrolls the toolbar view upward by value pixels.
scroll_down(value)	Scrolls the toolbar view downward by value pixels.
can_scroll_down(value)	Returns True if the toolbar can scroll downward by value pixels.
can_scroll_up(value)	Returns True if the toolbar can scroll upward by value pixels.
on_new_actor(actor)	Handles actors that are added to this toolbar world.
on_remove_actor(actor)	Handles actors that are removed from this toolbar world.

Inherited from GUI

add(actor)

Inherited from World

__init__([x, y])	Initializes the world and all internal managers needed for runtime operation.
contains_position(pos)	Checks if position is in the world.
contains_rect(rect)	Returns True if the entire rectangle is fully inside the world.
contains_rect_any(rect)	Returns True if any part of the rectangle is inside the world.
set_columns(value)	Internal method to set columns and sync world width.
set_rows(value)	Internal method to set rows and sync world height.
get_background()	Returns the current active background from the backgrounds manager.
switch_background(background)	Switches the current background to a specified one.
remove_background([background])	Removes a background from the world.
set_background(source)	Sets a new background and replaces the current active background.
add_background(source)	Adds a new background to the world and sets it as the active one.
start()	Starts or resumes the world.
stop([frames])	Stops the world immediately or after a delay in frames.
run([fullscreen, fit_desktop, replit, ...])	Starts the main application loop of the Miniworlds engine.
is_in_world(position)	Checks whether a given world position lies within the world's boundaries.
send_message(message[, data])	Sends a broadcast message to the world and all actors.
switch_world(new_world[, reset])	Switch the active scene to another world.
load_world_from_db(file)	Load a saved world from a sqlite database file and activate it.
load_actors_from_db(file, actor_classes)	Load actors from a sqlite database file into the current world.
save_to_db(file)	Save the current world and its actors to a sqlite database file.
quit([exit_code])	Immediately quits the application and closes the game window.
reset()	Resets the world Creates a new world with init-function - recreates all actors and actors on the world.
get_from_pixel(position)	Converts a screen pixel position into a valid world position if inside bounds.
to_pixel(position)	Converts a world position to a screen pixel position.
on_setup()	Hook method to define initial setup logic when the world is created.
detect_actors(position)	Gets all actors which are found at a specific position (in global world coordinates)
get_actors_from_pixel(pixel)	Returns a list of all actors located at the given screen pixel position.
distance_to(pos1, pos2)	Calculates the Euclidean distance between two positions.
direction_to(pos1, pos2)	Calculates the angle from pos1 to pos2 in degrees.

Inherited from WorldBase

__init__()
remove(actor)	Implemented in subclasses
on_change()	implemented in subclasses
on_new_actor(actor)
on_remove_actor(actor)
get_world_connector(actor)
screenshot([filename])	Saves a screenshot of the current window surface to a file.
get_events()	Prints a list of all events that can be registered in this world.
register(method)	Registers a method as a world event handler.

Private Data Attributes:

_abc_impl

Inherited from Toolbar

_abc_impl

Inherited from GUI

_abc_impl

Inherited from World

_abc_impl
_default_start_running

Inherited from WorldBase

_abc_impl
_default_start_running

Private Methoden:

_add_widget(widget[, key])

Inherited from Toolbar

_get_mainloopmanager_class()
_add_widget(widget[, key])
_widgets_total_height()
_set_widget_width(widget)

Inherited from GUI

_get_world_connector_class()

needed by get_world_connector in parent class

Inherited from World

_validate_parameters(x, y)
_get_initialization_facade()
_get_background_facade()
_get_runtime_facade()
_clear()	Clears the world's state: event queue, all backgrounds, and all actors.

Inherited from WorldBase

_after_init_setup()
_get_mainloopmanager_class()
_get_camera_manager_class()
_get_world_connector_class()	needed by get_world_connector in parent class
_create_event_manager()
_unregister(method)	Unregisters a previously registered world method.
_start_listening()	Enables input listening for the world.
_stop_listening()	Disables input listening for the world.

---

__init__()

Creates a console toolbar with compact text rows.

The console starts with a small default height and is intended for short log messages such as score changes, instructions, or debug output.

newline(text)

Appends a new line of text to the console.

Each call adds one label row. Older lines scroll up when the console is full.

Rückgabetyp:

Label

Parameter:

text – The text string to display on the new line.

Rückgabe:

The Label actor that was created for this line.

Examples

console.newline("Player position: " + str(player.position))