@kayelaa/canvas API - v0.3.2
    Preparing search index...

    Class UseEffect

    Hierarchy (View Summary)

    • LeaHooks<
          {
              onEffect(): void | (() => void);
              cleanup?(): void;
              deps: any[] | null;
          },
      >
      • UseEffect
    Index

    Constructors

    constructor

    Properties

    slots keyedSlots cursor entity classUsed

    Methods

    reset nextNumberSlot getKeyedSlot isNotNull isNull atSlot atCursor setSlot slotSize onBeginTick? onEndTick? onCallNonKeyed onCallKeyed

    Constructors

    Properties

    slots: { onEffect(): void | (() => void); cleanup?(): void; deps: any[] }[] = []
    keyedSlots: Map<
        string,
        { onEffect(): void | (() => void); cleanup?(): void; deps: any[] },
    > = null
    cursor: number = 0
    entity: LeaEntityII
    classUsed: ValidHookClass

    Methods

    • Parameters

      • Optionalvalue: { onEffect(): void | (() => void); cleanup?(): void; deps: any[] }

      Returns number

    • Parameters

      • key: string
      • OptionalinitVal: { onEffect(): void | (() => void); cleanup?(): void; deps: any[] }

      Returns { onEffect(): void | (() => void); cleanup?(): void; deps: any[] }

    • Parameters

      • slot: string | number

      Returns { onEffect(): void | (() => void); cleanup?(): void; deps: any[] }

    • Returns { onEffect(): void | (() => void); cleanup?(): void; deps: any[] }

    • Parameters

      • slot: string | number
      • value: { onEffect(): void | (() => void); cleanup?(): void; deps: any[] }

      Returns void

    • Parameters

      • onEffect: () => void | (() => void)
      • deps: any[] = null

      Returns void

    • Parameters

      • key: string
      • onEffect: () => void | (() => void)
      • deps: any[] = null

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods