Twinkle 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.twinkle_effect.TWINKLE_SPEC(char: chr, value: int)

Bases: object

A class to represent a single twinkle character with its color value.

__init__(char: chr, value: int)

Initializes the twinkle character with its color value.

Parameters:

• char (chr) – Character to display.

• value (int) – Value assoicated with the color.

next()

Updates the twinkle character’s color value and returns it as a string.

copy()

Returns a copy of the current twinkle character with its color value.

Returns:

Copy of the current twinkle spec.

Return type:

TWINKLE_SPEC

class bruhanimate.bruheffect.twinkle_effect.TwinkleEffect(buffer: Buffer, background: str, twinkle_chars: list[str] = ['.'])

Bases: BaseEffect

Class for the twinkle effect.

__init__(buffer: Buffer, background: str, twinkle_chars: list[str] = ['.'])

Initializes the twinkle effect class.

Parameters:

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

• background (str) – Character or string to use as the background.

set_density(density: float)

Sets the density of the twinkle effect, which determines how many characters will be affected by the effect.

Parameters:

density (float) – Density value between 0 and 1, where 0 means no characters are affected and 1 means all characters are affected.

set_twinkle_chars(twinkle_chars: list[str])

Sets the characters to be used in the twinkle effect.

Parameters:

twinkle_chars (list[str]) – List of characters to use for the twinkle effect.

_set_specs()

Sets the specs for the twinkle effect. This method is called to initialize the specs for the twinkle effect.

render_frame(frame_number: int)

Renders the next frame of the twinkle effect to the buffer.

Parameters:

frame_number (int) – The current frame of the animation.