World > Hintergrund#

Ein Background ist eine Unterklasse von Appearance. Die meisten Methoden und Attribute werden von der Basisklasse Appearance geerbt.

API-Referenz#

class miniworlds.appearances.background.Background(*args, **kwargs)[Quellcode]#

Background appearance of a world.

A background can be color-based or image-based, and each world can hold multiple background appearances that can be switched at runtime.

Beispiele

Add an image background:

world = World() world.add_background(„images/my_image.png“)

Add a color background:

world = World() world.add_background((255, 0, 0, 255))

Öffentliche Datenattribute:

world

Owning world of this background.

grid

Ob eine Rasterüberlagerung angezeigt wird.

parent

Background.parent Die Welt, zu der der Hintergrund gehört

image_manager

Inherited from Appearance

counter

RELOAD_ACTUAL_IMAGE

LOAD_NEW_IMAGE

font_size

Current font size used for text rendering.

texture_size

Texture tile size used when is_textured is enabled.

animation_speed

Frames between animation steps.

is_textured

If True, the image is tiled over the background.

is_rotatable

If True, costume will be rotated with token direction

is_centered

Whether drawing operations are centered on the parent position.

is_filled

Whether shapes are rendered filled instead of outlined.

is_flipped

Flips the costume or background.

is_upscaled

Wenn True, wird das Bild unter Beibehaltung des Seitenverhältnisses hochskaliert.

is_scaled_to_width

Whether the image is scaled to parent width and keeps aspect ratio.

is_scaled_to_height

Whether the image is scaled to parent height and keeps aspect ratio.

fill_color

Primary fill color for shape-based rendering.

is_scaled

Skaliert das Token auf die Größe des übergeordneten Elements ohne Beibehaltung des Seitenverhältnisses.

orientation

Wenn True, wird das Bild vor der Drehung entsprechend der Ausrichtung des übergeordneten Elements gedreht.

coloring

Defines a colored layer.

transparency

Defines a transparency.

alpha

Transparency value of the appearance.

is_animated

If True, the costume will be animated.

color

->Füllfarbe anzeigen

stroke_color

see border color

border_color

border color of actor

border

Die Randgröße des Actors.

images

List of image surfaces managed by this appearance.

image

Führt alle Aktionen in der Bildpipeline aus

dirty

Dirty flag for the current rendering pipeline state.

world

In Unterklassen Kostüm und Hintergrund implementiert

image_manager

Public Methods:

__init__([world])

set_dirty([value, status])

Markiert den Hintergrund als dirty und aktualisiert abhängige Actor-Darstellungen.

get_manager()

Gibt den zugehörigen BackgroundsManager zurück.

show_grid()

Aktiviert das Raster-Rendering für diesen Hintergrund.

repaint()

Called 1/frame from world

add_image(source)

Fügt eine Bildquelle hinzu und aktualisiert sofort die Fensteroberfläche.

get_rect()

Gibt das gecachte Rechteck des gerenderten Hintergrundbildes zurück.

Inherited from Appearance

__init__()

set_image(source)

Setzt das angezeigte Bild des Kostüms/Hintergrunds auf den ausgewählten Index

after_init()

Finalize initialization after the metaclass constructor hook.

set_mode(**kwargs)

Set multiple appearance mode flags at once.

get_modes()

Return all mode flags as a dictionary.

set_animated(value)

Enable or disable frame-based animation.

flip(value)

Convenience wrapper to set is_flipped.

remove_last_image()

Remove the most recently added image.

add_image(source)

Add an image source and return its index.

add_images(sources)

Adds multiple images to background/costume.

animate([loop])

Animates the costume

after_animation()

the method is overwritten in subclasses costume and appearance

to_colors_array()

Create an array from costume or background.

from_array(arr)

Create a background or costume from array.

fill(value)

Set default fill color for borders and lines

set_filled(value)

Set whether shapes are rendered filled.

get_color(position)

Return the color at a local pixel position.

get_rect()

Return the local rectangle of the rendered image.

draw(source, position, width, height)

Draw an image source at a local position.

draw_on_image(path, position, width, height)

Queue drawing an image file onto the appearance image.

draw_color_on_image(color, position, width, ...)

Queue drawing a colored rectangle onto the appearance image.

__str__()

Return str(self).

get_image()

If dirty, the image will be reloaded.

update()

Loads the next image, called 1/frame

register(method)

Register method for decorator.

draw_shape_append(shape, arguments)

Append a shape draw command to the render queue.

draw_shape_set(shape, arguments)

Replace shape draw commands with a single command.

draw_image_append(surface, rect)

Append a pre-rendered surface draw command.

draw_image_set(surface, rect)

Replace image draw commands with one surface draw command.

set_dirty([value, status])

Mark pipeline stages as dirty so the image is re-rendered.

get_manager()

In Unterklassen Kostüm und Hintergrund implementiert

Private Data Attributes:

_abc_impl

Inherited from Appearance

_abc_impl

Private Methods:

_after_transformation_pipeline()

Called in get_image after the image transformation pipeline is processed (e.g. when size, rotation, or other display properties have changed).

_blit_to_window_surface()

Blits background to window surface

_inner_shape()

Gibt die innere Rechteckform des Hintergrunds zurück.

_outer_shape()

Gibt die äußere Rechteckform des Hintergrunds zurück.

Inherited from Appearance

_get_rendering_facade()

_set_defaults(**kwargs)

_set_font(font, font_size)

_set_animation_speed(value)

_set_textured(value)

bool: If True, the image is tiled over the background.

_set_rotatable(value)

If set to True, costume will be rotated with actor direction

_set_centered(value)

_set_flipped(value)

Flips the costume or background.

_set_filled(value)

Sets whether the costume or background should be filled with a color.

_set_scaled(value)

Setzt den Actor auf die Eltern-Größe ohne das Seitenverhältnis beizubehalten.

_set_upscaled(value)

Wenn auf True gesetzt, wird das Bild unter Beibehaltung des Seitenverhältnisses hochskaliert.

_set_scaled_to_width(value)

_set_scaled_to_height(value)

_set_image(source)

Setzt das angezeigte Bild des Kostüms/Hintergrunds auf den ausgewählten Index

_before_transformation_pipeline()

Called in get_image before the image transformation pipeline is processed (e.g. when size, rotation, or other display properties have changed).

_after_transformation_pipeline()

Called in get_image after the image transformation pipeline is processed (e.g. when size, rotation, or other display properties have changed).

_load_image()

Loads the image,

_update_draw_shape()

_inner_shape()

Returns inner shape of costume

_outer_shape()

Returns outer shape of costume

_inner_shape_arguments()

Gets arguments for inner shape.

_outer_shape_arguments()

Gets arguments for outer shape


add_image(source)[Quellcode]#

Fügt eine Bildquelle hinzu und aktualisiert sofort die Fensteroberfläche.

Rückgabetyp:

int

get_manager()[Quellcode]#

Gibt den zugehörigen BackgroundsManager zurück.

get_rect()[Quellcode]#

Gibt das gecachte Rechteck des gerenderten Hintergrundbildes zurück.

property grid: bool | tuple#

Ob eine Rasterüberlagerung angezeigt wird.

Accepts True, False, or a color tuple to set the grid color.

parent: world_mod.World#

Background.parent Die Welt, zu der der Hintergrund gehört

repaint()[Quellcode]#

Called 1/frame from world

set_dirty(value='all', status=1)[Quellcode]#

Markiert den Hintergrund als dirty und aktualisiert abhängige Actor-Darstellungen.

show_grid()[Quellcode]#

Aktiviert das Raster-Rendering für diesen Hintergrund.

property world: World#

Owning world of this background.