Offset 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.offset_effect.OffsetEffect(buffer: Buffer, background: str, direction: str = 'right')

Bases: BaseEffect

Class for generating an offset-static backgorund. :new-param direction: which way the offset should go.

__init__(buffer: Buffer, background: str, direction: str = 'right')

Initializes the offset effect.

Parameters:

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

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

• direction (str) – Direction for the effect, defaults to right.

update_direction(direction: str)

Function to update the direction of the offset.

Parameters:

direction (str) – Direction the background text should go.

render_frame(frame_number: int)

Function to render the frame based on the current direction and frame number.

Parameters:

frame_number (int) – Current frame number of the animation. Not used by the effect, but required for backwards compatibility.