Interface Chip

In Booyah, the game is structured as a tree of chips. This is the interface for all chips. When creating a new chip, you most likely want to extend ChipBase or Composite, which implement this interface and do the busywork for you.

Events:

  • activated()
  • terminated()

Hierarchy

Implemented by

Properties

children outputSignal? state

Methods

activate emit makeReloadMemento off on once pause resume terminate tick

Properties

Readonly children

children: Record<string, Chip>

Children of this chip, if any

Optional Readonly outputSignal

outputSignal?: Signal<string>

Once the chip is terminated, contains the signal

Readonly state

state: ChipState

Current state of the chip

Methods

activate

  • Activate the chip, with a provided context and input signal. Should only be called from an inactive state

    Parameters

    Returns void

emit

makeReloadMemento

off

  • Parameters

    • type: string
    • listener: (() => void)
        • (): void

        • Returns void

    Returns void

on

  • Parameters

    • type: string
    • listener: (() => void)
        • (): void

        • Returns void

    Returns void

once

  • Parameters

    • type: string
    • listener: (() => void)
        • (): void

        • Returns void

    Returns void

pause

  • Pause the chip, informing it that it won't receive ticks for a while

    Returns void

resume

  • Resumes the chip after it was paused

    Returns void

terminate

  • Terminate the chip. Should only be called from an active or paused state

    Parameters

    • Optional outputSignal: Signal<string>

    Returns void

tick

  • Update the chip, provided a new time

    Parameters

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc