Sand 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.sand_effect.SandEffect(buffer: Buffer, background: str, settings: SandSettings = None)

Bases: BaseEffect

Falling-sand cellular automaton.

Particles spawn randomly at the top of the screen and fall downward, cascading diagonally when blocked. Color indicates height — hotter at the top, cooler toward the bottom. Particles drain from the bottom row to keep the simulation flowing indefinitely.

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

Base class for all effects.

Parameters:

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

• background (str) – character or string to use for the background.

set_spawn_rate(rate: float)

Set the per-column probability of spawning a new particle each frame (0–1).

render_frame(frame_number: int)

To be defined by each effect.