ASCIIGround (Development)
    Preparing search index...

    Class DummyPattern

    Dummy pattern that does not generate any characters. This is useful for initializing the renderer to a well-defined state without a specific pattern, and in order to avoid doing missing pattern checks.

    Hierarchy (View Summary)

    Index
    • Update pattern options without recreating the pattern instance. Override this method if your pattern has expensive initialization that should be preserved.

      Parameters

      • newOptions: Partial<TOptions>

        partial options to update

      Returns void

    • Called when the pattern is initialized or resized. Use this to set up any internal state or precompute values.

      Parameters

      • _region: RenderRegion

        the rendering region including visible area and padding.

      Returns void

    • Called when the pattern is destroyed. Use this to clean up resources, cancel timers, etc.

      Returns void

    • Handle mouse interactions with the pattern. Override to implement custom mouse effects.

      Parameters

      • _x: number

        mouse X position relative to canvas.

      • _y: number

        mouse Y position relative to canvas.

      • _clicked: boolean

        Whether mouse was clicked this frame.

      Returns void

    ID: "dummy" = 'dummy'

    Unique identifier for the pattern, that should be overridden in subclasses.

    _options: PatternOptions

    Options for the pattern, initialized with default values.

    _isDirty: boolean = false

    Flag indicating if the pattern needs to be re-rendered. This is set to true when pattern options change in a way that required re-render (e.g. color change).