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

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, color_type: str = 'GREYSCALE')[source]

Bases: NoiseEffect

Class for rendering out a blinking star effect. This is just a Noise effect with a predefined intensity. Ideally the background would be ‘ ‘ for the best effect, but the choice is yours.

__init__(buffer: Buffer, background: str, color_type: str = 'GREYSCALE')[source]

Initializes the Star Effect.

Parameters:

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

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

  • color_type (str, optional) – What color type should be used. Defaults to “GREYSCALE”.

update_color_type(color_type: str)[source]

Function to update the color type.

Parameters:

color_type (str) – The color type to use for this effect.

update_background(background: str)[source]

Function to update the background character or string.

Parameters:

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

render_frame(frame_number: int)[source]

Function to render the next frame of the Stars effect.

Parameters:

frame_number (int) – The current frame number to render.