Class SparkChit

parentOutletIndex

• get parentOutletIndex(): number | undefined

  Returns number | undefined

parentOutlet

• get parentOutlet(): string | undefined

  Returns string | undefined

parent

• get parent(): Chit | undefined

  Returns Chit | undefined

parentFallback

• get parentFallback(): Chit | undefined

  Returns Chit | undefined

• set parentFallback(newValue: Chit | undefined): void

  Parameters

  • newValue: Chit | undefined

  Returns void

panelTab

• get panelTab(): PanelTab | undefined

  Returns PanelTab | undefined

isClickable

• get isClickable(): boolean

  Returns true if the chit is currently clickable

  Returns boolean

currentTurn

• get currentTurn(): Turn<any, any, any>

  Returns Turn<any, any, any>

render

• render(spec: ChitRenderSpec): void

  Parameters

  • spec: ChitRenderSpec

  Returns void

shouldRenderChild

• shouldRenderChild(childChit: Chit): boolean

  Parameters

  • childChit: Chit

  Returns boolean

getSparks

• getSparks(context: "dropdown" | "panel" | "endgame"): SparkChit[]

  Parameters

  • context: "dropdown" | "panel" | "endgame"

  Returns SparkChit[]

add

• add<T extends Chit>(chit: T, outlet?: string): T

  Type Parameters

  • T extends Chit

  Parameters

  • chit: T
  • Optionaloutlet: string

  Returns T

remove

• remove(chit: Chit): void

  Parameters

  • chit: Chit

  Returns void

removeFromParent

• removeFromParent(): void

  Returns void

toJSON

• toJSON(): { __chit_id: string }

  Returns { __chit_id: string }

toString

• toString(): string

  Returns a string representation of an object.

  Returns string

functionallyIdentical

• functionallyIdentical(other: Chit): boolean

  Parameters

  • other: Chit

  Returns boolean

setParent

• setParent(
      newValue?: Chit,
      parentOutlet?: string,
      parentOutletIndex?: number,
  ): void

  Parameters

  • OptionalnewValue: Chit
  • OptionalparentOutlet: string
  • OptionalparentOutletIndex: number

  Returns void

hiddenPropertiesForSerialization

• hiddenPropertiesForSerialization(
      _playerIds: string[],
  ): HiddenPropertySerializationRule[] | undefined

  Let chits decide who can see what. (Allow privacy of chits)

  Parameters

  • _playerIds: string[]

  Returns HiddenPropertySerializationRule[] | undefined

Staticpick

• pick<T extends Chit>(
      chit: T | OrderedOutlet<T> | (false | T | null | undefined)[],
      cb: (chit: T) => void | Promise<void>,
  ): ChitPick<T>

  Type Parameters

  • T extends Chit

  Parameters

  • chit: T | OrderedOutlet<T> | (false | T | null | undefined)[]
  • cb: (chit: T) => void | Promise<void>

  Returns ChitPick<T>

StaticdragPick

• dragPick<T extends Chit>(
      chit: T | OrderedOutlet<T> | (false | T | null | undefined)[],
      targets: DragTarget<any, T> | DragTarget<any, T>[],
  ): DragPick<T>

  Creates a DragPick options for the chit(s). Create an array of DragTargets that these chits can be dropped on.

  Type Parameters

  • T extends Chit

  Parameters

  • chit: T | OrderedOutlet<T> | (false | T | null | undefined)[]

    A single chit, an array of chits (that can be empty-ish or nullish and ignored), or an OrderedOutlet of chits

  • targets: DragTarget<any, T> | DragTarget<any, T>[]

    An array of DragTargets that the chits can be dropped on

  Returns DragPick<T>

  A DragPick instance configured with the specified chits and targets

set

• set(cb: (chit: this) => void): this

  Parameters

  • cb: (chit: this) => void

  Returns this

Optionalid

orderedChildren

isDropTarget