Star Effect

Copyright 2023 Ethan Christensen

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

class bruhanimate.bruheffect.star_effect.StarEffect(buffer: Buffer, background: str, settings: StarSettings = None)

Bases: NoiseEffect

A blinking star effect — a NoiseEffect with a predefined intensity and star characters.

__init__(buffer: Buffer, background: str, settings: StarSettings = None)

Initializes the StarEffect.

Parameters:

• buffer (Buffer) – Effect buffer to push updates to.

• background (str) – Character or string for the background.

• settings (StarSettings, optional) – Configuration for the star effect. Defaults to None.

set_color_type(color_type: str)

Updates the color type used for star rendering.

Parameters:

color_type (str) – The color palette key to use.

set_background(background: str)

Updates the background character and rebuilds the star character set.

Parameters:

background (str) – The new background character or string.

render_frame(frame_number: int)

Renders a frame of the star effect.

Parameters:

frame_number (int) – The current frame number.